{
  "schema_version": 2,
  "id": "integrate/redis-data-integration/reference/data-transformation/lookup",
  "title": "redis.lookup",
  "url": "https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/data-transformation/lookup/",
  "summary": "Lookup data from Redis using the given command and key",
  "content": "\n**Properties**\n\n| Name                | Type       | Description                                                                                                                                                                                                                                                          | Required |\n| ------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |\n| **connection**      | `string`   | Connection name                                                                                                                                                                                                                                                      | yes      |\n| **cmd**             | `string`   | The command to execute                                                                                                                                                                                                                                               | yes      |\n| [**args**](#args)   | `string[]` | Redis command arguments                                                                                                                                                                                                                                              | yes      |\n| **language**        | `string`   | Language\u003cbr/\u003eEnum: `\"jmespath\"`, `\"sql\"`\u003cbr/\u003e                                                                                                                                                                                                                        | yes      |\n| **field**           | `string`   | The target field to write the result to\u003cbr/\u003e                                                                                                                                                                                                                         | yes      |\n| **cache**           | `object`   | Cache the result of the argument expressions. See [`cache`](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/data-transformation/cache) for the property list. **Flink processor only.**\u003cbr/\u003e                                                            | no       |\n| **lookup_cache**    | `object`   | Cache the lookup results returned by Redis across batches, keyed by the resolved command arguments. Uses the same property list as [`cache`](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/data-transformation/cache). **Flink processor only.**\u003cbr/\u003e | no       |\n| [**batch**](#batch) | `object`   | Override the default batching behavior for `redis.lookup` lookups. **Flink processor only.**\u003cbr/\u003e                                                                                                                                                                    | no       |\n\n**Additional Properties:** not allowed\n\n**Items**\n\n**Item Type:** `string`\n\n## batch: object {#batch}\n\n`redis.lookup` lookups are always batched and executed through a single Redis pipeline per batch. The processor flushes a batch when either the size or the timeout limit is reached. The defaults are sensible for most pipelines; add the `batch:` block only when you need to override them. **Flink processor only.**\n\n**Properties**\n\n| Name           | Type      | Description                                                                              | Required | Default |\n| -------------- | --------- | ---------------------------------------------------------------------------------------- | -------- | ------- |\n| **size**       | `integer` | Maximum number of lookups in a single batch. Must be positive.                           | no       | `200`   |\n| **timeout_ms** | `integer` | Maximum time in milliseconds to wait before flushing a non-full batch. Must be positive. | no       | `100`   |\n\n**Additional Properties:** not allowed\n**Example**\n\nRead a hash field:\n\n```yaml\nsource:\n  table: album\ntransform:\n  - uses: redis.lookup\n    with:\n      connection: target\n      cmd: HGET\n      args:\n        - concat(['artist:artistid:', artistid])\n        - \"`name`\"\n      language: jmespath\n      field: artist\noutput:\n  - uses: redis.write\n    with:\n      connection: target\n      data_type: hash\n      key:\n        expression: concat(['album:albumid:', albumid])\n        language: jmespath\n```\n\n## args\\[\\]: Redis command arguments {#args}\n\nThe list of expressions that produce arguments.\n",
  "tags": ["docs","integrate","rs","rdi"],
  "last_updated": "2026-09-19T17:55:58-07:00"
}