Redis Set

Redis Set

Certified

Write JSON value to a Redis key

Runs JSON.SET on the rendered key and path (default $), optionally returning the previous value and supporting NX/XX-style existence checks.

yaml
type: io.kestra.plugin.redis.json.Set

Set a JSON value.

yaml
id: redis_json_set
namespace: company.team

inputs:
  - id: key_name
    type: STRING
    displayName: Key Name

  - id: key_value
    type: STRING
    displayName: Key Value

tasks:
  - id: set
    type: io.kestra.plugin.redis.json.Set
    url: redis://:redis@localhost:6379/0
    key: "{{ inputs.key_name }}"
    value: |
      {
        "name": "{{ inputs.key_value }}"
      }
Properties

Redis key to set

Rendered before calling JSON.SET.

Redis connection string

JSON value to store

Rendered and serialized with the JSON serde.

Defaultfalse

Return existing value

Defaults to false; when true, fetches the current value before overwriting (not supported on Redis 5.x).

Default{ "mustNotExist": "false", "mustExist": "false" }

Set options

NX/XX-like guards for JSON.SET; see Redis documentation.

Definitions
mustExistbooleanstring
Defaultfalse

Set only when key exists

Applies XX behavior; do not combine with mustNotExist.

mustNotExistbooleanstring
Defaultfalse

Set only when key is absent

Applies NX behavior; do not combine with mustExist.

Default$

JSON path to set

Defaults to $ (root).

Reference (ref) of the pluginDefaults to apply to this task.

Previous value

Returned only when get is true.