Key Value Get Documentation

Version: 3.0.0 

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

Key Value Get module.

Gets values from a key value store in memory or on disk.

Modes

The module can operate in two different modes which are configured by the Persistent Storage setting. The module can only access values set to a store of the same type. For example, if a value has been set with the Key Value Set module in persistent mode, it can only be retrieved by Key Value Get module in persistent mode. 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, but be aware that they are two separate stores and cannot be accessed from the same module.

This module can only access stores created by other modules and will not create any new stores by itself.

Persistent storage mode

Module gets values from persistent key value stores. Persistent key value stores are available from all flows, which means the if a Key Value Set module sets a value in flow 1 it will also be available to all other flows on the Node as long as they use the same Store Name.

In-memory mode

This mode is selected by setting Persistent Storage to false. In this mode the module gets 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 flow are available as long as the flow is running, but when the flow stops the store is cleared.

Settings

Name Requirements Purpose Default
Key String with length 1 to 64 Key to get. Use template syntax to set the key from the message, e.g. {key}. key
Path String with length 0 to 64 Path that specifies which property of key to get. If not specified, the whole key will be returned. Use template syntax to set the path from the message, e.g. {path}.  
Store Name String with length 1 to 64 Set a unique name for the store. Key value get/set modules can only access one store. global
Persistent Storage Boolean Set to true if connecting to persistent key value store. true
Target Property Boolean The property the value is written to. data
Ignore Warnings Boolean Set to true to ignore warnings for missing 'Key' or 'Path'. true

Input

Any message will trigger a request to the store. 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

Getting a value from persistent storage, identified by a key taken from the message, and adding it to the incoming message as Target Property. The output will also include the crosser result of the operation.

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

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


# Outgoing message:
{
    "key": "user",
    "data": {
        "sensorId": "Outside1",
        "temperature": 42,
        "description": null,
        "tags": [
            "outside",
            "London"
        ]
    },
    "crosser": {
        "success": true
    }
}

Getting a value identified by key and path from persistent storage (same stored value as above) and adding it to the incoming message as Target Property. The output will also include the crosser result of the operation.

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

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


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

Search Documentation

Other Modules