Skip to main content
Version: Current

Redis

version: Enterprise

Overview

Once a Redis integration is configured, a dedicated Key-Value Store component backed by that Redis instance is added to the Component Palette, labeled <integration name> Key-Value Store.

Configuring Redis integration

ParameterRequiredDescription
Integration nametrueUnique name for the integration.
URItrueRedis connection URI, e.g. redis://host:6379/0. Use the rediss:// scheme for TLS connections.
PasswordfalsePassword used to authenticate with Redis. Can be omitted when carried in the URI.
Connection timeoutfalseTimeout for establishing the connection. Defaults to 5 seconds.
Command timeoutfalseTimeout for a single Redis command. Defaults to 1 second.

Key-Value Store settings

ParameterRequiredDescription
Key prefixfalsePrefix for all keys written by the store; lets multiple stores or other workloads share one Redis database. May contain only letters, digits, _ and -. Defaults to kv.
Max TTLfalseUpper bound for the TTL of stored entries, e.g. 30 days. No limit when not set.
Max key sizefalseUpper bound for the size of a key, e.g. 256 bytes. No limit when not set.
Max value sizefalseUpper bound for the size of a stored value, e.g. 8 KB. No limit when not set.
Max entriesfalseUpper bound for the number of stored entries. No limit when not set.

Exceeding any of the configured limits causes a runtime error for the processed record.

Additional considerations

  • Redis version 6.2 or newer is required. Standalone Redis is supported; Sentinel and Cluster topologies are not.
  • Expired entries are removed natively by Redis when their TTL fires.
  • The recommended eviction policy is volatile-lru. With allkeys-lru, namespace metadata (which has no TTL) can be evicted under memory pressure, resulting in silent loss of namespace definitions.
  • Without persistence (RDB/AOF) configured on the Redis side, a Redis restart wipes the store.
  • Sharing a Redis database with other workloads is safe — all keys written by the store live under the configured key prefix.