GearsBuilder on Docs

Accumulate

Mon, 01 Jan 0001 00:00:00 +0000

public <I extends java.io.Serializable> GearsBuilder<I> accumulate(
    gears.operations.AccumulateOperation<T,I> accumulator)

public <I extends java.io.Serializable> GearsBuilder<I> accumulate(
    I initialValue, 
    gears.operations.AccumulateOperation<T,I> accumulator)

Accumulate is a many-to-one function that iterates through the records in the pipe and reduces them to a single record.

You can provide a parameter to set the initial accumulator value. Otherwise, the initial accumulator object is null.

Parameters

Type parameters:

AccumulateBy

Mon, 01 Jan 0001 00:00:00 +0000

public <I extends java.io.Serializable> GearsBuilder<I> accumulateBy(
	gears.operations.ExtractorOperation<T> extractor, 
	gears.operations.AccumulateByOperation<T,I> accumulator)

public <I extends java.io.Serializable> GearsBuilder<I> accumulateBy(
	gears.operations.ValueInitializerOperation<I> valueInitializer, 
	gears.operations.ExtractorOperation<T> extractor, 
	gears.operations.AccumulateByOperation<T,I> accumulator)

Iterates through the records in the pipe, groups them based on the provided extractor, and then reduces each group to a single record per group with the accumulator function.

The initial value of the accumulator is null unless you provide a value initializer operation as a parameter.

AsyncFilter

Mon, 01 Jan 0001 00:00:00 +0000

public GearsBuilder<T> asyncFilter(
    gears.operations.AsyncFilterOperation<T> filter)

The asyncFilter function allows you to use a GearsFuture object to asynchronously filter out records in the pipe based on a given condition.

The filter operation should contain a conditional statement and return a boolean for each record:

If true, the record will continue through the pipe.
If false, it filters out the record.

Parameters

Name	Type	Description
filter	AsyncFilterOperation	A function that checks a condition for each record in the pipe. Returns a boolean.

Returns

Returns a GearsBuilder object with the same template type as the input builder.

AsyncForeach

Mon, 01 Jan 0001 00:00:00 +0000

public GearsBuilder<T> asyncForeach(
    gears.operations.AsyncForeachOperation<T> foreach)

The asyncForeach function allows you to use a GearsFuture object to define a set of operations and run them asynchronously for each record in the pipe.

Parameters

Name	Type	Description
foreach	AsyncForeachOperation	The set of operations to run for each record

Returns

Returns a GearsBuilder object with a new template type.

AsyncMap

Mon, 01 Jan 0001 00:00:00 +0000

public <I extends java.io.Serializable> GearsBuilder<I> asyncMap(
	gears.operations.AsyncMapOperation<T,I> mapper)

The asyncMap function allows you to use a GearsFuture object to asynchronously map each input record in the pipe to an output record, one-to-one.

Parameters

Type parameters:

CallNext

Mon, 01 Jan 0001 00:00:00 +0000

public static java.lang.Object callNext(java.lang.String... args)

When you override a Redis command with the CommandOverrider, use callNext to run the next execution that overrides the command or the original command itself.

It is a more flexible version of callNextArray since the list of string arguments does not have to be an explicit String[] object. This allows function calls like: callNext("key", "value").

Parameters

Name	Type	Description
args	string	Redis command arguments

Returns

Returns the command result. It could be a string or an array of strings, depending on the command.

CallNextArray

Mon, 01 Jan 0001 00:00:00 +0000

public static native java.lang.Object callNextArray(
    java.lang.String[] command)

When you override a Redis command with the CommandOverrider, use callNextArray to run the next execution that overrides the command or the original command itself.

It accepts an array of strings, which represents the command arguments.

Parameters

Name	Type	Description
args	array of strings	Redis command arguments

Returns

Returns the command result. It could be a string or an array of strings, depending on the command.

Collect

Mon, 01 Jan 0001 00:00:00 +0000

public GearsBuilder<T> collect()

Collects all of the records to the shard where the RedisGears job started.

Parameters

None

ConfigGet

Mon, 01 Jan 0001 00:00:00 +0000

public static java.lang.String configGet(java.lang.String key)

Gets the value of a RedisGears configuration setting.

Note:

You can set configuration values when you load the module or use the RG.CONFIGSET command.

Parameters

Name	Type	Description
key	string	The configuration setting to get

Returns

Returns the configuration value of a RedisGears configuration setting.

Count

Mon, 01 Jan 0001 00:00:00 +0000

public GearsBuilder<java.lang.Integer> count()

Counts the number of records in the pipe and returns the total as a single record.

Parameters

None

CreateGearsBuilder

Mon, 01 Jan 0001 00:00:00 +0000

public static <I extends java.io.Serializable> GearsBuilder<I> CreateGearsBuilder(
    gears.readers.BaseReader<I> reader)

public static <I extends java.io.Serializable> GearsBuilder<I> CreateGearsBuilder(
    gears.readers.BaseReader<I> reader, 
    java.lang.String desc)

Creates a new GearsBuilder object. Use this function instead of a GearsBuilder constructor to avoid type warnings.

Parameters

Type Parameters:

Execute

Mon, 01 Jan 0001 00:00:00 +0000

public static java.lang.Object execute(java.lang.String... command)

Runs a Redis command, similar to executeArray. However, the execute function is more flexible. Unlike executeArray, the list of string arguments does not have to be an explicit String[] object. It allows function calls like this: execute("SET", "key", "value").

Parameters

Name	Type	Description
command	string	A Redis command

Returns

Returns the command result. It could be a string or an array of strings, depending on the command.

ExecuteArray

Mon, 01 Jan 0001 00:00:00 +0000

public static native java.lang.Object executeArray(
    java.lang.String[] command)

Runs a Redis command. It accepts an array of strings, which represents the command to execute.

Parameters

Name	Type	Description
command	array of strings	A Redis command

Returns

Returns the command result. It could be a string or an array of strings, depending on the command.

Filter

Mon, 01 Jan 0001 00:00:00 +0000

public GearsBuilder<T> filter(
    gears.operations.FilterOperation<T> filter)

Filters out records in the pipe based on a given condition.

The filter operation should contain a conditional statement and return a boolean for each record:

If true, the record will continue through the pipe.
If false, it filters out the record.

Parameters

Name	Type	Description
filter	FilterOperation	A function that checks a condition for each record in the pipe. Returns a boolean.

Returns

Returns a GearsBuilder object with the same template type as the input builder.

FlatMap

Mon, 01 Jan 0001 00:00:00 +0000

public <I extends java.io.Serializable> GearsBuilder<I> flatMap(
	gears.operations.FlatMapOperation<T,I> flatmapper)

Maps a single input record to one or more output records.

The FlatMap operation must return an Iterable. RedisGears splits the elements from the Iterable object and processes them as individual records.

Parameters

Type parameters:

Foreach

Mon, 01 Jan 0001 00:00:00 +0000

public GearsBuilder<T> foreach(
    gears.operations.ForeachOperation<T> foreach)

Defines a set of operations to run for each record in the pipe.

Parameters

Name	Type	Description
foreach	ForeachOperation	The set of operations to run for each record

Returns

Returns a GearsBuilder object with a new template type.

Hashtag

Mon, 01 Jan 0001 00:00:00 +0000

public static java.lang.String hashtag()

Returns a string that maps to the current shard according to the cluster slot mapping.

Note:

You can use the hashtag function when you need to create a key that resides on the current shard.

Parameters

None

LocalAccumulateBy

Mon, 01 Jan 0001 00:00:00 +0000

public <I extends java.io.Serializable> GearsBuilder<I> localAccumulateBy(
	gears.operations.ExtractorOperation<T> extractor, 
	gears.operations.AccumulateByOperation<T,I> accumulator)

The localAccumulateBy function is similar to accumulateBy, except it performs the operation locally on each shard without moving data between shards.

On each shard, it iterates through the records in the pipe, groups them based on the provided extractor, and then reduces each group to a single record per group with the accumulator function.

The initial value of the accumulator is null.

Log

Mon, 01 Jan 0001 00:00:00 +0000

public static void log(java.lang.String msg)

public static void log(java.lang.String msg, LogLevel level)

Writes a log message to the Redis log file. If you do not specify a LogLevel, it will default to NOTICE.

Parameters

Name	Type	Description
msg	string	The message to write to the log
level	LogLevel	The log level (DEBUG, NOTICE, VERBOSE, WARNING)

Returns

None

Map

Mon, 01 Jan 0001 00:00:00 +0000

public <I extends java.io.Serializable> GearsBuilder<I> map(
	gears.operations.MapOperation<T,I> mapper)

Maps each input record in the pipe to an output record, one-to-one.

Parameters

Type parameters:

Register

Mon, 01 Jan 0001 00:00:00 +0000

public java.lang.String register()

public java.lang.String register(ExecutionMode mode)

public java.lang.String register(
    ExecutionMode mode, 
    gears.operations.OnRegisteredOperation onRegister, 
    gears.operations.OnUnregisteredOperation onUnregistered)

Registers the pipeline of functions to run when certain events occur. The registered functions will run each time the event occurs.

Execution modes:

Name	Description
ASYNC	Runs asynchronously on all of the shards.
ASYNC_LOCAL	Runs asynchronously but only on the current shard that generated the event.
SYNC	Runs synchronously only on the same shard that generated the event.

Note:

If you call register() without specifying an execution mode, it will default to ASYNC.

Parameters

Name	Type	Description
mode	ExecutionMode	The execution mode to use (ASYNC/ASYNC_LOCAL/SYNC)
onRegister	OnRegisteredOperation	Register callback that will be called on each shard upon register
onUnregistered	OnUnregisteredOperation	Unregister callback that will be called on each shard upon unregister

Returns

Returns a registration ID.

Repartition

Mon, 01 Jan 0001 00:00:00 +0000

public GearsBuilder<T> repartition(
	gears.operations.ExtractorOperation<T> extractor)

Moves records between the shards. The extracted data determines the new shard location for each record.

Parameters

Name	Type	Description
extractor	ExtractorOperation	Extracts a specific value from each record

Returns

Returns a GearsBuilder object with a new template type.

Run

Mon, 01 Jan 0001 00:00:00 +0000

public void run()

public void run(boolean jsonSerialize, boolean collect)

Runs the pipeline of functions immediately upon execution. It will only run once.

Parameters

Name	Type	Description
collect	boolean	Whether or not to collect the results from the entire cluster before returning them
jsonSerialize	boolean	Whether or not to serialize the results to JSON before returning them

Returns

None