Key Value Delete Documentation

Version: 3.0.0 

Retrieved: 2025-10-09 15:16:00

Key Value Delete

Deletes values identified by a key from a storage in memory or on disk.

Modes

The module can operate in two different modes which are configured by the Persistent Storage setting, see below. A flow can have multiple different key value stores in the same flow and they don't need to use the same mode. Stores can also be separated by using a unique Store Name for each store.

It is possible to have a persistent store and an in-memory store with the same Store Name, in the same flow or in a different flow, but be aware that they are two separate stores and cannot be accessed from the same module.

Persistent storage mode

This mode is selected by setting Persistent Storage to true. The module then deletes values from persistent key value store. Persistent key value stores are available from all flows, which means that if a Key Value Delete module deletes a value in flow 1 it will no longer be available to any other flow on the Node with the same Store Name.

In-memory mode

This mode is selected by setting Persistent Storage to false. In this mode the module deletes values from an in memory key value store. In memory key value stores are only available from modules in the same flow. Values saved to the store are available as long as the flow is running, but when the flow stops, the store is cleared.

Settings

Input

Any message will trigger a delete operation.Key and/or Path can be taken from the input message, if template syntax is used in the settings.

Output

The same as the data passed in including the Crosser result of the operation.

Examples

Deleting a value from persistent storage.

# Settings:
Key={key}
Path=
Store Name=MyStorage
Persistent Storage=true

# Incoming message:
{
    "key": "user",
}


# Outgoing message:
{
    "key": "user",
    "crosser": {
        "success": true
    }
}

Deleting a property of a value from persistent storage.

# Settings:
Key=user
Path={path}
Store Name=MyStorage
Persistent Storage=true

# Incoming message:
{
    "path": "name"
}


# Outgoing message:
{
    "key": "user",
    "path": "name",
    "crosser": {
        "success": true
    }
}