RedisExtended icon

RedisExtended

Get, send and update data in Redis
Join our community

Actions12

Overview

This node interacts with a Redis database to perform various operations on data stored in Redis. Specifically, the "Pop" operation removes and retrieves an element from a Redis list. It supports popping from either the start (head) or the end (tail) of the list. This is useful in scenarios where you want to process items in a queue-like structure stored in Redis, such as task queues, message buffers, or event streams.

For example, if you have a Redis list representing tasks to be processed, using the Pop operation allows you to retrieve and remove the next task to handle it in your workflow.

Properties

Name Meaning
List The name of the Redis list from which to pop data.
Tail Whether to pop data from the end (tail) of the list (true) or from the start (head) (false).
Name Optional property name to write the popped data to in the output JSON. Supports dot-notation.
Options Additional options for the operation:
  Dot Notation Whether to use dot-notation when writing the popped data to the output property. If enabled, "a.b" sets nested properties; if disabled, it sets a single property named "a.b".

Output

The output contains a JSON object with the popped value assigned to the specified property name. If the value is valid JSON, it will be parsed into an object; otherwise, it remains a string.

  • The property name can be nested using dot-notation (e.g., data.person[0].name).
  • Example output JSON if the propertyName is "propertyName" and the popped value is JSON:
{
  "propertyName": {
    "someKey": "someValue"
  }
}
  • If the popped value is not JSON, it will be output as a plain string under the property name.
  • No binary data output is produced by this operation.

Dependencies

  • Requires a connection to a Redis server.
  • Needs an API key credential or equivalent authentication configured in n8n to connect to Redis.
  • Uses the Redis client library internally to communicate with the Redis instance.

Troubleshooting

  • Common issues:
    • Connection failures due to incorrect Redis credentials or network issues.
    • Popping from an empty list returns null, resulting in no data being set.
    • Invalid JSON in the popped value may cause parsing to fail; in that case, the raw string is returned.
  • Error messages:
    • Connection errors: Check Redis credentials and network connectivity.
    • Operation errors: If the node is set to continue on failure, errors are returned in the output JSON under an error property.
  • To resolve errors, verify Redis server availability, credentials, and ensure the list exists and contains data.

Links and References

Discussion