{
  "schema_version": 2,
  "id": "operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers",
  "title": "RedisGears readers",
  "url": "https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/",
  "summary": "Extracts data from the database and creates records to pass through a RedisGears pipeline.",
  "aliases": [
    "/operate/oss_and_stack/stack-with-enterprise/gears-v1/jvm/classes/readers/"
  ],
  "tags": [
    "docs",
    "operate",
    "stack"
  ],
  "last_updated": "2026-09-21T16:36:38+01:00",
  "children": [
    {
      "id": "operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/commandoverrider",
      "summary": "Override a Redis command.",
      "title": "CommandOverrider",
      "url": "https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/commandoverrider/"
    },
    {
      "id": "operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/commandreader",
      "summary": "Run RedisGears functions on command.",
      "title": "CommandReader",
      "url": "https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/commandreader/"
    },
    {
      "id": "operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/javareader",
      "summary": "A template for creating custom readers.",
      "title": "JavaReader",
      "url": "https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/javareader/"
    },
    {
      "id": "operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/keysonlyreader",
      "summary": "Gets key names from a database.",
      "title": "KeysOnlyReader",
      "url": "https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/keysonlyreader/"
    },
    {
      "id": "operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/keysreader",
      "summary": "Gets keys and their values from a database.",
      "title": "KeysReader",
      "url": "https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/keysreader/"
    },
    {
      "id": "operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/shardsidreader",
      "summary": "Gets the shard ID for each shard in a database.",
      "title": "ShardsIDReader",
      "url": "https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/shardsidreader/"
    },
    {
      "id": "operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/streamreader",
      "summary": "Reads Redis stream data.",
      "title": "StreamReader",
      "url": "https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/streamreader/"
    }
  ],
  "page_type": "content",
  "content_hash": "73c522e5648a3f44fa066b9eeb84f882f8a0b3ffbc8e28bfaec12463f95be935",
  "sections": [
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "A reader extracts data from the database and creates records.\n\nThe [`GearsBuilder.CreateGearsBuilder(reader)`](https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/creategearsbuilder) function takes a reader as a parameter and passes the generated records through a pipeline of RedisGears functions."
    },
    {
      "id": "classes",
      "title": "Classes",
      "role": "content",
      "text": "| Class | Description |\n| --- | --- |\n| [CommandOverrider](https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/commandoverrider/) | Override a Redis command. |\n| [CommandReader](https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/commandreader/) | Run RedisGears functions on command. |\n| [JavaReader](https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/javareader/) | A template for creating custom readers. |\n| [KeysOnlyReader](https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/keysonlyreader/) | Gets key names from a database. |\n| [KeysReader](https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/keysreader/) | Gets keys and their values from a database. |\n| [ShardsIDReader](https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/shardsidreader/) | Gets the shard ID for each shard in a database. |\n| [StreamReader](https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/streamreader/) | Reads Redis stream data. |"
    }
  ],
  "examples": []
}