Class RedisGears

Hierarchy

Module
- RedisGears

Constructors

constructor

new RedisGears(clusterNodes: ClusterNode[], moduleOptions?: RedisModuleOptions, clusterOptions?: ClusterOptions): RedisGears
new RedisGears(redisOptions: RedisOptions, moduleOptions?: RedisModuleOptions): RedisGears

Overrides Module.constructor
- Defined in modules/redisgears/redisgears.ts:18
Initializing the module object

Parameters
- clusterNodes: ClusterNode[]
  
  The nodes of the cluster
- Optional moduleOptions: RedisModuleOptions
  
  The additional module options
- Optional clusterOptions: ClusterOptions
  
  The options of the clusters
Returns RedisGears
Overrides Module.constructor
- Defined in modules/redisgears/redisgears.ts:27
Initializing the module object

Parameters
- redisOptions: RedisOptions
  
  The options of the redis database
- Optional moduleOptions: RedisModuleOptions
  
  The additional module options
Returns RedisGears

Properties

cluster

cluster: Cluster

clusterNodes

clusterNodes: ClusterNode[]

clusterOptions

clusterOptions: ClusterOptions

Private gearsCommander

gearsCommander: GearsCommander = ...

isHandleError

isHandleError: boolean

name

name: string

redis

redis: Redis

redisOptions

redisOptions: RedisOptions

returnRawResponse

returnRawResponse: boolean

showDebugLogs

showDebugLogs: boolean

Methods

abortExecution

abortExecution(id: string): Promise<"OK">

- Defined in modules/redisgears/redisgears.ts:36
Aborting an existing execution

Parameters
- id: string
  
  The id of the execution
Returns Promise<"OK">

configGet

configGet(key: string[]): Promise<number>

- Defined in modules/redisgears/redisgears.ts:45
Retrieving key's configuration

Parameters
- key: string[]
  
  A list of keys
Returns Promise<number>

configSet

configSet(keyvalues: string[][]): Promise<"OK"[]>

- Defined in modules/redisgears/redisgears.ts:54
Setting key's configuration

Parameters
- keyvalues: string[][]
Returns Promise<"OK"[]>

connect

connect(): Promise<void>

Inherited from Module.connect
- Defined in modules/module.base.ts:52
Connecting to the Redis database with the module

Returns Promise<void>

disconnect

disconnect(): Promise<void>

Inherited from Module.disconnect
- Defined in modules/module.base.ts:64
Disconnecting from the Redis database with the module

Returns Promise<void>

dropExecution

dropExecution(id: string): Promise<"OK">

- Defined in modules/redisgears/redisgears.ts:63
Dropping an existing execution

Parameters
- id: string
  
  The id of the execution
Returns Promise<"OK">

dumpExecutions

dumpExecutions(): Promise<string[][]>

- Defined in modules/redisgears/redisgears.ts:71
Dumping all of the executions

Returns Promise<string[][]>

dumpRegistrations

dumpRegistrations(): Promise<string[][]>

- Defined in modules/redisgears/redisgears.ts:79
Dumping all of the registrations

Returns Promise<string[][]>

getExecution

getExecution(id: string, options?: RGGetExecutionParameters): Promise<string[][]>

- Defined in modules/redisgears/redisgears.ts:89
Retrieving an execution

Parameters
- id: string
  
  The id of the execution
- Optional options: RGGetExecutionParameters
  
  The additional optional parameters
Returns Promise<string[][]>

getResults

getResults(id: string): Promise<string>

- Defined in modules/redisgears/redisgears.ts:98
Retrieving the results

Parameters
- id: string
  
  The id of the execution
Returns Promise<string>

getResultsBlocking

getResultsBlocking(id: string): Promise<string>

- Defined in modules/redisgears/redisgears.ts:107
Retrieving the results that have 'UNBLOCKING' argument (And removing it)

Parameters
- id: string
  
  The id of the execution
Returns Promise<string>

handleError

handleError(error: string): any

Inherited from Module.handleError
- Defined in modules/module.base.ts:99
Handling a error

Parameters
- error: string
  
  The message of the error
Returns any

handleResponse

handleResponse(response: any): any

Inherited from Module.handleResponse
- Defined in modules/module.base.ts:110
Simpilizing the response of the Module command

Parameters
- response: any
  
  The array response from the module
Returns any

infocluster

infocluster(): Promise<string[]>

- Defined in modules/redisgears/redisgears.ts:115
Retrieving information about the cluster

Returns Promise<string[]>

isOnlyTwoDimensionalArray

isOnlyTwoDimensionalArray(array: any[]): boolean

Inherited from Module.isOnlyTwoDimensionalArray
- Defined in modules/module.base.ts:148
Check if array is fully two dimensional. Only items in the array are arrays.

Parameters
- array: any[]
  
  The potential two dimensional array
Returns boolean

paramToString

paramToString(paramValue: string): string

Inherited from Module.paramToString
- Defined in modules/module.base.ts:169
Formatting given param value to string

Parameters
- paramValue: string
  
  The given param value
Returns string
A param value converted to string

pydumpreqs

pydumpreqs(): Promise<string[]>

- Defined in modules/redisgears/redisgears.ts:141
Retrieving a list of all the python requirements available

Returns Promise<string[]>

pyexecute

pyexecute(func: string, options?: RGPyExecuteParameters): Promise<string>

- Defined in modules/redisgears/redisgears.ts:125
Executing a python function

Parameters
- func: string
  
  The function
- Optional options: RGPyExecuteParameters
  
  The additional optional arguments
Returns Promise<string>

pystats

pystats(): Promise<string[]>

- Defined in modules/redisgears/redisgears.ts:133
Retrieving memory usage statistics from the 'Python interpreter'

Returns Promise<string[]>

reduceArrayDimension

reduceArrayDimension(array: any[][]): any[]

Inherited from Module.reduceArrayDimension
- Defined in modules/module.base.ts:156
Reducing an array by one level. i.e. from two dimensional to 1 dimensional.

Parameters
- array: any[][]
  
  The potentional two dimensional array
Returns any[]

refreshCluster

refreshCluster(): Promise<"OK">

- Defined in modules/redisgears/redisgears.ts:149
Refreshing the node's view of the cluster's topology

Returns Promise<"OK">

sendCommand

sendCommand(data: CommandData): Promise<any>

Inherited from Module.sendCommand
- Defined in modules/module.base.ts:77
Running a Redis command

Parameters
- data: CommandData
  
  The command data of a command to send. Consists of command and args.
Returns Promise<any>

trigger

trigger(trigger: string, args: string[]): Promise<string[]>

- Defined in modules/redisgears/redisgears.ts:159
Triggering the execution of a registered 'CommandReader' function

Parameters
- trigger: string
  
  The trigger's name
- args: string[]
  
  The additional arguments
Returns Promise<string[]>

unregister

unregister(id: string): Promise<"OK">

- Defined in modules/redisgears/redisgears.ts:168
Removing the registration of a function

Parameters
- id: string
  
  The id of the execution
Returns Promise<"OK">

Generated using TypeDoc