RedisGears readers on Docs

CommandOverrider

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

The CommandOverrider allows you to override and customize Redis commands.

Pass the CommandOverrider to the GearsBuilder.CreateGearsBuilder() function in your Java code.
Call the register() function.
Run RG.JEXECUTE to register your code.

Note:

If you register code that uses CommandOverrider, its reader value is "CommandReader" when you run the RG.DUMPREGISTRATIONS command, not "CommandOverrider".

Parameters

Name	Type	Description
command	string	The command to override
prefix	string	Only override the command for keys that start with this string

Output records

Outputs a record with the command's name and arguments.

CommandReader

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

The CommandReader allows you to run RedisGears functions on command when you:

Pass the CommandReader to the GearsBuilder.CreateGearsBuilder() function in your Java code.
Call the register() function.
Run RG.JEXECUTE to register your code.

Use RG.TRIGGER to run your code on command:

RG.TRIGGER <Trigger name> [arg1 arg2 ...]

Parameters

Name	Type	Description
trigger	string	The command name that triggers the registered RedisGears functions to run

Output records

Outputs a record with the command trigger's name and arguments.

JavaReader

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

The JavaReader is an abstract class that allows you to create a custom reader in Java.

Create a custom reader

To create a custom reader:

KeysOnlyReader

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

The KeysOnlyReader only extracts the key names from a database.

Constructors

You can use one of these constructors to create a new KeysOnlyReader object:

KeysReader

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

Creates records from the keys and values stored in a Redis database.

Note:

Currently only supports string and hash data types. For other data types, it will only extract the key name.

Constructors

You can use one of these constructors to create a new KeysReader object:

ShardsIDReader

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

The ShardsIDReader creates a single record on each shard that represents the current shard's ID.

Use this reader when you want to run an operation on each shard in the database.

Parameters

None

StreamReader

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

Reads Redis stream data.

Parameters

Name	Type	Default value	Description
batchSize	integer	1	The number of new messages that will cause the functions to run
duration	integer	0	How many seconds to wait before execution, regardless of batch size
failurePolicy	FailurePolicy	FailurePolicy.CONTINUE	How to handle execution failure (CONTINUE/ABORT/RETRY)
failureRetryInterval	integer	5000	The number of seconds to wait before retrying
pattern	string	"*" (match all keys)	The pattern of keys that store streams
startId	string	"0-0"	Start reading from this stream ID
trimStream	boolean	true	Whether or not to trim the stream

Output records

Creates a record for each message in the input stream.