{
  "id": "gearsbuilder",
  "title": "GearsBuilder",
  "url": "https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/",
  "summary": "Creates a RedisGears pipeline of operations to transform data.",
  "tags": [
    "docs",
    "operate",
    "stack"
  ],
  "last_updated": "2026-04-22T11:55:45+02:00",
  "children": [
    {
      "id": "accumulate",
      "summary": "Reduces many records in the pipe to a single record.",
      "title": "Accumulate",
      "url": "https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/accumulate/"
    },
    {
      "id": "accumulateby",
      "summary": "Groups records and reduces each group to a single record per group.",
      "title": "AccumulateBy",
      "url": "https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/accumulateby/"
    },
    {
      "id": "asyncfilter",
      "summary": "Asynchronously filters out records in the pipe based on a given condition.",
      "title": "AsyncFilter",
      "url": "https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/asyncfilter/"
    },
    {
      "id": "asyncforeach",
      "summary": "For each record in the pipe, asynchronously runs some operations.",
      "title": "AsyncForeach",
      "url": "https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/asyncforeach/"
    },
    {
      "id": "asyncmap",
      "summary": "Asynchronously maps records one-to-one.",
      "title": "AsyncMap",
      "url": "https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/asyncmap/"
    },
    {
      "id": "callnext",
      "summary": "Calls the next execution that overrides the command or the original command itself. A more flexible version of callNextArray.",
      "title": "CallNext",
      "url": "https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/callnext/"
    },
    {
      "id": "callnextarray",
      "summary": "Calls the next execution that overrides the command or the original command itself.",
      "title": "CallNextArray",
      "url": "https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/callnextarray/"
    },
    {
      "id": "collect",
      "summary": "Collects all records to the origin shard.",
      "title": "Collect",
      "url": "https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/collect/"
    },
    {
      "id": "config-get",
      "summary": "Gets the value of a RedisGears configuration setting.",
      "title": "ConfigGet",
      "url": "https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/config-get/"
    },
    {
      "id": "count",
      "summary": "Counts the number of records in the pipe.",
      "title": "Count",
      "url": "https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/count/"
    },
    {
      "id": "creategearsbuilder",
      "summary": "Creates a new GearsBuilder object.",
      "title": "CreateGearsBuilder",
      "url": "https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/creategearsbuilder/"
    },
    {
      "id": "execute",
      "summary": "Runs a Redis command. A more flexible version of executeArray.",
      "title": "Execute",
      "url": "https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/execute/"
    },
    {
      "id": "executearray",
      "summary": "Runs a Redis command.",
      "title": "ExecuteArray",
      "url": "https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/executearray/"
    },
    {
      "id": "filter",
      "summary": "Filters out records in the pipe based on a given condition.",
      "title": "Filter",
      "url": "https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/filter/"
    },
    {
      "id": "flatmap",
      "summary": "Maps a single input record to one or more output records.",
      "title": "FlatMap",
      "url": "https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/flatmap/"
    },
    {
      "id": "foreach",
      "summary": "For each record in the pipe, runs some operations.",
      "title": "Foreach",
      "url": "https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/foreach/"
    },
    {
      "id": "hashtag",
      "summary": "Returns a string that maps to the current shard.",
      "title": "Hashtag",
      "url": "https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/hashtag/"
    },
    {
      "id": "localaccumulateby",
      "summary": "Groups records and reduces each group to a single record per group locally on each shard.",
      "title": "LocalAccumulateBy",
      "url": "https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/localaccumulateby/"
    },
    {
      "id": "log",
      "summary": "Writes a log message to the Redis log file.",
      "title": "Log",
      "url": "https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/log/"
    },
    {
      "id": "map",
      "summary": "Maps records one-to-one.",
      "title": "Map",
      "url": "https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/map/"
    },
    {
      "id": "register",
      "summary": "Registers the pipeline of functions to run when certain events occur.",
      "title": "Register",
      "url": "https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/register/"
    },
    {
      "id": "repartition",
      "summary": "Moves records between shards according to the extracted data.",
      "title": "Repartition",
      "url": "https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/repartition/"
    },
    {
      "id": "run",
      "summary": "Runs the pipeline of functions immediately.",
      "title": "Run",
      "url": "https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/run/"
    }
  ],
  "page_type": "content",
  "content_hash": "431a0ca0e89dbdeeae292dd5a4ffe1de7f590cd51238c6d46f7635e3bdfb8efc",
  "sections": [
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "The `GearsBuilder` class allows you to create a pipeline of RedisGears functions that transform data.\n\nIt requires a reader to supply data to the pipe.\n\nTo create a `GearsBuilder` object, follow this example code:\n\n[code example]"
    },
    {
      "id": "functions",
      "title": "Functions",
      "role": "content",
      "text": ""
    }
  ],
  "examples": [
    {
      "id": "overview-ex0",
      "language": "java",
      "code": "BaseReader reader = ...; // Initialize the reader\nbuilder = GearsBuilder.CreateGearsBuilder(reader);",
      "section_id": "overview"
    }
  ]
}