Worker KV (Mutate)

Worker KV (Mutate) (worker-kv)

Mutate the deployments-managed Worker KV store.

Storage json raw

Minimal example

actions:
  - worker-kv:
      namespace: ~
      operation:
        set: {}

JSON

{
  "actions": [
    {
      "worker-kv": {
        "namespace": null,
        "operation": {
          "set": {}
        }
      }
    }
  ]
}

Contents

• Minimal example

• Connection

• General

• Operation

• Schema

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

Connection

Connection

Field	Type	Required	Description
namespace	string	✅	Fully-qualified Worker KV namespace (format: tenant:namespace).

General

General

Field	Type	Required	Description
description	string		Describe this step.
condition	lua-expression (string)		Only run this action if the specified condition is met. Examples: 2 * count()

Operation

Operation

Field	Type	Required	Description
operation	Operation	✅	Mutation operation to perform. Allowed values: set, set-if-absent, delete, add-to-set, remove-from-set, ack-batch

Schema

• Operation Options
• Operation - Set Fields
• Operation - Set If Absent Fields
• Operation - Delete Fields
• Operation - Add To Set Fields
• Operation - Remove From Set Fields
• Operation - Ack Batch Fields

Operation Options

Option	Name	Type	Description
set	Set	object
set-if-absent	Set If Absent	object
delete	Delete	object
add-to-set	Add To Set	object
remove-from-set	Remove From Set	object
ack-batch	Ack Batch	object

Operation - Set Fields

Field	Type	Required	Description
key	string		Static key to set within the namespace.
key-field	field (string)		Event field selector (json pointer / dotted path / jsonpath) that yields a string key. Examples: data_field
warn-on-missing-key ✓	boolean (bool)		Emit a warning when key_field is missing/non-string/blank. Default: false
value-field	field (string)		Event field selector used as the stored value (defaults to entire event). Examples: data_field
ttl-ms ✓	number (integer)		Optional TTL in milliseconds. Examples: 42, 1.2e-10

Operation - Set If Absent Fields

Field	Type	Required	Description
key	string		Static key to set within the namespace.
key-field	field (string)		Event field selector (json pointer / dotted path / jsonpath) that yields a string key. Examples: data_field
warn-on-missing-key ✓	boolean (bool)		Emit a warning when key_field is missing/non-string/blank. Default: false
value-field	field (string)		Event field selector used as the stored value (defaults to entire event). Examples: data_field
ttl-ms ✓	number (integer)		Optional TTL in milliseconds. Examples: 42, 1.2e-10

Operation - Delete Fields

Field	Type	Required	Description
key	string		Static key to delete within the namespace.
key-field	field (string)		Event field selector (json pointer / dotted path / jsonpath) that yields a string key. Examples: data_field
warn-on-missing-key ✓	boolean (bool)		Emit a warning when key_field is missing/non-string/blank. Default: false

Operation - Add To Set Fields

Field	Type	Required	Description
set	string	✅	Workset name to add members to.
member-field	field (string)		Selector used as the member identifier (defaults to full event). Examples: data_field
value-field	field (string)		Selector used as the member payload (defaults to full event). Examples: data_field
lease-ttl-ms ✓	number (integer)		Optional lease TTL in milliseconds (currently unused for add-to-set). Examples: 42, 1.2e-10

Operation - Remove From Set Fields

Field	Type	Required	Description
set	string	✅	Workset name to remove members from.
member-field	field (string)		Selector used as the member identifier (defaults to full event). Examples: data_field

Operation - Ack Batch Fields

Field	Type	Required	Description
set	string	✅	Workset name associated with the batch handle.
batch-handle-field	field (string)	✅	Selector used as the batch handle token emitted by worker-kv inputs. Examples: data_field
stats-output-field	field (string)		Optional selector to write post-ack workset stats into the event. Examples: data_field