Skip to content
LyftData Docs

Redis

Redis (redis)

Section titled “Redis (redis)”

Ingest events from Redis Pub/Sub channels or Redis Streams.

Messaging Enterprise edition binary json raw

Minimal example

Section titled “Minimal example”
input:
  redis: {}
JSON 
{
  "input": {
    "redis": {}
  }
}

Contents

Section titled “Contents”

A ✓ marks a field that accepts a context variable such as {{ VARIABLE }}.

Fields

Section titled “Fields”
Field Type Required Description
pub-sub Pub/Sub
stream Stream

Schema

Section titled “Schema”

Pub/Sub - Retry - Backoff Fields

Section titled “Pub/Sub - Retry - Backoff Fields”
Field Type Required Description
strategy Strategy Backoff strategy to use (default exponential).
Allowed values: exponential, linear, fixed
base string Base delay before retrying (e.g. “200ms”).
max string Maximum delay between retries.
jitter ✓ boolean (bool) Whether to add jitter to retry delays.
Default: false

Pub/Sub - Retry Fields

Section titled “Pub/Sub - Retry Fields”
Field Type Required Description
max-attempts number (integer) Maximum attempts before giving up.
Examples: 42, 1.2e-10
forever ✓ boolean (bool) Retry indefinitely until cancelled.
Default: false
backoff Backoff Backoff strategy configuration.

Pub/Sub Fields

Section titled “Pub/Sub Fields”
Field Type Required Description
address url (string) ✅ Redis endpoint URI (for example redis://localhost:6379/0 or rediss://cache:6380/0).
Examples: https://example.com/path
username ✓ string Optional username override when the URI does not embed credentials.
password ✓ string Optional password override when the URI does not embed credentials.
database number (integer) Optional database index override when the URI does not select a database.
Examples: 42, 1.2e-10
retry Retry Retry configuration applied to reconnect attempts.
channels string[] Explicit Redis Pub/Sub channels to subscribe to.
patterns string[] Pattern subscriptions (PSUBSCRIBE) to attach alongside direct channels.
payload-mode Payload Mode Default: json
Allowed values: auto, json, raw, binary
client-name string Optional Redis client name set on the connection.

Stream - Retry - Backoff Fields

Section titled “Stream - Retry - Backoff Fields”
Field Type Required Description
strategy Strategy Backoff strategy to use (default exponential).
Allowed values: exponential, linear, fixed
base string Base delay before retrying (e.g. “200ms”).
max string Maximum delay between retries.
jitter ✓ boolean (bool) Whether to add jitter to retry delays.
Default: false

Stream - Retry Fields

Section titled “Stream - Retry Fields”
Field Type Required Description
max-attempts number (integer) Maximum attempts before giving up.
Examples: 42, 1.2e-10
forever ✓ boolean (bool) Retry indefinitely until cancelled.
Default: false
backoff Backoff Backoff strategy configuration.

Stream - Cursor Fields

Section titled “Stream - Cursor Fields”
Field Type Required Description
state-id string Optional explicit state id for runtime artifact persistence.

Stream Fields

Section titled “Stream Fields”
Field Type Required Description
address url (string) ✅ Redis endpoint URI (for example redis://localhost:6379/0 or rediss://cache:6380/0).
Examples: https://example.com/path
username ✓ string Optional username override when the URI does not embed credentials.
password ✓ string Optional password override when the URI does not embed credentials.
database number (integer) Optional database index override when the URI does not select a database.
Examples: 42, 1.2e-10
retry Retry Retry configuration applied to reconnect and read failures.
streams string[] Redis stream keys to read from.
start-id string Default starting ID used when no persisted cursor exists.
Default: $
start-ids map (string) Per-stream starting IDs that override start-id.
block-ms number (integer) Optional blocking read timeout in milliseconds.
Examples: 42, 1.2e-10
count number (integer) Optional maximum number of entries to read per XREAD.
Examples: 42, 1.2e-10
cursor Cursor Runtime cursor persistence settings.
payload-field field (string) Field in the Redis stream entry that should be treated as the logical payload.
Default: payload
Examples: data_field

Pub/Sub - Retry - Backoff - Strategy Options

Section titled “Pub/Sub - Retry - Backoff - Strategy Options”
Value Aliases Name Description
exponential exponential
linear linear
fixed fixed

Pub/Sub - Payload Mode Options

Section titled “Pub/Sub - Payload Mode Options”
Value Aliases Name Description
auto auto
json json
raw raw
binary binary

Stream - Retry - Backoff - Strategy Options

Section titled “Stream - Retry - Backoff - Strategy Options”
Value Aliases Name Description
exponential exponential
linear linear
fixed fixed