Readonly bfReadonly ADD: { Readonly IS_Readonly parseReadonly transformReadonly CARD: { Readonly IS_Readonly parseReadonly transformReadonly EXISTS: { Readonly IS_Readonly parseReadonly transformReadonly INFO: { Readonly IS_Readonly parseReadonly transformReadonly 2: ((this, reply, _, typeMapping?) => BfInfoReplyMap)Optional typeMapping: TypeMappingReadonly 3: (() => BfInfoReplyMap)Readonly INSERT: { Readonly IS_Readonly parseOptional options: BfInsertOptionsReadonly transformReadonly LOADCHUNK: { Readonly IS_Readonly parseReadonly transformReadonly MADD: { Readonly IS_Readonly parseReadonly transformReadonly MEXISTS: { Readonly IS_Readonly parseReadonly transformReadonly RESERVE: { Readonly IS_Readonly parseOptional options: BfReserveOptionsReadonly transformReadonly SCANDUMP: { Readonly IS_Readonly parseReadonly transformReadonly add: { Readonly IS_Readonly parseReadonly transformReadonly card: { Readonly IS_Readonly parseReadonly transformReadonly exists: { Readonly IS_Readonly parseReadonly transformReadonly info: { Readonly IS_Readonly parseReadonly transformReadonly 2: ((this, reply, _, typeMapping?) => BfInfoReplyMap)Optional typeMapping: TypeMappingReadonly 3: (() => BfInfoReplyMap)Readonly insert: { Readonly IS_Readonly parseOptional options: BfInsertOptionsReadonly transformReadonly loadReadonly IS_Readonly parseReadonly transformReadonly mReadonly IS_Readonly parseReadonly transformReadonly mReadonly IS_Readonly parseReadonly transformReadonly reserve: { Readonly IS_Readonly parseOptional options: BfReserveOptionsReadonly transformReadonly scanReadonly IS_Readonly parseReadonly transformReadonly cfReadonly ADD: { Readonly IS_Readonly parseReadonly transformReadonly ADDNX: { Readonly IS_Readonly parseReadonly transformReadonly COUNT: { Readonly IS_Readonly parseReadonly transformReadonly DEL: { Readonly IS_Readonly parseReadonly transformReadonly EXISTS: { Readonly IS_Readonly parseReadonly transformReadonly INFO: { Readonly IS_Readonly parseReadonly transformReadonly 2: ((this, reply, _, typeMapping?) => CfInfoReplyMap)Optional typeMapping: TypeMappingReadonly 3: (() => CfInfoReplyMap)Readonly INSERT: { Readonly IS_Readonly parseOptional options: CfInsertOptionsReadonly transformReadonly INSERTNX: { Readonly IS_Readonly parseOptional options: CfInsertOptionsReadonly transformReadonly LOADCHUNK: { Readonly IS_Readonly parseReadonly transformReadonly RESERVE: { Readonly IS_Readonly parseOptional options: CfReserveOptionsReadonly transformReadonly SCANDUMP: { Readonly IS_Readonly parseReadonly transformReadonly add: { Readonly IS_Readonly parseReadonly transformReadonly addNX: { Readonly IS_Readonly parseReadonly transformReadonly count: { Readonly IS_Readonly parseReadonly transformReadonly del: { Readonly IS_Readonly parseReadonly transformReadonly exists: { Readonly IS_Readonly parseReadonly transformReadonly info: { Readonly IS_Readonly parseReadonly transformReadonly 2: ((this, reply, _, typeMapping?) => CfInfoReplyMap)Optional typeMapping: TypeMappingReadonly 3: (() => CfInfoReplyMap)Readonly insert: { Readonly IS_Readonly parseOptional options: CfInsertOptionsReadonly transformReadonly insertNX: { Readonly IS_Readonly parseOptional options: CfInsertOptionsReadonly transformReadonly loadReadonly IS_Readonly parseReadonly transformReadonly reserve: { Readonly IS_Readonly parseOptional options: CfReserveOptionsReadonly transformReadonly scanReadonly IS_Readonly parseReadonly transformReadonly cmsReadonly INCRBY: { Readonly IS_Readonly parseReadonly transformReadonly INFO: { Readonly IS_Readonly parseReadonly transformReadonly 2: ((this, reply, _, typeMapping?) => CmsInfoReply)Optional typeMapping: TypeMappingReadonly 3: (() => CmsInfoReply)Readonly INITBYDIM: { Readonly IS_Readonly parseReadonly transformReadonly INITBYPROB: { Readonly IS_Readonly parseReadonly transformReadonly MERGE: { Readonly IS_Readonly parseReadonly transformReadonly QUERY: { Readonly IS_Readonly parseReadonly transformReadonly incrReadonly IS_Readonly parseReadonly transformReadonly info: { Readonly IS_Readonly parseReadonly transformReadonly 2: ((this, reply, _, typeMapping?) => CmsInfoReply)Optional typeMapping: TypeMappingReadonly 3: (() => CmsInfoReply)Readonly initReadonly IS_Readonly parseReadonly transformReadonly initReadonly IS_Readonly parseReadonly transformReadonly merge: { Readonly IS_Readonly parseReadonly transformReadonly query: { Readonly IS_Readonly parseReadonly transformThe index name to query
The text query to use as filter, use * to indicate no filtering
Optional parameters for aggregation:
Readonly IS_Readonly NOT_Readonly parseOptional options: FtAggregateOptionsReadonly transformReadonly 2: ((rawReply, preserve?, typeMapping?) => AggregateReply)Optional preserve: anyOptional typeMapping: TypeMappingReadonly 3: ((rawReply, preserve?, typeMapping?) => AggregateReply)Optional preserve: anyOptional typeMapping: TypeMappingPerforms an aggregation with a cursor for retrieving large result sets.
Name of the index to query
The aggregation query
Optional parameters:
Readonly IS_Readonly parseOptional options: FtAggregateWithCursorOptionsReadonly transformReadonly 2: ((reply, preserve?, typeMapping?) => AggregateWithCursorReply)Optional preserve: anyOptional typeMapping: TypeMappingReadonly 3: ((reply, preserve?, typeMapping?) => AggregateWithCursorReply)Optional preserve: anyOptional typeMapping: TypeMappingAdds an alias to a RediSearch index.
The alias to add
The index name to alias
Readonly IS_Readonly NOT_Readonly parseReadonly transformRemoves an existing alias from a RediSearch index.
The alias to remove
Readonly IS_Readonly NOT_Readonly parseReadonly transformUpdates the index pointed to by an existing alias.
The existing alias to update
The new index name that the alias should point to
Readonly IS_Readonly NOT_Readonly parseReadonly transformAlters an existing RediSearch index schema by adding new fields.
The index to alter
The schema definition containing new fields to add
Readonly IS_Readonly NOT_Readonly parseReadonly transformGets a RediSearch configuration option value.
The name of the configuration option to retrieve
Readonly IS_Readonly NOT_Readonly parseReadonly transformSets a RediSearch configuration option value.
The name of the configuration option to set
The value to set for the configuration option
Readonly IS_Readonly NOT_Readonly parseReadonly transformCreates a new search index with the given schema and options.
Name of the index to create
Index schema defining field names and types (TEXT, NUMERIC, GEO, TAG, VECTOR, GEOSHAPE). Each field can be a single definition or an array to index the same field multiple times with different configurations.
Optional parameters:
Readonly IS_Readonly NOT_Readonly parseOptional options: CreateOptionsReadonly transformDeletes a cursor from an index.
The index name that contains the cursor
The cursor ID to delete
Readonly IS_Readonly NOT_Readonly parseReadonly transformReads from an existing cursor to get more results from an index.
The index name that contains the cursor
The cursor ID to read from
Optional parameters:
Readonly IS_Readonly NOT_Readonly parseOptional options: FtCursorReadOptionsReadonly transformReadonly 2: ((reply, preserve?, typeMapping?) => AggregateWithCursorReply)Optional preserve: anyOptional typeMapping: TypeMappingReadonly 3: ((reply, preserve?, typeMapping?) => AggregateWithCursorReply)Optional preserve: anyOptional typeMapping: TypeMappingAdds terms to a dictionary.
Name of the dictionary to add terms to
One or more terms to add to the dictionary
Readonly IS_Readonly NOT_Readonly parseReadonly transformDeletes terms from a dictionary.
Name of the dictionary to remove terms from
One or more terms to delete from the dictionary
Readonly IS_Readonly NOT_Readonly parseReadonly transformReturns all terms in a dictionary.
Name of the dictionary to dump
Readonly IS_Readonly NOT_Readonly parseReadonly transformReadonly 2: (() => ArrayReply<BlobStringReply<string>>)Readonly 3: (() => SetReply<BlobStringReply<string>>)Deletes an index and all associated documents.
Name of the index to delete
Optional parameters:
Readonly IS_Readonly NOT_Readonly parseOptional options: FtDropIndexOptionsReadonly transformReadonly 2: (() => SimpleStringReply<"OK">)Readonly 3: (() => NumberReply<number>)Returns the execution plan for a complex query.
Name of the index to explain query against
The query string to explain
Optional parameters:
Readonly IS_Readonly NOT_Readonly parseOptional options: FtExplainOptionsReadonly transformReturns the execution plan for a complex query in a more verbose format than FT.EXPLAIN.
Name of the index to explain query against
The query string to explain
Optional parameters:
Readonly IS_Readonly NOT_Readonly parseOptional options: FtExplainCLIOptionsReadonly transformExperimental HYBRID: { Performs a hybrid search combining multiple search expressions. Supports multiple SEARCH and VECTOR expressions with various fusion methods.
NOTE: FT.Hybrid is still in experimental state It's behaviour and function signature may change
The index name to search
Hybrid search options including:
Readonly IS_Readonly NOT_Readonly parseReadonly transformReadonly 2: ((reply, _preserve?, _typeMapping?) => HybridSearchResult)Optional _preserve: anyOptional _typeMapping: TypeMappingReadonly 3: ((reply, _preserve?, _typeMapping?) => HybridSearchResult)Optional _preserve: anyOptional _typeMapping: TypeMappingReturns information and statistics about an index.
Name of the index to get information about
Readonly IS_Readonly NOT_Readonly parseReadonly transformProfiles the execution of an aggregation query for performance analysis.
Name of the index to profile query against
The aggregation query to profile
Optional parameters:
Readonly IS_Readonly NOT_Readonly parseOptional options: ProfileOptions & FtAggregateOptionsReadonly transformReadonly 2: ((reply, preserve?, typeMapping?) => ProfileReplyResp2)Optional preserve: anyOptional typeMapping: TypeMappingReadonly 3: ((reply, preserve?, typeMapping?) => ProfileReplyResp2)Optional preserve: anyOptional typeMapping: TypeMappingProfiles the execution of a search query for performance analysis.
Name of the index to profile query against
The search query to profile
Optional parameters:
Readonly IS_Readonly NOT_Readonly parseOptional options: ProfileOptions & FtSearchOptionsReadonly transformReadonly 2: ((reply, preserve?, typeMapping?) => ProfileReplyResp2)Optional preserve: anyOptional typeMapping: TypeMappingReadonly 3: ((reply, preserve?, typeMapping?) => ProfileReplyResp2)Optional preserve: anyOptional typeMapping: TypeMappingSearches a RediSearch index with the given query.
The index name to search
The text query to search. For syntax, see https://redis.io/docs/stack/search/reference/query_syntax
Optional search parameters including:
Readonly IS_Readonly NOT_Readonly parseOptional options: FtSearchOptionsReadonly transformReadonly 2: ((reply, _preserve?, _typeMapping?) => SearchReply)Optional _preserve: anyOptional _typeMapping: TypeMappingReadonly 3: ((rawReply, preserve?, typeMapping?) => SearchReply)Optional preserve: anyOptional typeMapping: TypeMappingPerforms a search query but returns only document ids without their contents.
Same parameters as FT.SEARCH:
Readonly IS_Readonly NOT_Readonly parseOptional options: FtSearchOptionsReadonly transformReadonly 2: ((reply) => SearchNoContentReply)Readonly 3: ((reply, preserve?, typeMapping?) => SearchNoContentReply)Optional preserve: anyOptional typeMapping: TypeMappingPerforms spelling correction on a search query.
Name of the index to use for spelling corrections
The search query to check for spelling
Optional parameters:
Readonly IS_Readonly NOT_Readonly parseOptional options: FtSpellCheckOptionsReadonly transformReadonly 2: ((rawReply) => { Readonly 3: ((rawReply) => { Adds a suggestion string to an auto-complete suggestion dictionary.
The suggestion dictionary key
The suggestion string to add
The suggestion score used for sorting
Optional parameters:
Readonly IS_Readonly parseOptional options: FtSugAddOptionsReadonly transformDeletes a string from a suggestion dictionary.
The suggestion dictionary key
The suggestion string to delete
Readonly IS_Readonly parseReadonly transformGets completion suggestions for a prefix from a suggestion dictionary.
The suggestion dictionary key
The prefix to get completion suggestions for
Optional parameters:
Readonly IS_Readonly parseOptional options: FtSugGetOptionsReadonly transformGets completion suggestions with their payloads from a suggestion dictionary.
Same parameters as FT.SUGGET:
Readonly IS_Readonly parseOptional options: FtSugGetOptionsReadonly transformGets completion suggestions with their scores from a suggestion dictionary.
Same parameters as FT.SUGGET:
Readonly IS_Readonly parseOptional options: FtSugGetOptionsReadonly transformReadonly 2: ((reply, preserve?, typeMapping?) => null | { Optional preserve: unknownOptional typeMapping: TypeMappingReadonly 3: ((reply) => null | { Gets completion suggestions with their scores and payloads from a suggestion dictionary.
Same parameters as FT.SUGGET:
Readonly IS_Readonly parseOptional options: FtSugGetOptionsReadonly transformReadonly 2: ((reply, preserve?, typeMapping?) => null | { Optional preserve: unknownOptional typeMapping: TypeMappingReadonly 3: ((reply) => null | { Gets the size of a suggestion dictionary.
The suggestion dictionary key
Readonly IS_Readonly parseReadonly transformDumps the contents of a synonym group.
Name of the index that contains the synonym group
Readonly IS_Readonly NOT_Readonly parseReadonly transformReadonly 2: ((reply) => Record<string, ArrayReply<BlobStringReply<string>>>)Readonly 3: (() => MapReply<BlobStringReply<string>, ArrayReply<BlobStringReply<string>>>)Updates a synonym group with new terms.
Name of the index that contains the synonym group
ID of the synonym group to update
One or more synonym terms to add to the group
Optional parameters:
Readonly IS_Readonly NOT_Readonly parseOptional options: FtSynUpdateOptionsReadonly transformReturns the distinct values in a TAG field.
Name of the index
Name of the TAG field to get values from
Readonly IS_Readonly NOT_Readonly parseReadonly transformReadonly 2: (() => ArrayReply<BlobStringReply<string>>)Readonly 3: (() => SetReply<BlobStringReply<string>>)Lists all existing indexes in the database.
Readonly IS_Readonly NOT_Readonly parseReadonly transformReadonly 2: (() => ArrayReply<BlobStringReply<string>>)Readonly 3: (() => SetReply<BlobStringReply<string>>)Lists all existing indexes in the database.
Readonly IS_Readonly NOT_Readonly parseReadonly transformReadonly 2: (() => ArrayReply<BlobStringReply<string>>)Readonly 3: (() => SetReply<BlobStringReply<string>>)Performs an aggregation query on a RediSearch index.
The index name to query
The text query to use as filter, use * to indicate no filtering
Optional parameters for aggregation:
Readonly IS_Readonly NOT_Readonly parseOptional options: FtAggregateOptionsReadonly transformReadonly 2: ((rawReply, preserve?, typeMapping?) => AggregateReply)Optional preserve: anyOptional typeMapping: TypeMappingReadonly 3: ((rawReply, preserve?, typeMapping?) => AggregateReply)Optional preserve: anyOptional typeMapping: TypeMappingPerforms an aggregation with a cursor for retrieving large result sets.
Name of the index to query
The aggregation query
Optional parameters:
Readonly IS_Readonly parseOptional options: FtAggregateWithCursorOptionsReadonly transformReadonly 2: ((reply, preserve?, typeMapping?) => AggregateWithCursorReply)Optional preserve: anyOptional typeMapping: TypeMappingReadonly 3: ((reply, preserve?, typeMapping?) => AggregateWithCursorReply)Optional preserve: anyOptional typeMapping: TypeMappingAdds an alias to a RediSearch index.
The alias to add
The index name to alias
Readonly IS_Readonly NOT_Readonly parseReadonly transformRemoves an existing alias from a RediSearch index.
The alias to remove
Readonly IS_Readonly NOT_Readonly parseReadonly transformUpdates the index pointed to by an existing alias.
The existing alias to update
The new index name that the alias should point to
Readonly IS_Readonly NOT_Readonly parseReadonly transformAlters an existing RediSearch index schema by adding new fields.
The index to alter
The schema definition containing new fields to add
Readonly IS_Readonly NOT_Readonly parseReadonly transformGets a RediSearch configuration option value.
The name of the configuration option to retrieve
Readonly IS_Readonly NOT_Readonly parseReadonly transformSets a RediSearch configuration option value.
The name of the configuration option to set
The value to set for the configuration option
Readonly IS_Readonly NOT_Readonly parseReadonly transformCreates a new search index with the given schema and options.
Name of the index to create
Index schema defining field names and types (TEXT, NUMERIC, GEO, TAG, VECTOR, GEOSHAPE). Each field can be a single definition or an array to index the same field multiple times with different configurations.
Optional parameters:
Readonly IS_Readonly NOT_Readonly parseOptional options: CreateOptionsReadonly transformDeletes a cursor from an index.
The index name that contains the cursor
The cursor ID to delete
Readonly IS_Readonly NOT_Readonly parseReadonly transformReads from an existing cursor to get more results from an index.
The index name that contains the cursor
The cursor ID to read from
Optional parameters:
Readonly IS_Readonly NOT_Readonly parseOptional options: FtCursorReadOptionsReadonly transformReadonly 2: ((reply, preserve?, typeMapping?) => AggregateWithCursorReply)Optional preserve: anyOptional typeMapping: TypeMappingReadonly 3: ((reply, preserve?, typeMapping?) => AggregateWithCursorReply)Optional preserve: anyOptional typeMapping: TypeMappingAdds terms to a dictionary.
Name of the dictionary to add terms to
One or more terms to add to the dictionary
Readonly IS_Readonly NOT_Readonly parseReadonly transformDeletes terms from a dictionary.
Name of the dictionary to remove terms from
One or more terms to delete from the dictionary
Readonly IS_Readonly NOT_Readonly parseReadonly transformReturns all terms in a dictionary.
Name of the dictionary to dump
Readonly IS_Readonly NOT_Readonly parseReadonly transformReadonly 2: (() => ArrayReply<BlobStringReply<string>>)Readonly 3: (() => SetReply<BlobStringReply<string>>)Deletes an index and all associated documents.
Name of the index to delete
Optional parameters:
Readonly IS_Readonly NOT_Readonly parseOptional options: FtDropIndexOptionsReadonly transformReadonly 2: (() => SimpleStringReply<"OK">)Readonly 3: (() => NumberReply<number>)Returns the execution plan for a complex query.
Name of the index to explain query against
The query string to explain
Optional parameters:
Readonly IS_Readonly NOT_Readonly parseOptional options: FtExplainOptionsReadonly transformReturns the execution plan for a complex query in a more verbose format than FT.EXPLAIN.
Name of the index to explain query against
The query string to explain
Optional parameters:
Readonly IS_Readonly NOT_Readonly parseOptional options: FtExplainCLIOptionsReadonly transformExperimental hybrid: { Performs a hybrid search combining multiple search expressions. Supports multiple SEARCH and VECTOR expressions with various fusion methods.
NOTE: FT.Hybrid is still in experimental state It's behaviour and function signature may change
The index name to search
Hybrid search options including:
Readonly IS_Readonly NOT_Readonly parseReadonly transformReadonly 2: ((reply, _preserve?, _typeMapping?) => HybridSearchResult)Optional _preserve: anyOptional _typeMapping: TypeMappingReadonly 3: ((reply, _preserve?, _typeMapping?) => HybridSearchResult)Optional _preserve: anyOptional _typeMapping: TypeMappingReturns information and statistics about an index.
Name of the index to get information about
Readonly IS_Readonly NOT_Readonly parseReadonly transformProfiles the execution of an aggregation query for performance analysis.
Name of the index to profile query against
The aggregation query to profile
Optional parameters:
Readonly IS_Readonly NOT_Readonly parseOptional options: ProfileOptions & FtAggregateOptionsReadonly transformReadonly 2: ((reply, preserve?, typeMapping?) => ProfileReplyResp2)Optional preserve: anyOptional typeMapping: TypeMappingReadonly 3: ((reply, preserve?, typeMapping?) => ProfileReplyResp2)Optional preserve: anyOptional typeMapping: TypeMappingProfiles the execution of a search query for performance analysis.
Name of the index to profile query against
The search query to profile
Optional parameters:
Readonly IS_Readonly NOT_Readonly parseOptional options: ProfileOptions & FtSearchOptionsReadonly transformReadonly 2: ((reply, preserve?, typeMapping?) => ProfileReplyResp2)Optional preserve: anyOptional typeMapping: TypeMappingReadonly 3: ((reply, preserve?, typeMapping?) => ProfileReplyResp2)Optional preserve: anyOptional typeMapping: TypeMappingSearches a RediSearch index with the given query.
The index name to search
The text query to search. For syntax, see https://redis.io/docs/stack/search/reference/query_syntax
Optional search parameters including:
Readonly IS_Readonly NOT_Readonly parseOptional options: FtSearchOptionsReadonly transformReadonly 2: ((reply, _preserve?, _typeMapping?) => SearchReply)Optional _preserve: anyOptional _typeMapping: TypeMappingReadonly 3: ((rawReply, preserve?, typeMapping?) => SearchReply)Optional preserve: anyOptional typeMapping: TypeMappingPerforms a search query but returns only document ids without their contents.
Same parameters as FT.SEARCH:
Readonly IS_Readonly NOT_Readonly parseOptional options: FtSearchOptionsReadonly transformReadonly 2: ((reply) => SearchNoContentReply)Readonly 3: ((reply, preserve?, typeMapping?) => SearchNoContentReply)Optional preserve: anyOptional typeMapping: TypeMappingPerforms spelling correction on a search query.
Name of the index to use for spelling corrections
The search query to check for spelling
Optional parameters:
Readonly IS_Readonly NOT_Readonly parseOptional options: FtSpellCheckOptionsReadonly transformReadonly 2: ((rawReply) => { Readonly 3: ((rawReply) => { Adds a suggestion string to an auto-complete suggestion dictionary.
The suggestion dictionary key
The suggestion string to add
The suggestion score used for sorting
Optional parameters:
Readonly IS_Readonly parseOptional options: FtSugAddOptionsReadonly transformDeletes a string from a suggestion dictionary.
The suggestion dictionary key
The suggestion string to delete
Readonly IS_Readonly parseReadonly transformGets completion suggestions for a prefix from a suggestion dictionary.
The suggestion dictionary key
The prefix to get completion suggestions for
Optional parameters:
Readonly IS_Readonly parseOptional options: FtSugGetOptionsReadonly transformGets completion suggestions with their payloads from a suggestion dictionary.
Same parameters as FT.SUGGET:
Readonly IS_Readonly parseOptional options: FtSugGetOptionsReadonly transformGets completion suggestions with their scores from a suggestion dictionary.
Same parameters as FT.SUGGET:
Readonly IS_Readonly parseOptional options: FtSugGetOptionsReadonly transformReadonly 2: ((reply, preserve?, typeMapping?) => null | { Optional preserve: unknownOptional typeMapping: TypeMappingReadonly 3: ((reply) => null | { Gets completion suggestions with their scores and payloads from a suggestion dictionary.
Same parameters as FT.SUGGET:
Readonly IS_Readonly parseOptional options: FtSugGetOptionsReadonly transformReadonly 2: ((reply, preserve?, typeMapping?) => null | { Optional preserve: unknownOptional typeMapping: TypeMappingReadonly 3: ((reply) => null | { Gets the size of a suggestion dictionary.
The suggestion dictionary key
Readonly IS_Readonly parseReadonly transformDumps the contents of a synonym group.
Name of the index that contains the synonym group
Readonly IS_Readonly NOT_Readonly parseReadonly transformReadonly 2: ((reply) => Record<string, ArrayReply<BlobStringReply<string>>>)Readonly 3: (() => MapReply<BlobStringReply<string>, ArrayReply<BlobStringReply<string>>>)Updates a synonym group with new terms.
Name of the index that contains the synonym group
ID of the synonym group to update
One or more synonym terms to add to the group
Optional parameters:
Readonly IS_Readonly NOT_Readonly parseOptional options: FtSynUpdateOptionsReadonly transformReturns the distinct values in a TAG field.
Name of the index
Name of the TAG field to get values from
Readonly IS_Readonly NOT_Readonly parseReadonly transformReadonly 2: (() => ArrayReply<BlobStringReply<string>>)Readonly 3: (() => SetReply<BlobStringReply<string>>)Appends one or more values to the end of an array in a JSON document. Returns the new array length after append, or null if the path does not exist.
The key to append to
Path to the array in the JSON document
The first value to append
Additional values to append
Readonly IS_Readonly parseRest ...jsons: RedisJSON[]Readonly transformReturns the index of the first occurrence of a value in a JSON array. If the specified value is not found, it returns -1, or null if the path does not exist.
The key containing the array
Path to the array in the JSON document
The value to search for
Optional range parameters for the search
Starting index for the search
Optional ending index for the search
Readonly IS_Readonly parseOptional options: JsonArrIndexOptionsReadonly transformInserts one or more values into an array at the specified index. Returns the new array length after insert, or null if the path does not exist.
The key containing the array
Path to the array in the JSON document
The position where to insert the values
The first value to insert
Additional values to insert
Readonly IS_Readonly parseRest ...jsons: RedisJSON[]Readonly transformReturns the length of an array in a JSON document. Returns null if the path does not exist or the value is not an array.
The key containing the array
Optional parameters
Path to the array in the JSON document
Readonly IS_Readonly parseOptional options: JsonArrLenOptionsReadonly transformRemoves and returns an element from an array in a JSON document. Returns null if the path does not exist or the value is not an array.
The key containing the array
Optional parameters
Path to the array in the JSON document
Optional index to pop from. Default is -1 (last element)
Readonly IS_Readonly parseOptional options: RedisArrPopOptionsReadonly transformTrims an array in a JSON document to include only elements within the specified range. Returns the new array length after trimming, or null if the path does not exist.
The key containing the array
Path to the array in the JSON document
Starting index (inclusive)
Ending index (inclusive)
Readonly IS_Readonly parseReadonly transformClears container values (arrays/objects) in a JSON document. Returns the number of values cleared (0 or 1), or null if the path does not exist.
The key containing the JSON document
Optional parameters
Path to the container to clear
Readonly IS_Readonly parseOptional options: JsonClearOptionsReadonly transformReports memory usage details for a JSON document value. Returns size in bytes of the value, or null if the key or path does not exist.
The key containing the JSON document
Optional parameters
Path to the value to examine
Readonly IS_Readonly parseOptional options: JsonDebugMemoryOptionsReadonly transformDeletes a value from a JSON document. Returns the number of paths deleted (0 or 1), or null if the key does not exist.
The key containing the JSON document
Optional parameters
Path to the value to delete
Readonly IS_Readonly parseOptional options: JsonDelOptionsReadonly transformAlias for JSON.DEL - Deletes a value from a JSON document. Returns the number of paths deleted (0 or 1), or null if the key does not exist.
The key containing the JSON document
Optional parameters
Path to the value to delete
Readonly IS_Readonly parseOptional options: JsonForgetOptionsReadonly transformGets values from a JSON document. Returns the value at the specified path, or null if the key or path does not exist.
The key containing the JSON document
Optional parameters
Path(s) to the value(s) to retrieve
Readonly IS_Readonly parseOptional options: JsonGetOptionsReadonly transformMerges a given JSON value into a JSON document. Returns OK on success, or null if the key does not exist.
The key containing the JSON document
Path to merge into
JSON value to merge
Readonly IS_Readonly parseReadonly transformGets values at a specific path from multiple JSON documents. Returns an array of values at the path from each key, null for missing keys/paths.
Array of keys containing JSON documents
Path to retrieve from each document
Readonly IS_Readonly parseReadonly transformSets multiple JSON values in multiple documents. Returns OK on success.
Array of objects containing key, path, and value to set
The key containing the JSON document
Path in the document to set
JSON value to set at the path
Readonly IS_Readonly parseReadonly transformIncrements a numeric value stored in a JSON document by a given number. Returns the value after increment, or null if the key/path doesn't exist or value is not numeric.
The key containing the JSON document
Path to the numeric value
Amount to increment by
Readonly IS_Readonly parseReadonly transformReadonly 2: ((reply) => number | (null | number)[])Readonly 3: (() => ArrayReply<NullReply | NumberReply<number> | DoubleReply<number>>)Multiplies a numeric value stored in a JSON document by a given number. Returns the value after multiplication, or null if the key/path doesn't exist or value is not numeric.
The key containing the JSON document
Path to the numeric value
Amount to multiply by
Readonly IS_Readonly parseReadonly transformReadonly 2: ((reply) => number | (null | number)[])Readonly 3: (() => ArrayReply<NullReply | NumberReply<number> | DoubleReply<number>>)Returns the keys in the object stored in a JSON document. Returns array of keys, array of arrays for multiple paths, or null if path doesn't exist.
The key containing the JSON document
Optional parameters
Path to the object to examine
Readonly IS_Readonly parseOptional options: JsonObjKeysOptionsReadonly transformReturns the number of keys in the object stored in a JSON document. Returns length of object, array of lengths for multiple paths, or null if path doesn't exist.
The key containing the JSON document
Optional parameters
Path to the object to examine
Readonly IS_Readonly parseOptional options: JsonObjLenOptionsReadonly transformSets a JSON value at a specific path in a JSON document. Returns OK on success, or null if condition (NX/XX) is not met.
The key containing the JSON document
Path in the document to set
JSON value to set at the path
Optional parameters
Set condition: NX (only if doesn't exist) or XX (only if exists)
options.NX - Use options.condition instead
options.XX - Use options.condition instead
Readonly IS_Readonly parseOptional options: JsonSetOptionsReadonly transformAppends a string to a string value stored in a JSON document. Returns new string length after append, or null if the path doesn't exist or value is not a string.
The key containing the JSON document
String to append
Optional parameters
Path to the string value
Readonly IS_Readonly parseOptional options: JsonStrAppendOptionsReadonly transformReturns the length of a string value stored in a JSON document. Returns string length, array of lengths for multiple paths, or null if path doesn't exist.
The key containing the JSON document
Optional parameters
Path to the string value
Readonly IS_Readonly parseOptional options: JsonStrLenOptionsReadonly transformToggles a boolean value stored in a JSON document. Returns 1 if value was toggled to true, 0 if toggled to false, or null if path doesn't exist.
The key containing the JSON document
Path to the boolean value
Readonly IS_Readonly parseReadonly transformReturns the type of JSON value at a specific path in a JSON document. Returns the type as a string, array of types for multiple paths, or null if path doesn't exist.
The key containing the JSON document
Optional parameters
Path to examine
Readonly IS_Readonly parseOptional options: JsonTypeOptionsReadonly transformReadonly 2: (() => NullReply | BlobStringReply<string> | ArrayReply<NullReply | BlobStringReply<string>>)Readonly 3: ((reply) => NullReply | BlobStringReply<string> | ArrayReply<NullReply | BlobStringReply<string>>)Appends one or more values to the end of an array in a JSON document. Returns the new array length after append, or null if the path does not exist.
The key to append to
Path to the array in the JSON document
The first value to append
Additional values to append
Readonly IS_Readonly parseRest ...jsons: RedisJSON[]Readonly transformReturns the index of the first occurrence of a value in a JSON array. If the specified value is not found, it returns -1, or null if the path does not exist.
The key containing the array
Path to the array in the JSON document
The value to search for
Optional range parameters for the search
Starting index for the search
Optional ending index for the search
Readonly IS_Readonly parseOptional options: JsonArrIndexOptionsReadonly transformInserts one or more values into an array at the specified index. Returns the new array length after insert, or null if the path does not exist.
The key containing the array
Path to the array in the JSON document
The position where to insert the values
The first value to insert
Additional values to insert
Readonly IS_Readonly parseRest ...jsons: RedisJSON[]Readonly transformReturns the length of an array in a JSON document. Returns null if the path does not exist or the value is not an array.
The key containing the array
Optional parameters
Path to the array in the JSON document
Readonly IS_Readonly parseOptional options: JsonArrLenOptionsReadonly transformRemoves and returns an element from an array in a JSON document. Returns null if the path does not exist or the value is not an array.
The key containing the array
Optional parameters
Path to the array in the JSON document
Optional index to pop from. Default is -1 (last element)
Readonly IS_Readonly parseOptional options: RedisArrPopOptionsReadonly transformTrims an array in a JSON document to include only elements within the specified range. Returns the new array length after trimming, or null if the path does not exist.
The key containing the array
Path to the array in the JSON document
Starting index (inclusive)
Ending index (inclusive)
Readonly IS_Readonly parseReadonly transformClears container values (arrays/objects) in a JSON document. Returns the number of values cleared (0 or 1), or null if the path does not exist.
The key containing the JSON document
Optional parameters
Path to the container to clear
Readonly IS_Readonly parseOptional options: JsonClearOptionsReadonly transformReports memory usage details for a JSON document value. Returns size in bytes of the value, or null if the key or path does not exist.
The key containing the JSON document
Optional parameters
Path to the value to examine
Readonly IS_Readonly parseOptional options: JsonDebugMemoryOptionsReadonly transformDeletes a value from a JSON document. Returns the number of paths deleted (0 or 1), or null if the key does not exist.
The key containing the JSON document
Optional parameters
Path to the value to delete
Readonly IS_Readonly parseOptional options: JsonDelOptionsReadonly transformAlias for JSON.DEL - Deletes a value from a JSON document. Returns the number of paths deleted (0 or 1), or null if the key does not exist.
The key containing the JSON document
Optional parameters
Path to the value to delete
Readonly IS_Readonly parseOptional options: JsonForgetOptionsReadonly transformGets values from a JSON document. Returns the value at the specified path, or null if the key or path does not exist.
The key containing the JSON document
Optional parameters
Path(s) to the value(s) to retrieve
Readonly IS_Readonly parseOptional options: JsonGetOptionsReadonly transformGets values at a specific path from multiple JSON documents. Returns an array of values at the path from each key, null for missing keys/paths.
Array of keys containing JSON documents
Path to retrieve from each document
Readonly IS_Readonly parseReadonly transformSets multiple JSON values in multiple documents. Returns OK on success.
Array of objects containing key, path, and value to set
The key containing the JSON document
Path in the document to set
JSON value to set at the path
Readonly IS_Readonly parseReadonly transformMerges a given JSON value into a JSON document. Returns OK on success, or null if the key does not exist.
The key containing the JSON document
Path to merge into
JSON value to merge
Readonly IS_Readonly parseReadonly transformIncrements a numeric value stored in a JSON document by a given number. Returns the value after increment, or null if the key/path doesn't exist or value is not numeric.
The key containing the JSON document
Path to the numeric value
Amount to increment by
Readonly IS_Readonly parseReadonly transformReadonly 2: ((reply) => number | (null | number)[])Readonly 3: (() => ArrayReply<NullReply | NumberReply<number> | DoubleReply<number>>)Multiplies a numeric value stored in a JSON document by a given number. Returns the value after multiplication, or null if the key/path doesn't exist or value is not numeric.
The key containing the JSON document
Path to the numeric value
Amount to multiply by
Readonly IS_Readonly parseReadonly transformReadonly 2: ((reply) => number | (null | number)[])Readonly 3: (() => ArrayReply<NullReply | NumberReply<number> | DoubleReply<number>>)Returns the keys in the object stored in a JSON document. Returns array of keys, array of arrays for multiple paths, or null if path doesn't exist.
The key containing the JSON document
Optional parameters
Path to the object to examine
Readonly IS_Readonly parseOptional options: JsonObjKeysOptionsReadonly transformReturns the number of keys in the object stored in a JSON document. Returns length of object, array of lengths for multiple paths, or null if path doesn't exist.
The key containing the JSON document
Optional parameters
Path to the object to examine
Readonly IS_Readonly parseOptional options: JsonObjLenOptionsReadonly transformSets a JSON value at a specific path in a JSON document. Returns OK on success, or null if condition (NX/XX) is not met.
The key containing the JSON document
Path in the document to set
JSON value to set at the path
Optional parameters
Set condition: NX (only if doesn't exist) or XX (only if exists)
options.NX - Use options.condition instead
options.XX - Use options.condition instead
Readonly IS_Readonly parseOptional options: JsonSetOptionsReadonly transformAppends a string to a string value stored in a JSON document. Returns new string length after append, or null if the path doesn't exist or value is not a string.
The key containing the JSON document
String to append
Optional parameters
Path to the string value
Readonly IS_Readonly parseOptional options: JsonStrAppendOptionsReadonly transformReturns the length of a string value stored in a JSON document. Returns string length, array of lengths for multiple paths, or null if path doesn't exist.
The key containing the JSON document
Optional parameters
Path to the string value
Readonly IS_Readonly parseOptional options: JsonStrLenOptionsReadonly transformToggles a boolean value stored in a JSON document. Returns 1 if value was toggled to true, 0 if toggled to false, or null if path doesn't exist.
The key containing the JSON document
Path to the boolean value
Readonly IS_Readonly parseReadonly transformReturns the type of JSON value at a specific path in a JSON document. Returns the type as a string, array of types for multiple paths, or null if path doesn't exist.
The key containing the JSON document
Optional parameters
Path to examine
Readonly IS_Readonly parseOptional options: JsonTypeOptionsReadonly transformReadonly 2: (() => NullReply | BlobStringReply<string> | ArrayReply<NullReply | BlobStringReply<string>>)Readonly 3: ((reply) => NullReply | BlobStringReply<string> | ArrayReply<NullReply | BlobStringReply<string>>)Readonly tReadonly ADD: { Readonly IS_Readonly parseReadonly transformReadonly BYRANK: { Readonly IS_Readonly parseReadonly transformOptional preserve: anyOptional typeMapping: TypeMappingReadonly BYREVRANK: { Readonly IS_Readonly parseReadonly transformOptional preserve: anyOptional typeMapping: TypeMappingReadonly CDF: { Readonly IS_Readonly parseReadonly transformOptional preserve: anyOptional typeMapping: TypeMappingReadonly CREATE: { Readonly IS_Readonly parseOptional options: TDigestCreateOptionsReadonly transformReadonly INFO: { Readonly IS_Readonly parseReadonly transformReadonly 2: ((this, reply, _, typeMapping?) => TdInfoReplyMap)Optional typeMapping: TypeMappingReadonly 3: (() => TdInfoReplyMap)Readonly MAX: { Readonly IS_Readonly parseReadonly transformOptional preserve: anyOptional typeMapping: TypeMappingReadonly MERGE: { Readonly IS_Readonly parseOptional options: TDigestMergeOptionsReadonly transformReadonly MIN: { Readonly IS_Readonly parseReadonly transformOptional preserve: anyOptional typeMapping: TypeMappingReadonly QUANTILE: { Readonly IS_Readonly parseReadonly transformOptional preserve: anyOptional typeMapping: TypeMappingReadonly RANK: { Readonly IS_Readonly parseReadonly transformReadonly RESET: { Readonly IS_Readonly parseReadonly transformReadonly REVRANK: { Readonly IS_Readonly parseReadonly transformReadonly TRIMMED_Readonly IS_Readonly parseReadonly transformOptional preserve: anyOptional typeMapping: TypeMappingReadonly add: { Readonly IS_Readonly parseReadonly transformReadonly byReadonly IS_Readonly parseReadonly transformOptional preserve: anyOptional typeMapping: TypeMappingReadonly byReadonly IS_Readonly parseReadonly transformOptional preserve: anyOptional typeMapping: TypeMappingReadonly cdf: { Readonly IS_Readonly parseReadonly transformOptional preserve: anyOptional typeMapping: TypeMappingReadonly create: { Readonly IS_Readonly parseOptional options: TDigestCreateOptionsReadonly transformReadonly info: { Readonly IS_Readonly parseReadonly transformReadonly 2: ((this, reply, _, typeMapping?) => TdInfoReplyMap)Optional typeMapping: TypeMappingReadonly 3: (() => TdInfoReplyMap)Readonly max: { Readonly IS_Readonly parseReadonly transformOptional preserve: anyOptional typeMapping: TypeMappingReadonly merge: { Readonly IS_Readonly parseOptional options: TDigestMergeOptionsReadonly transformReadonly min: { Readonly IS_Readonly parseReadonly transformOptional preserve: anyOptional typeMapping: TypeMappingReadonly quantile: { Readonly IS_Readonly parseReadonly transformOptional preserve: anyOptional typeMapping: TypeMappingReadonly rank: { Readonly IS_Readonly parseReadonly transformReadonly reset: { Readonly IS_Readonly parseReadonly transformReadonly revReadonly IS_Readonly parseReadonly transformReadonly trimmedReadonly IS_Readonly parseReadonly transformOptional preserve: anyOptional typeMapping: TypeMappingReadonly topKReadonly ADD: { Readonly IS_Readonly parseReadonly transformReadonly COUNT: { Readonly IS_Readonly parseReadonly transformReadonly INCRBY: { Readonly IS_Readonly parseReadonly transformReadonly INFO: { Readonly IS_Readonly parseReadonly transformReadonly 2: ((reply, preserve?, typeMapping?) => TopKInfoReplyMap)Optional preserve: unknownOptional typeMapping: TypeMappingReadonly 3: (() => TopKInfoReplyMap)Readonly LIST: { Readonly IS_Readonly parseReadonly transformReadonly LIST_Readonly IS_Readonly parseReadonly transformReadonly QUERY: { Readonly IS_Readonly parseReadonly transformReadonly RESERVE: { Readonly IS_Readonly parseOptional options: TopKReserveOptionsReadonly transformReadonly add: { Readonly IS_Readonly parseReadonly transformReadonly count: { Readonly IS_Readonly parseReadonly transformReadonly incrReadonly IS_Readonly parseReadonly transformReadonly info: { Readonly IS_Readonly parseReadonly transformReadonly 2: ((reply, preserve?, typeMapping?) => TopKInfoReplyMap)Optional preserve: unknownOptional typeMapping: TypeMappingReadonly 3: (() => TopKInfoReplyMap)Readonly list: { Readonly IS_Readonly parseReadonly transformReadonly listReadonly IS_Readonly parseReadonly transformReadonly query: { Readonly IS_Readonly parseReadonly transformReadonly reserve: { Readonly IS_Readonly parseOptional options: TopKReserveOptionsReadonly transformReadonly ADD: { Creates or appends a sample to a time series
The key name for the time series
The timestamp of the sample
The value of the sample
Optional configuration parameters
Readonly IS_Readonly parseOptional options: TsAddOptionsReadonly transformReadonly ALTER: { Alters the configuration of an existing time series
The key name for the time series
Configuration parameters to alter
Readonly IS_Readonly parseOptional options: TsAlterOptionsReadonly transformReadonly CREATE: { Creates a new time series
The key name for the new time series
Optional configuration parameters
Readonly IS_Readonly parseOptional options: TsCreateOptionsReadonly transformReadonly CREATERULE: { Creates a compaction rule from source time series to destination time series
The source time series key
The destination time series key
The aggregation type to use
The duration of each bucket in milliseconds
Optional timestamp for alignment
Readonly IS_Readonly parseOptional alignTimestamp: numberReadonly transformReadonly DECRBY: { Decreases the value of a time series by a given amount
Arguments passed to the parseIncrByArguments function
Readonly IS_Readonly parseOptional options: TsIncrByOptionsReadonly transformReadonly DEL: { Deletes samples between two timestamps from a time series
The key name of the time series
Start timestamp to delete from
End timestamp to delete until
Readonly IS_Readonly parseReadonly transformReadonly DELETERULE: { Deletes a compaction rule between source and destination time series
The source time series key
The destination time series key
Readonly IS_Readonly parseReadonly transformReadonly GET: { Gets the last sample of a time series
The key name of the time series
Optional parameters for the command
Readonly IS_Readonly parseOptional options: TsGetOptionsReadonly transformReadonly 2: ((this, reply) => null | { Readonly 3: ((this, reply) => null | { Readonly INCRBY: { Increases the value of a time series by a given amount
Arguments passed to the parseIncrByArguments function
Readonly IS_Readonly parseOptional options: TsIncrByOptionsReadonly transformReadonly INFO: { Gets information about a time series
The key name of the time series
Readonly IS_Readonly parseReadonly transformReadonly 2: ((reply, _, typeMapping?) => InfoReply)Optional typeMapping: TypeMappingReadonly 3: ((reply, preserve?, typeMapping?) => InfoReply)Optional preserve: unknownOptional typeMapping: TypeMappingReadonly INFO_Gets debug information about a time series
The key name of the time series
Readonly IS_Readonly parseReadonly transformReadonly 2: ((this, reply, _, typeMapping?) => InfoDebugReply)Optional typeMapping: TypeMappingReadonly 3: ((reply, preserve?, typeMapping?) => InfoDebugReply)Optional preserve: unknownOptional typeMapping: TypeMappingReadonly MADD: { Adds multiple samples to multiple time series
Array of samples to add to different time series
Readonly IS_Readonly parseReadonly transformReadonly MGET: { Gets the last samples matching a specific filter from multiple time series
Filter to match time series keys
Optional parameters for the command
Readonly IS_Readonly NOT_Readonly parseOptional options: TsMGetOptionsReadonly transformReadonly 2: ((this, reply, _, typeMapping?) => MapReply<BlobStringReply<string>, { Optional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly MGET_Gets the last samples matching a specific filter with selected labels
Filter to match time series keys
Labels to include in the output
Optional parameters for the command
Readonly IS_Readonly parseOptional options: TsMGetOptionsReadonly transformOptional typeMapping: TypeMappingReadonly MGET_Gets the last samples matching a specific filter with labels
Filter to match time series keys
Optional parameters for the command
Readonly IS_Readonly parseOptional options: TsMGetWithLabelsOptionsReadonly transformOptional typeMapping: TypeMappingReadonly MRANGE: { Gets samples for time series matching a specific filter within a time range
Start timestamp for range
End timestamp for range
Filter to match time series keys
Optional parameters for the command
Readonly IS_Readonly NOT_Readonly parseOptional options: TsRangeOptionsReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly MRANGE_Gets samples for time series matching a filter within a time range with grouping
Start timestamp for range
End timestamp for range
Filter to match time series keys
Group by parameters
Optional parameters for the command
Readonly IS_Readonly parseOptional options: TsRangeOptionsReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly MRANGE_Gets multi-aggregation samples for time series matching a specific filter within a time range
Start timestamp for range
End timestamp for range
Filter to match time series keys
Optional parameters for the command
Readonly IS_Readonly NOT_Readonly parseReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly MRANGE_Gets samples for time series matching a filter with selected labels
Start timestamp for range
End timestamp for range
Labels to include in the output
Filter to match time series keys
Optional parameters for the command
Readonly IS_Readonly parseOptional options: TsRangeOptionsReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly MRANGE_Gets samples for time series matching a filter with selected labels and grouping
Start timestamp for range
End timestamp for range
Labels to include in the output
Filter to match time series keys
Group by parameters
Optional parameters for the command
Readonly IS_Readonly parseOptional options: TsRangeOptionsReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly MRANGE_Gets multi-aggregation samples for time series matching a filter with selected labels
Start timestamp for range
End timestamp for range
Labels to include in the output
Filter to match time series keys
Optional parameters for the command
Readonly IS_Readonly NOT_Readonly parseReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly MRANGE_Gets samples for time series matching a filter with labels
Start timestamp for range
End timestamp for range
Filter to match time series keys
Optional parameters for the command
Readonly IS_Readonly NOT_Readonly parseOptional options: TsRangeOptionsReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly MRANGE_Gets samples for time series matching a filter with labels and grouping
Start timestamp for range
End timestamp for range
Filter to match time series keys
Group by parameters
Optional parameters for the command
Readonly IS_Readonly parseOptional options: TsRangeOptionsReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly MRANGE_Gets multi-aggregation samples for time series matching a filter with labels
Start timestamp for range
End timestamp for range
Filter to match time series keys
Optional parameters for the command
Readonly IS_Readonly NOT_Readonly parseReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly MREVRANGE: { Gets samples for time series matching a specific filter within a time range (in reverse order)
Start timestamp for range
End timestamp for range
Filter to match time series keys
Optional parameters for the command
Readonly IS_Readonly NOT_Readonly parseOptional options: TsRangeOptionsReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly MREVRANGE_Gets samples for time series matching a filter within a time range with grouping (in reverse order)
Start timestamp for range
End timestamp for range
Filter to match time series keys
Group by parameters
Optional parameters for the command
Readonly IS_Readonly parseOptional options: TsRangeOptionsReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly MREVRANGE_Gets multi-aggregation samples for time series matching a specific filter within a time range (in reverse order)
Start timestamp for range
End timestamp for range
Filter to match time series keys
Optional parameters for the command
Readonly IS_Readonly NOT_Readonly parseReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly MREVRANGE_Gets samples for time series matching a filter with selected labels (in reverse order)
Start timestamp for range
End timestamp for range
Labels to include in the output
Filter to match time series keys
Optional parameters for the command
Readonly IS_Readonly parseOptional options: TsRangeOptionsReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly MREVRANGE_Gets samples for time series matching a filter with selected labels and grouping (in reverse order)
Start timestamp for range
End timestamp for range
Labels to include in the output
Filter to match time series keys
Group by parameters
Optional parameters for the command
Readonly IS_Readonly parseOptional options: TsRangeOptionsReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly MREVRANGE_Gets multi-aggregation samples for time series matching a filter with selected labels (in reverse order)
Start timestamp for range
End timestamp for range
Labels to include in the output
Filter to match time series keys
Optional parameters for the command
Readonly IS_Readonly NOT_Readonly parseReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly MREVRANGE_Gets samples for time series matching a filter with labels (in reverse order)
Start timestamp for range
End timestamp for range
Filter to match time series keys
Optional parameters for the command
Readonly IS_Readonly NOT_Readonly parseOptional options: TsRangeOptionsReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly MREVRANGE_Gets samples for time series matching a filter with labels and grouping (in reverse order)
Start timestamp for range
End timestamp for range
Filter to match time series keys
Group by parameters
Optional parameters for the command
Readonly IS_Readonly parseOptional options: TsRangeOptionsReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly MREVRANGE_Gets multi-aggregation samples for time series matching a filter with labels (in reverse order)
Start timestamp for range
End timestamp for range
Filter to match time series keys
Optional parameters for the command
Readonly IS_Readonly NOT_Readonly parseReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly QUERYINDEX: { Queries the index for time series matching a specific filter
Filter to match time series labels
Readonly IS_Readonly NOT_Readonly parseReadonly transformReadonly 2: (() => ArrayReply<BlobStringReply<string>>)Readonly 3: (() => SetReply<BlobStringReply<string>>)Readonly RANGE: { Gets samples from a time series within a time range
Arguments passed to the transformRangeArguments function
Readonly IS_Readonly parseOptional options: TsRangeOptionsReadonly transformReadonly 2: ((this, reply) => { Readonly 3: ((this, reply) => { Readonly RANGE_Gets multi-aggregation samples from a time series within a time range
Arguments passed to the transformRangeMultiArguments function
Readonly IS_Readonly parseReadonly transformReadonly 2: ((this, reply) => { Readonly 3: ((this, reply) => { Readonly REVRANGE: { Gets samples from a time series within a time range (in reverse order)
Arguments passed to the transformRangeArguments function
Readonly IS_Readonly parseOptional options: TsRangeOptionsReadonly transformReadonly 2: ((this, reply) => { Readonly 3: ((this, reply) => { Readonly REVRANGE_Gets multi-aggregation samples from a time series within a time range (in reverse order)
Arguments passed to the transformRangeMultiArguments function
Readonly IS_Readonly parseReadonly transformReadonly 2: ((this, reply) => { Readonly 3: ((this, reply) => { Readonly add: { Creates or appends a sample to a time series
The key name for the time series
The timestamp of the sample
The value of the sample
Optional configuration parameters
Readonly IS_Readonly parseOptional options: TsAddOptionsReadonly transformReadonly alter: { Alters the configuration of an existing time series
The key name for the time series
Configuration parameters to alter
Readonly IS_Readonly parseOptional options: TsAlterOptionsReadonly transformReadonly create: { Creates a new time series
The key name for the new time series
Optional configuration parameters
Readonly IS_Readonly parseOptional options: TsCreateOptionsReadonly transformReadonly createCreates a compaction rule from source time series to destination time series
The source time series key
The destination time series key
The aggregation type to use
The duration of each bucket in milliseconds
Optional timestamp for alignment
Readonly IS_Readonly parseOptional alignTimestamp: numberReadonly transformReadonly decrDecreases the value of a time series by a given amount
Arguments passed to the parseIncrByArguments function
Readonly IS_Readonly parseOptional options: TsIncrByOptionsReadonly transformReadonly del: { Deletes samples between two timestamps from a time series
The key name of the time series
Start timestamp to delete from
End timestamp to delete until
Readonly IS_Readonly parseReadonly transformReadonly deleteDeletes a compaction rule between source and destination time series
The source time series key
The destination time series key
Readonly IS_Readonly parseReadonly transformReadonly get: { Gets the last sample of a time series
The key name of the time series
Optional parameters for the command
Readonly IS_Readonly parseOptional options: TsGetOptionsReadonly transformReadonly 2: ((this, reply) => null | { Readonly 3: ((this, reply) => null | { Readonly incrIncreases the value of a time series by a given amount
Arguments passed to the parseIncrByArguments function
Readonly IS_Readonly parseOptional options: TsIncrByOptionsReadonly transformReadonly info: { Gets information about a time series
The key name of the time series
Readonly IS_Readonly parseReadonly transformReadonly 2: ((reply, _, typeMapping?) => InfoReply)Optional typeMapping: TypeMappingReadonly 3: ((reply, preserve?, typeMapping?) => InfoReply)Optional preserve: unknownOptional typeMapping: TypeMappingReadonly infoGets debug information about a time series
The key name of the time series
Readonly IS_Readonly parseReadonly transformReadonly 2: ((this, reply, _, typeMapping?) => InfoDebugReply)Optional typeMapping: TypeMappingReadonly 3: ((reply, preserve?, typeMapping?) => InfoDebugReply)Optional preserve: unknownOptional typeMapping: TypeMappingReadonly mAdds multiple samples to multiple time series
Array of samples to add to different time series
Readonly IS_Readonly parseReadonly transformReadonly mGets the last samples matching a specific filter from multiple time series
Filter to match time series keys
Optional parameters for the command
Readonly IS_Readonly NOT_Readonly parseOptional options: TsMGetOptionsReadonly transformReadonly 2: ((this, reply, _, typeMapping?) => MapReply<BlobStringReply<string>, { Optional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly mGets the last samples matching a specific filter with selected labels
Filter to match time series keys
Labels to include in the output
Optional parameters for the command
Readonly IS_Readonly parseOptional options: TsMGetOptionsReadonly transformOptional typeMapping: TypeMappingReadonly mGets the last samples matching a specific filter with labels
Filter to match time series keys
Optional parameters for the command
Readonly IS_Readonly parseOptional options: TsMGetWithLabelsOptionsReadonly transformOptional typeMapping: TypeMappingReadonly mGets samples for time series matching a specific filter within a time range
Start timestamp for range
End timestamp for range
Filter to match time series keys
Optional parameters for the command
Readonly IS_Readonly NOT_Readonly parseOptional options: TsRangeOptionsReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly mGets samples for time series matching a filter within a time range with grouping
Start timestamp for range
End timestamp for range
Filter to match time series keys
Group by parameters
Optional parameters for the command
Readonly IS_Readonly parseOptional options: TsRangeOptionsReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly mGets multi-aggregation samples for time series matching a specific filter within a time range
Start timestamp for range
End timestamp for range
Filter to match time series keys
Optional parameters for the command
Readonly IS_Readonly NOT_Readonly parseReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly mGets samples for time series matching a filter with selected labels
Start timestamp for range
End timestamp for range
Labels to include in the output
Filter to match time series keys
Optional parameters for the command
Readonly IS_Readonly parseOptional options: TsRangeOptionsReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly mGets samples for time series matching a filter with selected labels and grouping
Start timestamp for range
End timestamp for range
Labels to include in the output
Filter to match time series keys
Group by parameters
Optional parameters for the command
Readonly IS_Readonly parseOptional options: TsRangeOptionsReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly mGets multi-aggregation samples for time series matching a filter with selected labels
Start timestamp for range
End timestamp for range
Labels to include in the output
Filter to match time series keys
Optional parameters for the command
Readonly IS_Readonly NOT_Readonly parseReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly mGets samples for time series matching a filter with labels
Start timestamp for range
End timestamp for range
Filter to match time series keys
Optional parameters for the command
Readonly IS_Readonly NOT_Readonly parseOptional options: TsRangeOptionsReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly mGets samples for time series matching a filter with labels and grouping
Start timestamp for range
End timestamp for range
Filter to match time series keys
Group by parameters
Optional parameters for the command
Readonly IS_Readonly parseOptional options: TsRangeOptionsReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly mGets multi-aggregation samples for time series matching a filter with labels
Start timestamp for range
End timestamp for range
Filter to match time series keys
Optional parameters for the command
Readonly IS_Readonly NOT_Readonly parseReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly mGets samples for time series matching a specific filter within a time range (in reverse order)
Start timestamp for range
End timestamp for range
Filter to match time series keys
Optional parameters for the command
Readonly IS_Readonly NOT_Readonly parseOptional options: TsRangeOptionsReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly mGets samples for time series matching a filter within a time range with grouping (in reverse order)
Start timestamp for range
End timestamp for range
Filter to match time series keys
Group by parameters
Optional parameters for the command
Readonly IS_Readonly parseOptional options: TsRangeOptionsReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly mGets multi-aggregation samples for time series matching a specific filter within a time range (in reverse order)
Start timestamp for range
End timestamp for range
Filter to match time series keys
Optional parameters for the command
Readonly IS_Readonly NOT_Readonly parseReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly mGets samples for time series matching a filter with selected labels (in reverse order)
Start timestamp for range
End timestamp for range
Labels to include in the output
Filter to match time series keys
Optional parameters for the command
Readonly IS_Readonly parseOptional options: TsRangeOptionsReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly mGets samples for time series matching a filter with selected labels and grouping (in reverse order)
Start timestamp for range
End timestamp for range
Labels to include in the output
Filter to match time series keys
Group by parameters
Optional parameters for the command
Readonly IS_Readonly parseOptional options: TsRangeOptionsReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly mGets multi-aggregation samples for time series matching a filter with selected labels (in reverse order)
Start timestamp for range
End timestamp for range
Labels to include in the output
Filter to match time series keys
Optional parameters for the command
Readonly IS_Readonly NOT_Readonly parseReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly mGets samples for time series matching a filter with labels (in reverse order)
Start timestamp for range
End timestamp for range
Filter to match time series keys
Optional parameters for the command
Readonly IS_Readonly NOT_Readonly parseOptional options: TsRangeOptionsReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly mGets samples for time series matching a filter with labels and grouping (in reverse order)
Start timestamp for range
End timestamp for range
Filter to match time series keys
Group by parameters
Optional parameters for the command
Readonly IS_Readonly parseOptional options: TsRangeOptionsReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly mGets multi-aggregation samples for time series matching a filter with labels (in reverse order)
Start timestamp for range
End timestamp for range
Filter to match time series keys
Optional parameters for the command
Readonly IS_Readonly NOT_Readonly parseReadonly transformReadonly 2: ((this, reply, _?, typeMapping?) => MapReply<BlobStringReply<string>, { Optional _: unknownOptional typeMapping: TypeMappingReadonly 3: ((this, reply) => MapReply<BlobStringReply<string>, { Readonly queryQueries the index for time series matching a specific filter
Filter to match time series labels
Readonly IS_Readonly NOT_Readonly parseReadonly transformReadonly 2: (() => ArrayReply<BlobStringReply<string>>)Readonly 3: (() => SetReply<BlobStringReply<string>>)Readonly range: { Gets samples from a time series within a time range
Arguments passed to the transformRangeArguments function
Readonly IS_Readonly parseOptional options: TsRangeOptionsReadonly transformReadonly 2: ((this, reply) => { Readonly 3: ((this, reply) => { Readonly rangeGets multi-aggregation samples from a time series within a time range
Arguments passed to the transformRangeMultiArguments function
Readonly IS_Readonly parseReadonly transformReadonly 2: ((this, reply) => { Readonly 3: ((this, reply) => { Readonly revGets samples from a time series within a time range (in reverse order)
Arguments passed to the transformRangeArguments function
Readonly IS_Readonly parseOptional options: TsRangeOptionsReadonly transformReadonly 2: ((this, reply) => { Readonly 3: ((this, reply) => { Readonly revGets multi-aggregation samples from a time series within a time range (in reverse order)
Arguments passed to the transformRangeMultiArguments function
Readonly IS_Readonly parseReadonly transformReadonly 2: ((this, reply) => { Readonly 3: ((this, reply) => { Generated using TypeDoc
Performs an aggregation query on a RediSearch index.