Redis

Execute Redis commands and operations against Redis servers.

Basic Usage

steps:
  - id: ping
    action: redis.ping
    with:
      host: localhost
      port: 6379

DAG-Level Configuration

Define connection defaults at the DAG level to avoid repetition across steps:

redis:
  host: localhost
  port: 6379
  password: ${env.REDIS_PASSWORD}

steps:
  - id: set_value
    action: redis.set
    with:
      key: mykey
      value: "hello world"

  - id: get_value
    action: redis.get
    with:
      key: mykey
    output: RESULT
    depends: set_value

Steps inherit connection settings from the DAG level. Step-level with values override DAG-level defaults.

Configuration

Connection

Field	Description	Default
url	Redis URL (redis://user:pass@host:port/db)	-
host	Redis host (alternative to URL)	localhost
port	Redis port	6379
password	Authentication password	-
username	ACL username (Redis 6+)	-
db	Database number (0-15)	0

TLS

Field	Description	Default
tls	Enable TLS connection	false
tls_cert	Client certificate path	-
tls_key	Client key path	-
tls_ca	CA certificate path	-
tls_skip_verify	Skip certificate verification	false

High Availability

Field	Description	Default
mode	Connection mode: standalone, sentinel, cluster	standalone
sentinel_master	Sentinel master name	-
sentinel_addrs	Sentinel addresses	-
cluster_addrs	Cluster node addresses	-

Command Execution

Field	Description	Default
command	Redis command (e.g., GET, SET, HGET)	-
key	Primary key	-
keys	Multiple keys (for commands like MGET, DEL)	-
value	Value for SET operations	-
values	Multiple values (for LPUSH, SADD, etc.)	-
field	Hash field name	-
fields	Multiple hash fields (map)	-
ttl	Expiration in seconds (for SET, EXPIRE)	-
timeout	Command timeout in seconds	30
max_retries	Maximum retry attempts	3

Additional Options

Field	Description
nx	SET if key does not exist
xx	SET if key exists
start	Range start (for LRANGE, ZRANGE)
stop	Range stop (for LRANGE, ZRANGE)
score	Score for sorted set operations
with_scores	Include scores in sorted set output
match	Pattern for SCAN/KEYS
count	Count for SCAN, LPOP, etc.

Output

Field	Description	Default
output_format	Output format: json, jsonl, raw, csv	json
null_value	String representation for nil values	null
max_result_size	Maximum result size in bytes	10MB

Examples

String Operations

steps:
  - id: set_key
    action: redis.set
    with:
      key: user:1:name
      value: "John Doe"

  - id: get_key
    action: redis.get
    with:
      key: user:1:name
    output: USER_NAME
    depends: set_key

  - id: increment
    action: redis.incr
    with:
      key: counter

Key Operations

steps:
  - id: check_exists
    action: redis.exists
    with:
      key: mykey

  - id: set_expiry
    action: redis.expire
    with:
      key: session:123
      ttl: 3600  # 1 hour in seconds

  - id: get_ttl
    action: redis.ttl
    with:
      key: session:123

  - id: delete_key
    action: redis.del
    with:
      key: temp:data

Hash Operations

steps:
  - id: set_hash
    action: redis.hset
    with:
      key: user:1
      field: email
      value: "john@example.com"

  - id: get_hash_field
    action: redis.hget
    with:
      key: user:1
      field: email
    output: EMAIL
    depends: set_hash

  - id: get_all_hash
    action: redis.hgetall
    with:
      key: user:1
    output: USER_DATA
    depends: set_hash

List Operations

steps:
  - id: push_to_list
    action: redis.rpush
    with:
      key: queue:tasks
      values:
        - '{"task": "process-order", "id": 123}'

  - id: get_list_range
    action: redis.lrange
    with:
      key: queue:tasks
      start: 0
      stop: -1  # all elements
    output: TASKS
    depends: push_to_list

  - id: pop_from_list
    action: redis.lpop
    with:
      key: queue:tasks
    output: NEXT_TASK
    depends: get_list_range

Set Operations

steps:
  - id: add_to_set
    action: redis.sadd
    with:
      key: tags:article:1
      values:
        - "redis"
        - "database"
        - "cache"

  - id: get_members
    action: redis.smembers
    with:
      key: tags:article:1
    output: TAGS
    depends: add_to_set

  - id: check_membership
    action: redis.sismember
    with:
      key: tags:article:1
      value: "redis"
    depends: add_to_set

Sorted Set Operations

steps:
  - id: add_score
    action: redis.zadd
    with:
      key: leaderboard
      score: 100
      value: "player1"

  - id: get_top_players
    action: redis.zrange
    with:
      key: leaderboard
      start: 0
      stop: 9
      with_scores: true
    output: TOP_PLAYERS
    depends: add_score

Pipeline Operations

Execute multiple commands in a single round-trip:

steps:
  - id: batch_operations
    action: redis.command
    with:
      pipeline:
        - command: SET
          key: key1
          value: "value1"
        - command: SET
          key: key2
          value: "value2"
        - command: GET
          key: key1
        - command: GET
          key: key2

Transactions

Execute commands atomically with MULTI/EXEC:

steps:
  - id: atomic_transfer
    action: redis.command
    with:
      multi: true
      pipeline:
        - command: DECR
          key: account:1:balance
        - command: INCR
          key: account:2:balance

Lua Scripts

Execute Lua scripts for complex operations:

params:
  - name: USER_ID
    required: true

steps:
  - id: rate_limit
    action: redis.eval
    with:
      script: |
        local key = KEYS[1]
        local limit = tonumber(ARGV[1])
        local window = tonumber(ARGV[2])
        local current = redis.call('INCR', key)
        if current == 1 then
          redis.call('EXPIRE', key, window)
        end
        if current > limit then
          return 0
        end
        return 1
      script_keys:
        - "ratelimit:${params.USER_ID}"
      script_args:
        - "100"   # limit
        - "60"    # window in seconds
    output: ALLOWED

Or load from a file:

params:
  - name: PARAM
    required: true

steps:
  - id: complex_operation
    action: redis.command
    with:
      script_file: ./scripts/process.lua
      script_keys:
        - "input:data"
      script_args:
        - "${params.PARAM}"

Distributed Locking

Acquire a lock before executing critical operations:

params:
  - name: RESOURCE_ID
    required: true

steps:
  - id: critical_section
    action: redis.set
    with:
      lock: "locks:resource:${params.RESOURCE_ID}"
      lock_timeout: 30      # Lock expires after 30 seconds
      lock_retry: 10        # Retry 10 times to acquire lock
      lock_wait: 100        # Wait 100ms between retries
      key: resource:${params.RESOURCE_ID}
      value: '{"status": "processing"}'

Output Capture

steps:
  - id: get_config
    action: redis.hgetall
    with:
      key: app:config
    output: CONFIG

  - id: use_config
    run: echo "Database host is ${CONFIG.host}"
    depends:
      - get_config

Connection Modes

Standalone

Default mode for single Redis server:

redis:
  host: localhost
  port: 6379

Sentinel

For high availability with automatic failover:

redis:
  mode: sentinel
  sentinel_master: mymaster
  sentinel_addrs:
    - sentinel1:26379
    - sentinel2:26379
    - sentinel3:26379
  password: ${env.REDIS_PASSWORD}

Cluster

For distributed Redis cluster:

redis:
  mode: cluster
  cluster_addrs:
    - node1:6379
    - node2:6379
    - node3:6379
  password: ${env.REDIS_PASSWORD}

Connection Pooling

Non-Worker Mode

When executing DAGs directly, each step creates its own connection with defaults:

• Max retries: 3 (configurable via max_retries)
• Command timeout: 30 seconds (configurable via timeout)

Worker Mode

When running distributed workers, Redis connections use a global connection pool managed at the worker level. This prevents connection exhaustion when multiple DAGs run concurrently.

The pool manager:

• Reuses connections across DAG executions with the same connection parameters
• Automatically manages connection lifecycle
• Verifies connections with PING before reuse

Connection Limits

In worker mode, configure your Redis server's maxclients setting appropriately for the expected number of concurrent connections.

Output Formats

JSON (default)

{"key": "value", "count": 42}

JSONL

One JSON object per line:

{"id": 1, "name": "item1"}
{"id": 2, "name": "item2"}

Raw

Plain text output, useful for simple values:

value

CSV

Comma-separated format for tabular data:

field1,field2,field3
value1,value2,value3

Error Handling

steps:
  - id: redis_operation
    action: redis.get
    with:
      key: critical-data
      max_retries: 5
      timeout: 10
    retry_policy:
      limit: 3
      interval_sec: 2
    continue_on:
      failure: true

TLS Configuration

redis:
  host: secure-redis.example.com
  port: 6380
  tls: true
  tls_cert: /path/to/client.crt
  tls_key: /path/to/client.key
  tls_ca: /path/to/ca.crt

For self-signed certificates in development:

redis:
  host: localhost
  port: 6379
  tls: true
  tls_skip_verify: true

Cloud Redis Services

Redis Cloud

redis:
  host: redis-12345.c1.us-east-1-2.ec2.cloud.redislabs.com
  port: 12345
  username: default
  password: ${env.REDIS_CLOUD_PASSWORD}

AWS ElastiCache

redis:
  host: my-cluster.abc123.ng.0001.use1.cache.amazonaws.com
  port: 6379
  tls: true

Azure Cache for Redis

redis:
  host: my-cache.redis.cache.windows.net
  port: 6380
  password: ${env.AZURE_REDIS_KEY}
  tls: true