Synadia Connect

Redis PubSub

NAMERUNTIMETYPEVERSION
redis_pubsubwombatsourcelatest

Consume from a Redis publish/subscribe channel using either the SUBSCRIBE or PSUBSCRIBE commands.

In order to subscribe to channels using the PSUBSCRIBE command set the field use_patterns to true, then you can include glob-style patterns in your channel names. For example:

  • h?llo subscribes to hello, hallo and hxllo
  • h*llo subscribes to hllo and heeeello
  • h[ae]llo subscribes to hello and hallo, but not hillo

Use \ to escape special characters if you want to match them verbatim.

Configuration

NameTypeOptionalSecretDescription
urlstringnonoThe URL of the target Redis server. Database is optional and is supplied as the URL path.
kindstringyesnoSpecifies a simple, cluster-aware, or failover-aware redis client. The value should be one of simple, cluster or failover. The value defaults to "simple".
masterstringyesnoName of the redis master when kind is failover. The value defaults to "".
tlstlsnonoCustom TLS settings can be used to override system defaults.
channels[]stringnonoA list of channels to consume from.
use_patternsboolyesnoWhether to use the PSUBSCRIBE command, allowing for glob-style patterns within target channel names. The value defaults to false.
auto_replay_nacksboolyesnoWhether messages that are rejected (nacked) at the output level should be automatically replayed indefinitely, eventually resulting in back pressure if the cause of the rejections is persistent. If set to false these messages will instead be deleted. Disabling auto replays can greatly improve memory efficiency of high throughput streams as the original shape of the data can be discarded immediately upon consumption and mutation. The value defaults to true.

TLS Configuration

NameTypeOptionalSecretDescription
enabledboolyesnoWhether custom TLS settings are enabled. The value defaults to false.
skip_cert_verifyboolyesnoWhether to skip server side certificate verification. The value defaults to false.
enable_renegotiationboolyesnoWhether 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_casstringyesyesAn 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_certsyesnoA list of client certificates to use. . The value defaults to [].
Previous
Redis List