Redis Hash

NAME	RUNTIME	TYPE	VERSION
redis_hash	wombat	sink	latest

Sets Redis hash objects using the HMSET command.

The field fields allows you to specify an explicit map of field names to interpolated values, also evaluated per message of a batch:

output:
  redis_hash:
    url: tcp://localhost:6379
    key: ${!json("id")}
    fields:
      topic: ${!meta("kafka_topic")}
      partition: ${!meta("kafka_partition")}
      content: ${!json("document.text")}

If the field walk_metadata is set to true then the connector will walk all metadata fields of messages and add them to the list of hash fields to set.

If the field walk_json_object is set to true then the connector will walk each message as a JSON object, extracting keys and the string representation of their value and adds them to the list of hash fields to set.

The order of hash field extraction is as follows:

Metadata (if enabled)
JSON object (if enabled)
Explicit fields

Where latter stages will overwrite matching field names of a former stage.

Configuration

Name	Type	Optional	Secret	Description
url	string	no	no	The URL of the target Redis server. Database is optional and is supplied as the URL path.
kind	string	yes	no	Specifies a simple, cluster-aware, or failover-aware redis client. The value should be one of `simple`, `cluster` or `failover`. The value defaults to `"simple"`.
master	string	yes	no	Name of the redis master when `kind` is `failover`. The value defaults to `""`.
tls	tls	no	no	Custom TLS settings can be used to override system defaults.
key	string	no	no	The key for each message, function interpolations should be used to create a unique key per message.
walk_metadata	bool	yes	no	Whether all metadata fields of messages should be walked and added to the list of hash fields to set. The value defaults to `false`.
walk_json_object	bool	yes	no	Whether to walk each message as a JSON object and add each key/value pair to the list of hash fields to set. The value defaults to `false`.
fields	fields	yes	no	A map of key/value pairs to set as hash fields. The value defaults to `{}`.
max_in_flight	int	yes	no	The maximum number of messages to have in flight at a given time. Increase this to improve throughput. The value defaults to `64`.

TLS Configuration

Name	Type	Optional	Secret	Description
enabled	bool	yes	no	Whether custom TLS settings are enabled. The value defaults to `false`.
skip_cert_verify	bool	yes	no	Whether to skip server side certificate verification. The value defaults to `false`.
enable_renegotiation	bool	yes	no	Whether to allow the remote server to repeatedly request renegotiation.
				Enable this option if you're seeing the error message `local error: tls: no renegotiation`. The value defaults to `false`.
root_cas	string	yes	yes	An optional root certificate authority to use.
				This is a string, representing a certificate chain from the parent trusted root certificate,
				to possible intermediate signing certificates, to the host certificate. The value defaults to `""`.
client_certs	[]client_certs	yes	no	A list of client certificates to use. . The value defaults to `[]`.

Fields

Name	Type	Optional	Secret	Description