The nodes of the cluster
The additional module options
The options of the clusters
Initializing the module object
The options of the redis database
The additional module options
Restrieving configuration
Specifies the default base backends path to path . The backends path is used when dynamically loading a backend (default: '{module_path}/backends', where module_path is the module's path).
Loads the DL/ML backend specified by the backend identifier from path . If path is relative, it is resolved by prefixing the BACKENDSPATH to it. If path is absolute then it is used as is.
Running a DAG
Additional parameters required for the 'AI.DAGEXECUTE' command
The commands sent to the 'AI.DAGEXECUTE' command
Running a readonly DAG
Additional parameters required for the 'AI.DAGEXECUTE_RO' command
The commands sent to the 'AI.DAGEXECUTE_RO' command
Retrieving script/model info
The key name of a model or script
Resets all statistics associated with the key
Deleting a model
The model's key name
Running a model
The model's key name
The parameters of 'AI.MODELEXECUTE'
Retrieving a model
The model's key name
Will return the model's meta information on backend, device and tag
Will return the model's blob containing the serialized model
Scanning a model
Setting a model
The model's key name
The backend of the model
The devide of the model
The Protobuf-serialized model. Since Redis supports strings up to 512MB, blobs for very large
Additional optional parameters
Deleting a script
The script's key name
Running a script
The script's key nameb
The name of the function to run
The parameters of the 'AI.SCRIPTEXECUTE' command
Retrieving a script
The script's key name
The script's device as a String
The script's source code as a String
Scanning a script
Setting a script
The script's key name
Additional optional parameters
Retrieving a tensor
The tensor's key name
The tensor's reply format can be one of the following (BLOB/VALUES)
Returns the tensor's metadata
Setting a tensor
The tensor's key name
The tensor's data type can be one of: FLOAT , DOUBLE , INT8 , INT16 , INT32 , INT64 , UINT8 or UINT16
The tensor's data (binary/numberic)
Increases the count of item's by increment.
The name of the sketch.
A list of item and increment set's
Returning information about a key
The key of the 'CMS.INFO' command
Initializes a Count-Min Sketch to dimensions specified by user.
The name of the sketch.
The number of counter in each array. Reduces the error size.
The number of counter-arrays. Reduces the probability for an error of a certain size (percentage of total count).
Initializes a Count-Min Sketch to accommodate requested capacity.
The name of the sketch.
Estimate size of error. The error is a percent of total counted items. This effects the width of the sketch.
The desired probability for inflated count.
Merges several sketches into one sketch.
The name of destination sketch.
The number of sketches to be merged.
The names of source sketches to be merged.
A multiple of each sketch. Default =1.
Returns count for item's.
The name of the sketch.
A list of items.
Adding an item to the cuckoo filter, creating the filter if it does not exist.
The name of the filter
The item to add
Adding an item to a cuckoo filter if the item did not exist previously.
The name of the filter
The item to add
Returning the number of times an item may be in the filter.
The name of the filter
The item to count
Deleting an item once from the filter. If the item exists only once, it will be removed from the filter.
The name of the filter
The item to delete from the filter
Determining whether an item may exist in the Cuckoo Filter or not.
The name of the filter
The item to check for
Returning information about a key
The name of the filter
Adding one or more items to a cuckoo filter, allowing the filter to be created with a custom capacity if it does not yet exist.
The name of the filter
Begin the list of items to add
The additional optional parameters of the 'CF.INSERT' command
Adding one or more items to a cuckoo filter, allowing the filter to be created with a custom capacity if it does not yet exist.
The name of the filter
The items of the 'CF.INSERT' command
The additional optional parameters of the 'CF.INSERTNX' command
Restoring a filter previously saved using SCANDUMP.
The name of the key to restore
The iterator value associated with data (returned by SCANDUMP )
The current data chunk (returned by SCANDUMP )
Creating an empty Bloom Cuckoo filter with a given initial capacity.
The key under which the filter is to be found
The number of entries you intend to add to the filter. Performance will begin to degrade after adding more items than this number. The actual degradation will depend on how far the limit has been exceeded. Performance will degrade linearly as the number of entries grow exponentially.
The additional optional parameters
Begining an incremental save of the Cuckoo filter
The name of the filter
Iterator value. This is either 0, or the iterator from a previous invocation of this command
Adding an item to the Bloom Filter, creating the filter if it does not yet exist.
The key of the 'BF.ADD' command
The item of the 'BF.ADD' command
Determining whether an item may exist in the Bloom Filter or not.
The key of the 'BF.EXISTS' command
The key of the 'BF.EXISTS' command
Returning information about a key
The key of the 'BF.INFO' command
Adding one or more items to the bloom filter, by default creating it if it does not yet exist. There are several arguments which may be used to modify this behavior.
The key of the 'BF.INSERT' command
The items of the 'BF.INSERT' command
The additional optional parameters of the 'BF.INSERT' command
Restoring a filter previously saved using SCANDUMP.
The key of the 'BF.LOADCHUNK' command
The iterator of the 'BF.LOADCHUNK' command
The data of the 'BF.LOADCHUNK' command
Adding one or more items to the Bloom Filter, creating the filter if it does not yet exist. This command operates identically to BF.ADD except it allows multiple inputs and returns multiple values * @param key
The items of the 'BF.MADD' command
Determining if one or more items may exist in the filter or not.
The key of the 'BF.MEXISTS' command
The items of the 'BF.MEXISTS' command
Creating an empty Bloom filter with a given desired error ratio and initial capacity.
The key under which the filter is to be found
The desired probability for false positives. This should be a decimal value between 0 and 1. For example, for a desired false positive rate of 0.1% (1 in 1000), error_rate should be set to 0.001. The closer this number is to zero, the greater the memory consumption per item and the more CPU usage per operation.
The number of entries you intend to add to the filter. Performance will begin to degrade after adding more items than this number. The actual degradation will depend on how far the limit has been exceeded. Performance will degrade linearly as the number of entries grow exponentially.
The additional optional parameters
Begining an incremental save of the bloom filter
The key of the 'BF.SCANDUMP' command
The iterator of the 'BF.SCANDUMP' command
Adds one or more samples to a sketch
The name of the sketch
The parameters of the command
OK on success, error otherwise
Returns the fraction of all points added which are <= value
The name of the sketch
Upper limit for which the fraction of all points added which are <= value
Returns compression, capacity, total merged and unmerged nodes, the total compressions made up to date on that key, and merged and unmerged weight
Allocate the memory and initialize the t-digest
The name of the sketch
The compression parameter. 100 is a common value for normal uses. 1000 is extremely large. If no value is passed by default the compression will be 100.
OK on success, error otherwise
Returns compression, capacity, total merged and unmerged nodes, the total compressions made up to date on that key, and merged and unmerged weight.
The name of the sketch
Get maximum value from the sketch. Will return DBL_MIN if the sketch is empty
The name of the sketch
DBL_MIN if the sketch is empty
Merges all of the values from 'from' keys to 'destination-key' sketch.
Sketch to copy values to.
Sketch to copy values from, this can be a string for 1 key or an array of keys.
Get minimum value from the sketch. Will return DBL_MAX if the sketch is empty
The name of the sketch
DBL_MAX if the sketch is empty
Returns an estimate of the cutoff such that a specified fraction of the data added to this TDigest would be less than or equal to the cutoff
The name of the sketch
The desired fraction ( between 0 and 1 inclusively )
Double value estimate of the cutoff such that a specified fraction of the data added to this TDigest would be less than or equal to the cutoff
Reset the sketch to zero - empty out the sketch and re-initialize it
The name of the sketch
OK on success, error otherwise
Adding an item to the data structure.
Name of sketch where item is added.
Item/s to be added.
Returning count for an item.
Name of sketch where item is counted.
Item/s to be counted.
Increases the count of item's by increment.
The name of the sketch.
A list of item and increment set's
Returning information about a key
Name of sketch.
Returning full list of items in Top K list.
Name of sketch where item is counted.
Checking whether an item is one of Top-K items.
Name of sketch where item is queried.
Item/s to be queried.
Initializing a TopK with specified parameters
The key under which the sketch is to be found.
The number of top occurring items to keep.
The number of counters kept in each array.
The number of arrays.
The probability of reducing a counter in an occupied bucket. It is raised to power of it's counter (decay ^ bucket[i].counter). Therefore, as the counter gets higher, the chance of a reduction is being reduced.
Aborting an existing execution
The id of the execution
Retrieving key's configuration
A list of keys
Setting key's configuration
Dropping an existing execution
The id of the execution
Dumping all of the executions
Dumping all of the registrations
Retrieving an execution
The id of the execution
The additional optional parameters
Retrieving the results
The id of the execution
Retrieving the results that have 'UNBLOCKING' argument (And removing it)
The id of the execution
Retrieving information about the cluster
Retrieving a list of all the python requirements available
Executing a python function
The function
The additional optional arguments
Retrieving memory usage statistics from the 'Python interpreter'
Refreshing the node's view of the cluster's topology
Triggering the execution of a registered 'CommandReader' function
The trigger's name
The additional arguments
Removing the registration of a function
The id of the execution
Retrieves, describes and sets runtime configuration options
The option
In case of 'SET' command, a valid value to set
If 'SET' command, returns 'OK' for valid runtime-settable option names and values. If 'GET' command, returns a string with the current option's value.
Completely removing the graph and all of its entities
The name of the graph
String indicating if operation succeeded or failed.
Constructing a query execution plan but does not run it. Inspect this execution plan to better understand how your query will get executed
The name of the graph
The query to execute
String representation of a query execution plan
Executing a query and produces an execution plan augmented with metrics for each operation's execution
The name of the graph
The query to execute
String representation of a query execution plan, with details on results produced by and time spent in each operation.
Executing the given query against a specific graph
The name of the graph
The query to execute
The params of the query
Result set
Executing the given readonly query against a specific graph
The name of the graph
The query to execute
The params of the query
Result set
Retrieving a list containing up to 10 of the slowest queries
The id of the graph
A list containing up to 10 of the slowest queries issued against the given graph ID.
Appending string to JSON key array value
The name of the key
The items to append to an existing JSON array
The path of the key
Integer, specifically the array's new size.
Retrieving JSON key array item by index
The name of the key
The scalar to filter out a JSON key
The path of the key
Integer, specifically the position of the scalar value in the array, or -1 if unfound.
Inserting item into JSON key array
The name of the key
The index to insert the JSON into the array
The JSON string to insert into the array
The path of the key
Integer, specifically the array's new size.
Retrieving the length of a JSON key array
The name of the key
The path of the key
Integer, specifically the array's length.
Poping an array item by index
The name of the key
The index of the array item to pop
The path of the key
Bulk String, specifically the popped JSON value.
Triming an array by index range
The name of the key
The starting index of the trim
The ending index of the trim
The path of the key
Integer, specifically the array's new size.
Clearing a JSON key
The name of the key
The path of the key defaults to root if not provided. Non-existing keys and paths are ignored. Deleting an object's root is equivalent to deleting the key from Redis.
The number of paths deleted (0 or 1).
Executing debug command
The subcommand of the debug command
The name of the key
The path of the key
MEMORY returns an integer, specifically the size in bytes of the value HELP returns an array, specifically with the help message
Deleting a JSON key
The name of the key
The path of the key defaults to root if not provided. Non-existing keys and paths are ignored. Deleting an object's root is equivalent to deleting the key from Redis.
The number of paths deleted (0 or 1).
An alias of delCommand
The name of the key
The path of the key
The number of paths deleted (0 or 1).
Retrieving a JSON key
The name of the key
The path of the key
Additional parameters to arrange the returned values
The value at path in JSON serialized form.
Retrieving values from multiple keys
A list of keys
The path of the keys
The values at path from multiple key's. Non-existing keys and non-existing paths are reported as null.
Increasing JSON key value by number
The name of the key
The number to increase by
The path of the key
Bulk String, specifically the stringified new value.
Multiplying JSON key value by number
The name of the key
The number to multiply by
The path of the key
Bulk String, specifically the stringified new value.
Retrieving an array of JSON keys
The name of the key
The path of the key
Array, specifically the key names in the object as Bulk Strings.
Retrieving the length of a JSON
The name of the key
The path of the key
Integer, specifically the number of keys in the object.
Retrieving a JSON key value in RESP protocol
The name of the key
The path of the key
Array, specifically the JSON's RESP form as detailed.
Setting a new JSON key
The name of the key
The path of the key
The JSON string of the key i.e. '{"x": 4}'
Optional. The condition to set the JSON in.
Simple String OK if executed correctly, or Null Bulk if the specified NX or XX conditions were not met.
Appending string to JSON key string value
The name of the key
The string to append to key value
The path of the key
Integer, specifically the string's new length.
Retrieving the length of a JSON key value
The name of the key
The path of the key
Integer, specifically the string's length.
Toggling a JSON key
The name of the key
The path of the key defaults to root if not provided. Non-existing keys and paths are ignored. Deleting an object's root is equivalent to deleting the key from Redis.
The value of the path after the toggle.
Retrieving the type of a JSON key
The name of the key
The path of the key
Simple String, specifically the type of value.
Adding an interval set
The name of the key
A list of sets to create. At least 1 set is required.
Deleting a all interval sets under a key, or a single/list of specific set/s.
The name of the key
Optional. A list of set names to delete. If not passed all interval sets under key will be removed.
Retrieving all of key interval sets/a single set.
The name of the key
Optional. The name of specific set. If not passed all interval sets under key will be retrieved.
Retrieving all sets under a key that don't have a specific score in their range.
The name of the key
The score of the set
Retrieving all sets under a key that have a specific score in their range.
The name of the key
The score of the set
Appending/creating a new sample to series
The key
The timestamp
The value
The 'TS.ADD' command optional parameters
Altering an existing TS key
Required. The key
Creating a new TS key
The key
The 'TS.CREATE' optional parameter
"OK"
Creating a compaction rule
The 'TS.CREATERULE' command optional parameters
Creating a new sample that decrements the latest sample's value
The key
The value
The 'TS.DECRBY' command optional parameters
Delete data points for a given timeseries and interval range in the form of start and end delete timestamps.
Key name for timeseries
Start timestamp for the range deletion.
End timestamp for the range deletion.
The count of samples deleted
Deleting a compaction rule
The source key
The dest key
Retrieving the last sample of a key
The key
Creating a new sample that increments the latest sample's value
The key
The value
The 'TS.INCRBY' command optional parameters
Retrieving information and statistics on the time-series
The key
Appending new samples to a list of series
A list of key sets
Retrieving the last sample of a key by filter
Required. The filter
Optional. If to add the 'WITHLABELS' Optional parameter
Querying a range across multiple time-series by filters in forward directions
The starting timestamp
The ending timestamp
The filter
The 'TS.MRange' command optional parameters
Querying a range across multiple time-series by filters in reverse directions
The starting timestamp
The ending timestamp
The filter
The 'TS.MRange' command optional parameters
Retrieving all the keys matching the filter list
The filter
Querying a range in forward directions
The key
The starting timestamp
The ending timestamp
The 'TS.Range' command optional parameters
Querying a range in reverse directions
The key
The starting timestamp
The ending timestamp
The 'TS.Range' command optional parameters
Runs a search query on an index, and performs aggregate transformations on the results, extracting statistics etc from them
The index
The query
The additional optional parameters
Array Response. Each row is an array and represents a single aggregate result
Adding alias fron an index
The alias name
The alias index
'OK' or error
Deleting alias fron an index
The alias name
'OK' or error
Updating alias index
The alias name
The alias index
'OK' or error
Adding a new field to the index
The index
The field name
The field type
The additional optional parameters
'OK' or error
Retrieves, describes and sets runtime configuration options
The command type
The option
In case of 'SET' command, a valid value to set
If 'SET' command, returns 'OK' for valid runtime-settable option names and values. If 'GET' command, returns a string with the current option's value.
Creating an index with a given spec
The index of the schema
The index type of the schema
The filter set after the 'SCHEMA' argument
The additional parameters of the spec
'OK' or error
Adding terms to a dictionary
The dictionary
A list of terms
The number of new terms that were added
Deleting terms from a dictionary
The dictionary
A list of terms
The number of terms that were deleted
Dumps all terms in the given dictionary
The dictionary
An array, where each element is term
Deleting the index
The index
If set, the drop operation will delete the actual document hashes.
'OK' or error
Retrieving the execution plan for a complex query
The index
The query
Returns the execution plan for a complex query
Retrieving the execution plan for a complex query but formatted for easier reading without using redis-cli --raw
The index
The query
A string representing the execution plan.
Retrieving infromation and statistics on the index
The index
A nested array of keys and values.
Searching the index with a textual query
The index
The query
The additional optional parameter
Array reply, where the first element is the total number of results, and then pairs of document id, and a nested array of field/value.
Performs spelling correction on a query
The index
The query
The additional optional parameters
An array, in which each element represents a misspelled term from the query
Adds a suggestion string to an auto-complete suggestion dictionary
The key
The suggestion
The score
The additional optional parameters
The current size of the suggestion dictionary
Deleting a string from a suggestion index
The key
The suggestion
Retrieving completion suggestions for a prefix
The key
The prefix of the suggestion
The additional optional parameter
A list of the top suggestions matching the prefix, optionally with score after each entry
Retrieving the size of an auto-complete suggestion dictionary
The key
Dumps the contents of a synonym group
The index
A list of synonym terms and their synonym group ids.
Updating a synonym group
The index
The group id
A list of terms
If set, we do not scan and index.
'OK'
Retrieving the distinct tags indexed in a Tag field
The index
The field name
The distinct tags indexed in a Tag field
Applying mixings of given objects into base object
The base objects
An array of given objects
If to add a prefix of Object name to the properties as ObjectName_FunctionName
Connecting to the Redis database with the module
Disconnecting from the Redis database with the module
Handling a error
The message of the error
Simpilizing the response of the Module command
The array response from the module
Check if array is fully two dimensional. Only items in the array are arrays.
The potential two dimensional array
Formatting given param value to string
The given param value
A param value converted to string
Reducing an array by one level. i.e. from two dimensional to 1 dimensional.
The potentional two dimensional array
Running a Redis command
The command data of a command to send. Consists of command and args.
Generated using TypeDoc
Initializing the module object