From 1a42cc0deb869aa405284ab6330698b9ae045281 Mon Sep 17 00:00:00 2001 From: "redisdocsapp[bot]" <177626021+redisdocsapp[bot]@users.noreply.github.com> Date: Sun, 24 May 2026 07:11:37 +0000 Subject: [PATCH] Update content/commands/ --- content/commands/bitop.md | 19 +- content/commands/cluster-migration.md | 6 +- content/commands/cluster-slot-stats.md | 31 ++- content/commands/delex.md | 9 +- content/commands/digest.md | 2 +- content/commands/ft.aggregate.md | 301 +++++++++++++++++++++++-- content/commands/ft.aliasadd.md | 1 + content/commands/ft.aliasupdate.md | 1 + content/commands/ft.alter.md | 5 + content/commands/ft.config-get.md | 2 +- content/commands/ft.config-help.md | 2 + content/commands/ft.config-set.md | 2 +- content/commands/ft.create.md | 28 +-- content/commands/ft.cursor-del.md | 3 + content/commands/ft.cursor-read.md | 3 + content/commands/ft.dropindex.md | 1 + content/commands/ft.explain.md | 3 + content/commands/ft.explaincli.md | 3 + content/commands/ft.hybrid.md | 72 ++++-- content/commands/ft.info.md | 1 + content/commands/ft.profile.md | 3 + content/commands/ft.search.md | 44 +++- content/commands/ft.spellcheck.md | 3 + content/commands/ft.sugget.md | 3 + content/commands/ft.syndump.md | 1 + content/commands/ft.synupdate.md | 2 + content/commands/ft.tagvals.md | 1 + content/commands/hexpire.md | 1 - content/commands/hexpireat.md | 1 - content/commands/hotkeys-get.md | 10 +- content/commands/hotkeys-reset.md | 2 + content/commands/hotkeys-start.md | 5 +- content/commands/hotkeys-stop.md | 2 + content/commands/hpexpire.md | 1 - content/commands/hpexpireat.md | 1 - content/commands/hpttl.md | 2 + content/commands/httl.md | 2 + content/commands/json.arrappend.md | 3 +- content/commands/json.objkeys.md | 5 +- content/commands/json.objlen.md | 5 +- content/commands/json.strappend.md | 2 +- content/commands/json.strlen.md | 5 +- content/commands/msetex.md | 3 +- content/commands/set.md | 6 +- content/commands/tdigest.byrank.md | 2 +- content/commands/tdigest.byrevrank.md | 2 +- content/commands/tdigest.quantile.md | 2 +- content/commands/tdigest.rank.md | 2 +- content/commands/tdigest.revrank.md | 2 +- content/commands/topk.add.md | 3 +- content/commands/topk.list.md | 4 +- content/commands/topk.reserve.md | 2 +- content/commands/ts.alter.md | 3 +- content/commands/ts.create.md | 9 - content/commands/ts.createrule.md | 8 +- content/commands/ts.decrby.md | 32 --- content/commands/ts.incrby.md | 32 --- content/commands/ts.mget.md | 2 +- content/commands/ts.mrange.md | 16 +- content/commands/ts.mrevrange.md | 21 +- content/commands/ts.queryindex.md | 2 +- content/commands/ts.range.md | 10 +- content/commands/ts.revrange.md | 34 ++- content/commands/vadd.md | 100 +++++++- content/commands/vcard.md | 31 ++- content/commands/vdim.md | 31 ++- content/commands/vemb.md | 39 +++- content/commands/vgetattr.md | 34 ++- content/commands/vinfo.md | 31 ++- content/commands/vismember.md | 31 ++- content/commands/vlinks.md | 39 +++- content/commands/vrandmember.md | 34 ++- content/commands/vrange.md | 35 ++- content/commands/vrem.md | 36 ++- content/commands/vsetattr.md | 37 ++- content/commands/vsim.md | 95 +++++++- content/commands/xackdel.md | 8 +- content/commands/xadd.md | 90 +++++--- content/commands/xcfgset.md | 31 ++- content/commands/xinfo-stream.md | 9 +- content/commands/xread.md | 7 +- content/commands/xtrim.md | 21 +- 82 files changed, 1219 insertions(+), 316 deletions(-) diff --git a/content/commands/bitop.md b/content/commands/bitop.md index ac120369e5..0105ab7878 100644 --- a/content/commands/bitop.md +++ b/content/commands/bitop.md @@ -21,6 +21,22 @@ arguments: name: not token: NOT type: pure-token + - display_text: diff + name: diff + token: DIFF + type: pure-token + - display_text: diff1 + name: diff1 + token: DIFF1 + type: pure-token + - display_text: andor + name: andor + token: ANDOR + type: pure-token + - display_text: one + name: one + token: ONE + type: pure-token name: operation type: oneof - display_text: destkey @@ -79,7 +95,8 @@ linkTitle: BITOP railroad_diagram: /images/railroad/bitop.svg since: 2.6.0 summary: Performs bitwise operations on multiple strings, and stores the result. -syntax_fmt: BITOP destkey key [key ...] +syntax_fmt: "BITOP destkey\n \ + \ key [key ...]" title: BITOP --- {{< note >}} diff --git a/content/commands/cluster-migration.md b/content/commands/cluster-migration.md index 7dcab1f40b..b2b2901dac 100644 --- a/content/commands/cluster-migration.md +++ b/content/commands/cluster-migration.md @@ -67,9 +67,9 @@ hidden: false linkTitle: CLUSTER MIGRATION railroad_diagram: /images/railroad/cluster-migration.svg since: 8.4.0 -summary: Start, monitor, and cancel atomic slot migration tasks. -syntax_fmt: "CLUSTER MIGRATION |\n STATUS\_<[ID\_task-id] | [ALL]>>" +summary: Start, monitor and cancel slot migration. +syntax_fmt: "CLUSTER MIGRATION | STATUS\_<[ID\_task-id] | [ALL]>>" title: CLUSTER MIGRATION --- diff --git a/content/commands/cluster-slot-stats.md b/content/commands/cluster-slot-stats.md index 46b4b15ad5..1edccda0fe 100644 --- a/content/commands/cluster-slot-stats.md +++ b/content/commands/cluster-slot-stats.md @@ -1,26 +1,34 @@ --- +acl_categories: +- '@slow' arguments: - arguments: - arguments: - - name: start-slot + - display_text: start-slot + name: start-slot type: integer - - name: end-slot + - display_text: end-slot + name: end-slot type: integer name: slotsrange token: SLOTSRANGE type: block - arguments: - - name: metric + - display_text: metric + name: metric type: string - - name: limit + - display_text: limit + name: limit optional: true token: LIMIT type: integer - arguments: - - name: asc + - display_text: asc + name: asc token: ASC type: pure-token - - name: desc + - display_text: desc + name: desc token: DESC type: pure-token name: order @@ -43,8 +51,8 @@ categories: - kubernetes - clients command_flags: -- STALE -- LOADING +- loading +- stale command_tips: - NONDETERMINISTIC_OUTPUT - REQUEST_POLICY:ALL_SHARDS @@ -56,6 +64,9 @@ description: Return an array of slot usage statistics for slots assigned to the function: clusterSlotStatsCommand group: cluster hidden: false +hints: +- nondeterministic_output +- request_policy:all_shards linkTitle: CLUSTER SLOT-STATS railroad_diagram: /images/railroad/cluster-slot-stats.svg reply_schema: @@ -86,8 +97,8 @@ reply_schema: since: 8.2.0 summary: Return an array of slot usage statistics for slots assigned to the current node. -syntax_fmt: "CLUSTER SLOT-STATS " +syntax_fmt: "CLUSTER SLOT-STATS " title: CLUSTER SLOT-STATS --- diff --git a/content/commands/delex.md b/content/commands/delex.md index fc5384a9c0..bcbe524dae 100644 --- a/content/commands/delex.md +++ b/content/commands/delex.md @@ -42,8 +42,10 @@ categories: command_flags: - write - fast -complexity: O(1) for IFEQ/IFNE, O(N) for IFDEQ/IFDNE where N is the length of the string value. -description: Conditionally removes the specified key based on value or hash digest comparison. +complexity: O(1) for IFEQ/IFNE, O(N) for IFDEQ/IFDNE where N is the length of the + string value. +description: Conditionally removes the specified key based on value or hash digest + comparison. group: string hidden: false key_specs: @@ -59,10 +61,11 @@ key_specs: lastkey: 0 limit: 0 type: range + variable_flags: true linkTitle: DELEX railroad_diagram: /images/railroad/delex.svg since: 8.4.0 -summary: Conditionally removes the specified key based on value or hash digest comparison. +summary: Conditionally removes the specified key based on value or digest comparison. syntax_fmt: "DELEX key [IFEQ\_ifeq-value | IFNE\_ifne-value | IFDEQ\_ifdeq-digest\ \ |\n IFDNE\_ifdne-digest]" title: DELEX diff --git a/content/commands/digest.md b/content/commands/digest.md index 56f614f51a..52a7e8a1ad 100644 --- a/content/commands/digest.md +++ b/content/commands/digest.md @@ -42,7 +42,7 @@ key_specs: linkTitle: DIGEST railroad_diagram: /images/railroad/digest.svg since: 8.4.0 -summary: Returns the hash digest of a string value as a hexadecimal string. +summary: Returns the XXH3 hash of a string value. syntax_fmt: DIGEST key title: DIGEST --- diff --git a/content/commands/ft.aggregate.md b/content/commands/ft.aggregate.md index b05552eec1..f2c773c5d4 100644 --- a/content/commands/ft.aggregate.md +++ b/content/commands/ft.aggregate.md @@ -5,11 +5,14 @@ acl_categories: - '@fast' arguments: - name: index + summary: Specifies the name of the index. The index must be created using `FT.CREATE`. type: string - name: query + summary: Specifies the query to profile and analyze performance. type: string - name: verbatim optional: true + summary: Searches using the exact query terms without stemming or synonym expansion. token: VERBATIM type: pure-token - arguments: @@ -18,12 +21,14 @@ arguments: type: string - multiple: true name: field + summary: Specifies a field in the index schema with its properties. type: string name: load optional: true type: block - name: timeout optional: true + summary: Sets a time limit for query execution, specified in milliseconds. token: TIMEOUT type: integer - name: loadall @@ -38,9 +43,48 @@ arguments: name: property type: string - arguments: - - name: function + - name: reduce token: REDUCE - type: string + type: pure-token + - arguments: + - name: count + token: COUNT + type: pure-token + - name: count_distinct + token: COUNT_DISTINCT + type: pure-token + - name: count_distinctish + token: COUNT_DISTINCTISH + type: pure-token + - name: sum + token: SUM + type: pure-token + - name: min + token: MIN + type: pure-token + - name: max + token: MAX + type: pure-token + - name: avg + token: AVG + type: pure-token + - name: stddev + token: STDDEV + type: pure-token + - name: quantile + token: QUANTILE + type: pure-token + - name: tolist + token: TOLIST + type: pure-token + - name: first_value + token: FIRST_VALUE + type: pure-token + - name: random_sample + token: RANDOM_SAMPLE + type: pure-token + name: function + type: oneof - name: nargs type: integer - multiple: true @@ -53,10 +97,12 @@ arguments: multiple: true name: reduce optional: true + summary: Applies a reducer function, like `SUM` or `COUNT`, on grouped results. type: block multiple: true name: groupby optional: true + summary: Groups results by specified fields, often used for aggregations. type: block - arguments: - name: nargs @@ -86,9 +132,203 @@ arguments: optional: true type: block - arguments: - - name: expression + - arguments: + - arguments: + - token: s + name: exists + summary: Checks whether a field exists in a document. + token: exists + type: function + - arguments: + - token: x + name: log + summary: Return the logarithm of a number, property or subexpression + token: log + type: function + - arguments: + - token: x + name: abs + summary: Return the absolute value of a numeric expression + token: abs + type: function + - arguments: + - token: x + name: ceil + summary: Round to the smallest integer not less than x + token: ceil + type: function + - arguments: + - token: x + name: floor + summary: Round to largest integer not greater than x + token: floor + type: function + - arguments: + - token: x + name: log2 + summary: Return the logarithm of x to base 2 + token: log2 + type: function + - arguments: + - token: x + name: exp + summary: Return the exponent of x, e.g., e^x + token: exp + type: function + - arguments: + - token: x + name: sqrt + summary: Return the square root of x + token: sqrt + type: function + - arguments: + - token: s + name: upper + summary: Return the uppercase conversion of s + token: upper + type: function + - arguments: + - token: s + name: lower + summary: Return the lowercase conversion of s + token: lower + type: function + - arguments: + - token: s1 + - token: s2 + name: startswith + summary: Return 1 if s2 is the prefix of s1, 0 otherwise. + token: startswith + type: function + - arguments: + - token: s1 + - token: s2 + name: contains + summary: Return the number of occurrences of s2 in s1, 0 otherwise. If s2 is + an empty string, return length(s1) + 1. + token: contains + type: function + - arguments: + - token: s + name: strlen + summary: Return the length of s + token: strlen + type: function + - arguments: + - token: s + - token: offset + - token: count + name: substr + summary: Return the substring of s, starting at offset and having count characters. + If offset is negative, it represents the distance from the end of the string. + If count is -1, it means "the rest of the string starting at offset". + token: substr + type: function + - arguments: + - token: fmt + name: format + summary: Use the arguments following fmt to format a string. Currently the only + format argument supported is %s and it applies to all types of arguments. + token: format + type: function + - arguments: + - optional: true + token: max_terms=100 + name: matched_terms + summary: Return the query terms that matched for each record (up to 100), as + a list. If a limit is specified, Redis will return the first N matches found, + based on query order. + token: matched_terms + type: function + - arguments: + - token: s + name: split + summary: Split a string by any character in the string sep, and strip any characters + in strip. If only s is specified, it is split by commas and spaces are stripped. + The output is an array. + token: split + type: function + - arguments: + - token: x + - optional: true + token: fmt + name: timefmt + summary: Return a formatted time string based on a numeric timestamp value x. + token: timefmt + type: function + - arguments: + - token: timesharing + - optional: true + token: fmt + name: parsetime + summary: The opposite of timefmt() - parse a time format using a given format + string + token: parsetime + type: function + - arguments: + - token: timestamp + name: day + summary: Round a Unix timestamp to midnight (00:00) start of the current day. + token: day + type: function + - arguments: + - token: timestamp + name: hour + summary: Round a Unix timestamp to the beginning of the current hour. + token: hour + type: function + - arguments: + - token: timestamp + name: minute + summary: Round a Unix timestamp to the beginning of the current minute. + token: minute + type: function + - arguments: + - token: timestamp + name: month + summary: Round a unix timestamp to the beginning of the current month. + token: month + type: function + - arguments: + - token: timestamp + name: dayofweek + summary: Convert a Unix timestamp to the day number (Sunday = 0). + token: dayofweek + type: function + - arguments: + - token: timestamp + name: dayofmonth + summary: Convert a Unix timestamp to the day of month number (1 .. 31). + token: dayofmonth + type: function + - arguments: + - token: timestamp + name: dayofyear + summary: Convert a Unix timestamp to the day of year number (0 .. 365). + token: dayofyear + type: function + - arguments: + - token: timestamp + name: year + summary: Convert a Unix timestamp to the current year (e.g. 2018). + token: year + type: function + - arguments: + - token: timestamp + name: monthofyear + summary: Convert a Unix timestamp to the current month (0 .. 11). + token: monthofyear + type: function + - arguments: + - token: '' + name: geodistance + summary: Return distance in meters. + token: geodistance + type: function + expression: true + name: expression token: APPLY - type: string + type: block - name: name token: AS type: string @@ -107,8 +347,11 @@ arguments: name: limit optional: true type: block -- name: filter +- expression: true + name: filter optional: true + summary: Applies a numeric range filter to restrict results to documents with field + values within the specified range. token: FILTER type: string - arguments: @@ -146,6 +389,7 @@ arguments: - name: dialect optional: true since: 2.4.3 + summary: Sets the query dialect version to be used. token: DIALECT type: integer categories: @@ -174,22 +418,39 @@ summary: Run a search query on an index and perform aggregate transformations on results syntax: "FT.AGGREGATE index query \n [VERBATIM] \n [LOAD count field [field ...]]\ \ \n [TIMEOUT timeout] \n [GROUPBY nargs property [property ...] [REDUCE function\ - \ nargs arg [arg ...] [AS name] [REDUCE function nargs arg [arg ...] [AS name]\ - \ ...]] ...]] \n [SORTBY nargs [property ASC | DESC [property ASC | DESC ...]]\ - \ [MAX num] [WITHCOUNT | WITHOUTCOUNT]] \n [APPLY expression AS name [APPLY expression AS name\ - \ ...]] \n [LIMIT offset num] \n [FILTER filter] \n [WITHCURSOR [COUNT read_size]\ - \ [MAXIDLE idle_time]] \n [PARAMS nargs name value [name value ...]] \n [SCORER scorer]\n - \ [ADDSCORES] \n [DIALECT\ - \ dialect]\n" + \ nargs arg [arg ...] [AS name] [REDUCE function nargs arg [arg ...] [AS name] ...]]\ + \ ...]] \n [SORTBY nargs [property ASC | DESC [property ASC | DESC ...]] [MAX num]\ + \ [WITHCOUNT | WITHOUTCOUNT]] \n [APPLY expression AS name [APPLY expression AS\ + \ name ...]] \n [LIMIT offset num] \n [FILTER filter] \n [WITHCURSOR [COUNT read_size]\ + \ [MAXIDLE idle_time]] \n [PARAMS nargs name value [name value ...]] \n [SCORER\ + \ scorer]\n [ADDSCORES] \n [DIALECT dialect]\n" syntax_fmt: "FT.AGGREGATE index query [VERBATIM] [LOAD\_count field [field ...]]\n\ - \ [TIMEOUT\_timeout] [LOAD *] [GROUPBY\_nargs property [property ...]\n [REDUCE\_\ - function nargs arg [arg ...] [AS\_name] [REDUCE\_function\n nargs arg [arg ...]\ - \ [AS\_name] ...]] [GROUPBY\_nargs property\n [property ...] [REDUCE\_function\ - \ nargs arg [arg ...] [AS\_name]\n [REDUCE\_function nargs arg [arg ...] [AS\_\ - name] ...]] ...]]\n [SORTBY\_nargs [property [property \ - \ ...]]\n [MAX\_num]] [APPLY\_expression AS\_name [APPLY\_expression AS\_name\n\ - \ ...]] [LIMIT offset num] [FILTER\_filter] [WITHCURSOR\n [COUNT\_read_size] [MAXIDLE\_\ - idle_time]] [PARAMS nargs name value\n [name value ...]] [DIALECT\_dialect]" + \ [TIMEOUT\_timeout] [LOAD *] [GROUPBY\_nargs property [property ...]\n [REDUCE\ + \ nargs arg [arg ...] [AS\_\ + name] [REDUCE nargs\n arg\ + \ [arg ...] [AS\_name] ...]] [GROUPBY\_nargs property [property\n ...] [REDUCE\ + \ nargs arg [arg ...] [AS\_\ + name] [REDUCE nargs\n arg\ + \ [arg ...] [AS\_name] ...]] ...]] [SORTBY\_nargs [property [property\ + \ ...]] [MAX\_num]] [APPLY\_exists\_exists\n log\_log abs\_abs ceil\_\ + ceil floor\_floor log2\_log2 exp\_exp sqrt\_sqrt\n upper\_upper lower\_lower startswith\_\ + startswith contains\_contains\n strlen\_strlen substr\_substr format\_format\n\ + \ matched_terms\_matched_terms split\_split timefmt\_timefmt\n parsetime\_parsetime\ + \ day\_day hour\_hour minute\_minute month\_month\n dayofweek\_dayofweek dayofmonth\_\ + dayofmonth dayofyear\_dayofyear\n year\_year monthofyear\_monthofyear geodistance\_\ + geodistance AS\_name\n [APPLY\_exists\_exists log\_log abs\_abs ceil\_ceil floor\_\ + floor\n log2\_log2 exp\_exp sqrt\_sqrt upper\_upper lower\_lower\n startswith\_\ + startswith contains\_contains strlen\_strlen\n substr\_substr format\_format matched_terms\_\ + matched_terms\n split\_split timefmt\_timefmt parsetime\_parsetime day\_day hour\_\ + hour\n minute\_minute month\_month dayofweek\_dayofweek\n dayofmonth\_dayofmonth\ + \ dayofyear\_dayofyear year\_year\n monthofyear\_monthofyear geodistance\_geodistance\ + \ AS\_name ...]]\n [LIMIT offset num] [FILTER\_filter] [WITHCURSOR [COUNT\_read_size]\n\ + \ [MAXIDLE\_idle_time]] [PARAMS nargs name value [name value ...]]\n [DIALECT\_\ + dialect]" title: FT.AGGREGATE --- diff --git a/content/commands/ft.aliasadd.md b/content/commands/ft.aliasadd.md index 41eb22c7f8..610f99d36b 100644 --- a/content/commands/ft.aliasadd.md +++ b/content/commands/ft.aliasadd.md @@ -5,6 +5,7 @@ arguments: - name: alias type: string - name: index + summary: Specifies the name of the index. The index must be created using `FT.CREATE`. type: string categories: - docs diff --git a/content/commands/ft.aliasupdate.md b/content/commands/ft.aliasupdate.md index a3d820cd3e..4dbd679fd2 100644 --- a/content/commands/ft.aliasupdate.md +++ b/content/commands/ft.aliasupdate.md @@ -5,6 +5,7 @@ arguments: - name: alias type: string - name: index + summary: Specifies the name of the index. The index must be created using `FT.CREATE`. type: string categories: - docs diff --git a/content/commands/ft.alter.md b/content/commands/ft.alter.md index 6428e25483..af726ad392 100644 --- a/content/commands/ft.alter.md +++ b/content/commands/ft.alter.md @@ -3,18 +3,23 @@ acl_categories: - '@search' arguments: - name: index + summary: Specifies the name of the index. The index must be created using `FT.CREATE`. type: string - name: skipinitialscan optional: true + summary: Skips the initial scan of the database when creating the index. token: SKIPINITIALSCAN type: pure-token - name: schema + summary: Defines the fields in the index and their properties, such as type (`TEXT`, + `TAG`, `NUMERIC`, etc.). token: SCHEMA type: pure-token - name: add token: ADD type: pure-token - name: field + summary: Specifies a field in the index schema with its properties. type: string - name: options type: string diff --git a/content/commands/ft.config-get.md b/content/commands/ft.config-get.md index 69edfb28dd..eec2d1adda 100644 --- a/content/commands/ft.config-get.md +++ b/content/commands/ft.config-get.md @@ -27,7 +27,7 @@ hidden: false linkTitle: FT.CONFIG GET module: Search railroad_diagram: /images/railroad/ft.config-get.svg -replaced_by: '[`CONFIG GET`]({{< relref "/commands/config-get" >}})' +replaced_by: CONFIG GET since: 1.0.0 stack_path: docs/interact/search-and-query summary: Retrieves runtime configuration options diff --git a/content/commands/ft.config-help.md b/content/commands/ft.config-help.md index 50d0ebd8ed..9c7433f4f6 100644 --- a/content/commands/ft.config-help.md +++ b/content/commands/ft.config-help.md @@ -18,12 +18,14 @@ categories: command_flags: - readonly complexity: O(1) +deprecated_since: 8.0.0 description: Help description of runtime configuration options group: search hidden: true linkTitle: FT.CONFIG HELP module: Search railroad_diagram: /images/railroad/ft.config-help.svg +replaced_by: CONFIG HELP since: 1.0.0 stack_path: docs/interact/search-and-query summary: Help description of runtime configuration options diff --git a/content/commands/ft.config-set.md b/content/commands/ft.config-set.md index d9966a9792..aef2c2c8bb 100644 --- a/content/commands/ft.config-set.md +++ b/content/commands/ft.config-set.md @@ -27,7 +27,7 @@ hidden: false linkTitle: FT.CONFIG SET module: Search railroad_diagram: /images/railroad/ft.config-set.svg -replaced_by: '[`CONFIG SET`]({{< relref "/commands/config-set" >}})' +replaced_by: CONFIG SET since: 1.0.0 stack_path: docs/interact/search-and-query summary: Sets runtime configuration options diff --git a/content/commands/ft.create.md b/content/commands/ft.create.md index 659ec25ba2..36050e9365 100644 --- a/content/commands/ft.create.md +++ b/content/commands/ft.create.md @@ -17,22 +17,6 @@ arguments: summary: Specifies the type of data to index, such as HASH or JSON. token: 'ON' type: oneof -- arguments: - - name: enable - summary: Maintains an inverted index of all document IDs for wildcard queries. - token: ENABLE - type: pure-token - - name: disable - summary: Does not maintain an inverted index of all document IDs (default behavior). - token: DISABLE - type: pure-token - name: indexall - optional: true - since: 8.0.0 - summary: When enabled, maintains an inverted index of all document IDs to optimize - wildcard queries in heavy update scenarios. - token: INDEXALL - type: oneof - arguments: - name: count token: PREFIX @@ -152,9 +136,6 @@ arguments: - name: geo token: GEO type: pure-token - - name: geoshape - token: GEOSHAPE - type: pure-token - name: vector token: VECTOR type: pure-token @@ -223,14 +204,15 @@ syntax: "FT.CREATE index \n [ON HASH | JSON] \n [PREFIX count prefix [prefix . \ \n [SCORE default_score] \n [SCORE_FIELD score_attribute] \n [PAYLOAD_FIELD\ \ payload_attribute] \n [MAXTEXTFIELDS] \n [TEMPORARY seconds] \n [NOOFFSETS]\ \ \n [NOHL] \n [NOFIELDS] \n [NOFREQS] \n [STOPWORDS count [stopword ...]] \n\ - \ [SKIPINITIALSCAN]\n [INDEXALL ]\n SCHEMA field_name [AS alias] TEXT | TAG | NUMERIC | GEO\ - \ | VECTOR | GEOSHAPE [ SORTABLE [UNF]] \n [NOINDEX] [ field_name [AS alias] TEXT\ - \ | TAG | NUMERIC | GEO | VECTOR | GEOSHAPE [ SORTABLE [UNF]] [NOINDEX] ...]\n" + \ [SKIPINITIALSCAN]\n [INDEXALL ]\n SCHEMA field_name [AS alias]\ + \ TEXT | TAG | NUMERIC | GEO | VECTOR | GEOSHAPE [ SORTABLE [UNF]] \n [NOINDEX]\ + \ [ field_name [AS alias] TEXT | TAG | NUMERIC | GEO | VECTOR | GEOSHAPE [ SORTABLE\ + \ [UNF]] [NOINDEX] ...]\n" syntax_fmt: "FT.CREATE index [ON\_] [PREFIX\_count prefix [prefix\n \ \ ...]] [FILTER\_filter] [LANGUAGE\_default_lang]\n [LANGUAGE_FIELD\_lang_attribute]\ \ [SCORE\_default_score]\n [SCORE_FIELD\_score_attribute] [PAYLOAD_FIELD\_payload_attribute]\n\ \ [MAXTEXTFIELDS] [TEMPORARY\_seconds] [NOOFFSETS] [NOHL] [NOFIELDS]\n [NOFREQS]\ - \ [STOPWORDS\_count [stopword [stopword ...]]]\n [SKIPINITIALSCAN] [INDEXALL ] SCHEMA field_name\ + \ [STOPWORDS\_count [stopword [stopword ...]]]\n [SKIPINITIALSCAN] SCHEMA field_name\ \ [AS\_alias] [WITHSUFFIXTRIE] [INDEXEMPTY]\n\ \ [INDEXMISSING] [SORTABLE [UNF]] [NOINDEX] [field_name [AS\_alias]\n [WITHSUFFIXTRIE]\n [INDEXEMPTY] [INDEXMISSING]\ diff --git a/content/commands/ft.cursor-del.md b/content/commands/ft.cursor-del.md index f0eae69770..92c5d65a25 100644 --- a/content/commands/ft.cursor-del.md +++ b/content/commands/ft.cursor-del.md @@ -4,6 +4,7 @@ acl_categories: - '@search' arguments: - name: index + summary: Specifies the name of the index. The index must be created using `FT.CREATE`. type: string - name: cursor_id type: integer @@ -17,6 +18,8 @@ categories: - oss - kubernetes - clients +command_tips: +- REQUEST_POLICY:SPECIAL complexity: O(1) description: Deletes a cursor group: search diff --git a/content/commands/ft.cursor-read.md b/content/commands/ft.cursor-read.md index 0036bf5dcb..fb5717761f 100644 --- a/content/commands/ft.cursor-read.md +++ b/content/commands/ft.cursor-read.md @@ -4,6 +4,7 @@ acl_categories: - '@search' arguments: - name: index + summary: Specifies the name of the index. The index must be created using `FT.CREATE`. type: string - name: cursor_id type: integer @@ -21,6 +22,8 @@ categories: - oss - kubernetes - clients +command_tips: +- REQUEST_POLICY:SPECIAL complexity: O(1) description: Reads from a cursor group: search diff --git a/content/commands/ft.dropindex.md b/content/commands/ft.dropindex.md index 5d89bc8280..ceaae6d214 100644 --- a/content/commands/ft.dropindex.md +++ b/content/commands/ft.dropindex.md @@ -6,6 +6,7 @@ acl_categories: - '@write' arguments: - name: index + summary: Specifies the name of the index. The index must be created using `FT.CREATE`. type: string - arguments: - name: delete docs diff --git a/content/commands/ft.explain.md b/content/commands/ft.explain.md index 870363efe0..0efea9cb82 100644 --- a/content/commands/ft.explain.md +++ b/content/commands/ft.explain.md @@ -3,12 +3,15 @@ acl_categories: - '@search' arguments: - name: index + summary: Specifies the name of the index. The index must be created using `FT.CREATE`. type: string - name: query + summary: Specifies the query to profile and analyze performance. type: string - name: dialect optional: true since: 2.4.3 + summary: Sets the query dialect version to be used. token: DIALECT type: integer categories: diff --git a/content/commands/ft.explaincli.md b/content/commands/ft.explaincli.md index 54357d05f9..33d2b9b215 100644 --- a/content/commands/ft.explaincli.md +++ b/content/commands/ft.explaincli.md @@ -3,12 +3,15 @@ acl_categories: - '@search' arguments: - name: index + summary: Specifies the name of the index. The index must be created using `FT.CREATE`. type: string - name: query + summary: Specifies the query to profile and analyze performance. type: string - name: dialect optional: true since: 2.4.3 + summary: Sets the query dialect version to be used. token: DIALECT type: integer categories: diff --git a/content/commands/ft.hybrid.md b/content/commands/ft.hybrid.md index 7526fd03f4..01722ef887 100644 --- a/content/commands/ft.hybrid.md +++ b/content/commands/ft.hybrid.md @@ -71,7 +71,8 @@ arguments: name: vector_query_type optional: true type: oneof - - name: filter + - expression: true + name: filter optional: true token: FILTER type: string @@ -429,7 +430,7 @@ arguments: - arguments: - token: timestamp name: month - summary: Round a Unix timestamp to the beginning of the current month. + summary: Round a unix timestamp to the beginning of the current month. token: month type: function - arguments: @@ -471,7 +472,7 @@ arguments: expression: true name: expression token: APPLY - type: string + type: block - name: name token: AS type: string @@ -479,11 +480,31 @@ arguments: name: apply optional: true type: block -- expression: true +- arguments: + - name: count + type: integer + - expression: true + name: filter_expression + type: string + - arguments: + - name: adhoc + token: ADHOC + type: pure-token + - name: batches + token: BATCHES + type: pure-token + name: policy + optional: true + token: POLICY + type: oneof + - name: batch_size_value + optional: true + token: BATCH_SIZE + type: integer name: filter optional: true token: FILTER - type: string + type: block categories: - docs - develop @@ -501,20 +522,35 @@ group: search hidden: false linkTitle: FT.HYBRID railroad_diagram: /images/railroad/ft.hybrid.svg -since: 8.4.0 +since: 8.4.4 summary: Performs hybrid search combining text search and vector similarity search -syntax_fmt: "FT.HYBRID index\n SEARCH query\n [SCORER scorer]\n [YIELD_SCORE_AS\ - \ name]\n VSIM vector_field $vector_param\n [KNN count K k [EF_RUNTIME ef_runtime]]\n\ - \ [RANGE count RADIUS radius [EPSILON epsilon]]\n [YIELD_SCORE_AS name]\n\ - \ [FILTER filter]\n [COMBINE RRF count [CONSTANT constant] [WINDOW window]\ - \ [YIELD_SCORE_AS name]]\n [COMBINE LINEAR count [[ALPHA alpha] [BETA beta]] [WINDOW\ - \ window] [YIELD_SCORE_AS name]]\n [LIMIT offset num]\n [SORTBY count sortby\ - \ [ASC | DESC]]\n [NOSORT]\n [LOAD count field [field ...]]\n [LOAD *]\n [GROUPBY\ - \ nargs property [property ...]\n [GROUPBY nargs property [property ...]\n \ - \ [REDUCE function nargs arg [arg ...] [AS name]\n [REDUCE function nargs arg\ - \ [arg ...] [AS name] ...]] ...]]\n [APPLY expression AS name [APPLY expression\ - \ AS name ...]]\n [FILTER filter]\n PARAMS nargs vector_param vector_blob [name\ - \ value ...]\n [TIMEOUT timeout]" +syntax_fmt: "FT.HYBRID index SEARCH query [SCORER\_scorer]\n [YIELD_SCORE_AS\_yield_score_as]\ + \ VSIM field vector [KNN count K\_k\n [EF_RUNTIME\_ef_runtime] [YIELD_SCORE_AS\_\ + yield_score_as] | RANGE\n count RADIUS\_radius [EPSILON\_epsilon]\n [YIELD_SCORE_AS\_\ + yield_score_as]] [FILTER\_filter] [COMBINE ]\n [LIMIT offset num]\ + \ [SORTBY\_sortby [ASC | DESC] | NOSORT] [PARAMS\n nargs name value [name value\ + \ ...]] [TIMEOUT\_timeout]\n [FORMAT\_format] [LOAD\_count field [field ...]] [LOAD\ + \ *] [GROUPBY\n nproperties property [property ...] [REDUCE nargs\n arg [arg ...] [AS\_name] [REDUCE nargs arg [arg ...]\n [AS\_name] ...]]]\ + \ [APPLY\_exists\_exists log\_log abs\_abs ceil\_ceil\n floor\_floor log2\_log2\ + \ exp\_exp sqrt\_sqrt upper\_upper lower\_lower\n startswith\_startswith contains\_\ + contains strlen\_strlen\n substr\_substr format\_format matched_terms\_matched_terms\n\ + \ split\_split timefmt\_timefmt parsetime\_parsetime day\_day hour\_hour\n minute\_\ + minute month\_month dayofweek\_dayofweek\n dayofmonth\_dayofmonth dayofyear\_dayofyear\ + \ year\_year\n monthofyear\_monthofyear geodistance\_geodistance AS\_name\n [APPLY\_\ + exists\_exists log\_log abs\_abs ceil\_ceil floor\_floor\n log2\_log2 exp\_exp\ + \ sqrt\_sqrt upper\_upper lower\_lower\n startswith\_startswith contains\_contains\ + \ strlen\_strlen\n substr\_substr format\_format matched_terms\_matched_terms\n\ + \ split\_split timefmt\_timefmt parsetime\_parsetime day\_day hour\_hour\n minute\_\ + minute month\_month dayofweek\_dayofweek\n dayofmonth\_dayofmonth dayofyear\_dayofyear\ + \ year\_year\n monthofyear\_monthofyear geodistance\_geodistance AS\_name ...]]\n\ + \ [FILTER\_count filter_expression [POLICY\_]\n [BATCH_SIZE\_\ + batch_size_value]]" title: FT.HYBRID --- diff --git a/content/commands/ft.info.md b/content/commands/ft.info.md index 909fd898a1..124d2c832c 100644 --- a/content/commands/ft.info.md +++ b/content/commands/ft.info.md @@ -3,6 +3,7 @@ acl_categories: - '@search' arguments: - name: index + summary: Specifies the name of the index. The index must be created using `FT.CREATE`. type: string categories: - docs diff --git a/content/commands/ft.profile.md b/content/commands/ft.profile.md index a8d84b5e7f..5060f272c9 100644 --- a/content/commands/ft.profile.md +++ b/content/commands/ft.profile.md @@ -4,6 +4,7 @@ acl_categories: - '@search' arguments: - name: index + summary: Specifies the name of the index. The index must be created using `FT.CREATE`. type: string - arguments: - name: search @@ -16,12 +17,14 @@ arguments: type: oneof - name: limited optional: true + summary: Restricts profiling to the initial phase of the query execution. token: LIMITED type: pure-token - name: queryword token: QUERY type: pure-token - name: query + summary: Specifies the query to profile and analyze performance. type: string categories: - docs diff --git a/content/commands/ft.search.md b/content/commands/ft.search.md index 90a6a57739..ab063c9b1c 100644 --- a/content/commands/ft.search.md +++ b/content/commands/ft.search.md @@ -4,15 +4,19 @@ acl_categories: - '@search' arguments: - name: index + summary: Specifies the name of the index. The index must be created using `FT.CREATE`. type: string - name: query + summary: Specifies the query to profile and analyze performance. type: string - name: nocontent optional: true + summary: Returns only the document IDs in the search results, excluding the content. token: NOCONTENT type: pure-token - name: verbatim optional: true + summary: Searches using the exact query terms without stemming or query expansion. token: VERBATIM type: pure-token - name: nostopwords @@ -21,6 +25,7 @@ arguments: type: pure-token - name: withscores optional: true + summary: Includes the relative scores of each document in the search results. token: WITHSCORES type: pure-token - name: withpayloads @@ -29,6 +34,7 @@ arguments: type: pure-token - name: withsortkeys optional: true + summary: Returns the sorting key value alongside the document ID. token: WITHSORTKEYS type: pure-token - arguments: @@ -42,6 +48,8 @@ arguments: multiple: true name: filter optional: true + summary: Applies a numeric range filter to restrict results to documents with field + values within the specified range. type: block - arguments: - name: geo_field @@ -88,6 +96,7 @@ arguments: type: string - multiple: true name: field + summary: Specifies a field in the index schema with its properties. type: string name: in_fields optional: true @@ -119,6 +128,7 @@ arguments: type: string - multiple: true name: field + summary: Specifies a field in the index schema with its properties. type: string name: fields optional: true @@ -137,9 +147,12 @@ arguments: type: string name: summarize optional: true + summary: Splits a field into contextual fragments surrounding the found terms, Note + that summarize for JSON documents is not currently supported. type: block - arguments: - name: highlight + summary: Highlights terms in the search results, with customizable tags for emphasis. token: HIGHLIGHT type: pure-token - arguments: @@ -148,6 +161,7 @@ arguments: type: string - multiple: true name: field + summary: Specifies a field in the index schema with its properties. type: string name: fields optional: true @@ -165,6 +179,8 @@ arguments: type: block name: highlight optional: true + summary: Highlights terms in the search results, with customizable tags for emphasis. + Note that highlight for JSON documents is not currently supported. type: block - name: slop optional: true @@ -172,6 +188,7 @@ arguments: type: integer - name: timeout optional: true + summary: Sets a time limit for query execution, specified in milliseconds. token: TIMEOUT type: integer - name: inorder @@ -180,6 +197,8 @@ arguments: type: pure-token - name: language optional: true + summary: Specifies the default language for full-text search, influencing stemming + and stop-word behavior. token: LANGUAGE type: string - name: expander @@ -246,6 +265,7 @@ arguments: - name: dialect optional: true since: 2.4.3 + summary: Sets the query dialect version to be used. token: DIALECT type: integer categories: @@ -275,18 +295,18 @@ since: 1.0.0 stack_path: docs/interact/search-and-query summary: Searches the index with a textual query, returning either documents or just ids -syntax: "FT.SEARCH index query \n [NOCONTENT] \n [VERBATIM] \n [NOSTOPWORDS] \n [WITHSCORES]\ - \ \n [WITHPAYLOADS] \n [WITHSORTKEYS] \n [FILTER numeric_field min max [ FILTER\ - \ numeric_field min max ...]] \n [GEOFILTER geo_field lon lat radius m | km | mi\ - \ | ft [ GEOFILTER geo_field lon lat radius m | km | mi | ft ...]] \n [INKEYS count\ - \ key [key ...]] \n [INFIELDS count field [field ...]] \n [RETURN count identifier\ - \ [AS property] [ identifier [AS property] ...]] \n [SUMMARIZE [ FIELDS count field\ - \ [field ...]] [FRAGS num] [LEN fragsize] [SEPARATOR separator]] \n [HIGHLIGHT\ - \ [ FIELDS count field [field ...]] [ TAGS open close]] \n [SLOP slop] \n [TIMEOUT\ - \ timeout] \n [INORDER] \n [LANGUAGE language] \n [EXPANDER expander] \n [SCORER\ - \ scorer] \n [EXPLAINSCORE] \n [PAYLOAD payload] \n [SORTBY sortby [ ASC | DESC]\ - \ [WITHCOUNT | WITHOUTCOUNT]] \n [LIMIT offset num] \n [PARAMS nargs name value [ name value\ - \ ...]] \n [DIALECT dialect]\n" +syntax: "FT.SEARCH index query \n [NOCONTENT] \n [VERBATIM] \n [NOSTOPWORDS] \n\ + \ [WITHSCORES] \n [WITHPAYLOADS] \n [WITHSORTKEYS] \n [FILTER numeric_field\ + \ min max [ FILTER numeric_field min max ...]] \n [GEOFILTER geo_field lon lat\ + \ radius m | km | mi | ft [ GEOFILTER geo_field lon lat radius m | km | mi | ft\ + \ ...]] \n [INKEYS count key [key ...]] \n [INFIELDS count field [field ...]]\ + \ \n [RETURN count identifier [AS property] [ identifier [AS property] ...]] \n\ + \ [SUMMARIZE [ FIELDS count field [field ...]] [FRAGS num] [LEN fragsize] [SEPARATOR\ + \ separator]] \n [HIGHLIGHT [ FIELDS count field [field ...]] [ TAGS open close]]\ + \ \n [SLOP slop] \n [TIMEOUT timeout] \n [INORDER] \n [LANGUAGE language] \n\ + \ [EXPANDER expander] \n [SCORER scorer] \n [EXPLAINSCORE] \n [PAYLOAD payload]\ + \ \n [SORTBY sortby [ ASC | DESC] [WITHCOUNT | WITHOUTCOUNT]] \n [LIMIT offset\ + \ num] \n [PARAMS nargs name value [ name value ...]] \n [DIALECT dialect]\n" syntax_fmt: "FT.SEARCH index query [NOCONTENT] [VERBATIM] [NOSTOPWORDS]\n [WITHSCORES]\ \ [WITHPAYLOADS] [WITHSORTKEYS] [FILTER\_numeric_field\n min max [FILTER\_numeric_field\ \ min max ...]] [GEOFILTER\_geo_field\n lon lat radius [GEOFILTER\_\ diff --git a/content/commands/ft.spellcheck.md b/content/commands/ft.spellcheck.md index bf0e7958b3..3c2a374a39 100644 --- a/content/commands/ft.spellcheck.md +++ b/content/commands/ft.spellcheck.md @@ -3,8 +3,10 @@ acl_categories: - '@search' arguments: - name: index + summary: Specifies the name of the index. The index must be created using `FT.CREATE`. type: string - name: query + summary: Specifies the query to profile and analyze performance. type: string - name: distance optional: true @@ -33,6 +35,7 @@ arguments: - name: dialect optional: true since: 2.4.3 + summary: Sets the query dialect version to be used. token: DIALECT type: integer categories: diff --git a/content/commands/ft.sugget.md b/content/commands/ft.sugget.md index 230fd27dc4..e14f5a70b9 100644 --- a/content/commands/ft.sugget.md +++ b/content/commands/ft.sugget.md @@ -5,6 +5,8 @@ arguments: - name: key type: string - name: prefix + summary: Filters indexed documents to include only keys that start with the specified + prefix. type: string - name: fuzzy optional: true @@ -12,6 +14,7 @@ arguments: type: pure-token - name: withscores optional: true + summary: Includes the relative scores of each document in the search results. token: WITHSCORES type: pure-token - name: withpayloads diff --git a/content/commands/ft.syndump.md b/content/commands/ft.syndump.md index df9ef3aaae..38978eefdd 100644 --- a/content/commands/ft.syndump.md +++ b/content/commands/ft.syndump.md @@ -3,6 +3,7 @@ acl_categories: - '@search' arguments: - name: index + summary: Specifies the name of the index. The index must be created using `FT.CREATE`. type: string categories: - docs diff --git a/content/commands/ft.synupdate.md b/content/commands/ft.synupdate.md index 01daa6cd81..d626643840 100644 --- a/content/commands/ft.synupdate.md +++ b/content/commands/ft.synupdate.md @@ -3,11 +3,13 @@ acl_categories: - '@search' arguments: - name: index + summary: Specifies the name of the index. The index must be created using `FT.CREATE`. type: string - name: synonym_group_id type: string - name: skipinitialscan optional: true + summary: Skips the initial scan of the database when creating the index. token: SKIPINITIALSCAN type: pure-token - multiple: true diff --git a/content/commands/ft.tagvals.md b/content/commands/ft.tagvals.md index d8b680ac27..6080c0c998 100644 --- a/content/commands/ft.tagvals.md +++ b/content/commands/ft.tagvals.md @@ -6,6 +6,7 @@ acl_categories: - '@slow' arguments: - name: index + summary: Specifies the name of the index. The index must be created using `FT.CREATE`. type: string - name: field_name type: string diff --git a/content/commands/hexpire.md b/content/commands/hexpire.md index 0285f43a01..0790e336a4 100644 --- a/content/commands/hexpire.md +++ b/content/commands/hexpire.md @@ -55,7 +55,6 @@ categories: - clients command_flags: - write -- denyoom - fast complexity: O(N) where N is the number of specified fields description: Set expiration for hash fields using relative time to expire (seconds) diff --git a/content/commands/hexpireat.md b/content/commands/hexpireat.md index 99cf527e52..edfb92ce13 100644 --- a/content/commands/hexpireat.md +++ b/content/commands/hexpireat.md @@ -55,7 +55,6 @@ categories: - clients command_flags: - write -- denyoom - fast complexity: O(N) where N is the number of specified fields description: Set expiration for hash fields using an absolute Unix timestamp (seconds) diff --git a/content/commands/hotkeys-get.md b/content/commands/hotkeys-get.md index 1b9f235f61..cc985f27af 100644 --- a/content/commands/hotkeys-get.md +++ b/content/commands/hotkeys-get.md @@ -19,10 +19,15 @@ command_flags: - noscript complexity: O(K) where K is the number of hotkeys returned. container: HOTKEYS -description: Returns lists of top K hotkeys depending on metrics chosen in HOTKEYS START command. +description: Returns lists of top K hotkeys depending on metrics chosen in HOTKEYS + START command. function: hotkeysCommand group: server hidden: false +hints: +- nondeterministic_output +- request_policy:special +- response_policy:special linkTitle: HOTKEYS GET railroad_diagram: /images/railroad/hotkeys-get.svg reply_schema: @@ -44,7 +49,8 @@ reply_schema: - description: If no tracking is started type: 'null' since: 8.6.0 -summary: Returns lists of top K hotkeys depending on metrics chosen in HOTKEYS START command. +summary: Returns lists of top K hotkeys depending on metrics chosen in HOTKEYS START + command. syntax_fmt: HOTKEYS GET title: HOTKEYS GET --- diff --git a/content/commands/hotkeys-reset.md b/content/commands/hotkeys-reset.md index 6afdd51b83..cfaa1eb2e2 100644 --- a/content/commands/hotkeys-reset.md +++ b/content/commands/hotkeys-reset.md @@ -23,6 +23,8 @@ description: Release the resources used for hotkey tracking. function: hotkeysCommand group: server hidden: false +hints: +- request_policy:special linkTitle: HOTKEYS RESET railroad_diagram: /images/railroad/hotkeys-reset.svg since: 8.6.0 diff --git a/content/commands/hotkeys-start.md b/content/commands/hotkeys-start.md index 82bda1af6a..646f792243 100644 --- a/content/commands/hotkeys-start.md +++ b/content/commands/hotkeys-start.md @@ -68,13 +68,16 @@ description: Starts hotkeys tracking. function: hotkeysCommand group: server hidden: false +hints: +- request_policy:special linkTitle: HOTKEYS START railroad_diagram: /images/railroad/hotkeys-start.svg reply_schema: const: OK since: 8.6.0 summary: Starts hotkeys tracking. -syntax_fmt: HOTKEYS START METRICS count [CPU] [NET] [COUNT k] [DURATION seconds] [SAMPLE ratio] [SLOTS count slot [slot ...]] +syntax_fmt: "HOTKEYS START METRICS\_count [CPU] [NET] [COUNT\_k] [DURATION\_seconds]\n\ + \ [SAMPLE\_ratio] [SLOTS\_count slot [slot ...]]" title: HOTKEYS START --- Starts hotkeys tracking with specified metrics. diff --git a/content/commands/hotkeys-stop.md b/content/commands/hotkeys-stop.md index d75954f8be..868fc138a9 100644 --- a/content/commands/hotkeys-stop.md +++ b/content/commands/hotkeys-stop.md @@ -23,6 +23,8 @@ description: Stops hotkeys tracking. function: hotkeysCommand group: server hidden: false +hints: +- request_policy:special linkTitle: HOTKEYS STOP railroad_diagram: /images/railroad/hotkeys-stop.svg reply_schema: diff --git a/content/commands/hpexpire.md b/content/commands/hpexpire.md index 021a2b7741..94607c547a 100644 --- a/content/commands/hpexpire.md +++ b/content/commands/hpexpire.md @@ -55,7 +55,6 @@ categories: - clients command_flags: - write -- denyoom - fast complexity: O(N) where N is the number of specified fields description: Set expiration for hash fields using relative time to expire (milliseconds) diff --git a/content/commands/hpexpireat.md b/content/commands/hpexpireat.md index 959a48e25a..8dff743b68 100644 --- a/content/commands/hpexpireat.md +++ b/content/commands/hpexpireat.md @@ -55,7 +55,6 @@ categories: - clients command_flags: - write -- denyoom - fast complexity: O(N) where N is the number of specified fields description: Set expiration for hash fields using an absolute Unix timestamp (milliseconds) diff --git a/content/commands/hpttl.md b/content/commands/hpttl.md index 3069e29603..7220c15841 100644 --- a/content/commands/hpttl.md +++ b/content/commands/hpttl.md @@ -37,6 +37,8 @@ complexity: O(N) where N is the number of specified fields description: Returns the TTL in milliseconds of a hash field. group: hash hidden: false +hints: +- nondeterministic_output key_specs: - RO: true access: true diff --git a/content/commands/httl.md b/content/commands/httl.md index 49ca42ba22..0a4396fa9c 100644 --- a/content/commands/httl.md +++ b/content/commands/httl.md @@ -37,6 +37,8 @@ complexity: O(N) where N is the number of specified fields description: Returns the TTL in seconds of a hash field. group: hash hidden: false +hints: +- nondeterministic_output key_specs: - RO: true access: true diff --git a/content/commands/json.arrappend.md b/content/commands/json.arrappend.md index c8f221eb94..148cbb2f37 100644 --- a/content/commands/json.arrappend.md +++ b/content/commands/json.arrappend.md @@ -7,6 +7,7 @@ arguments: - name: key type: key - name: path + optional: true type: string - multiple: true name: value @@ -34,7 +35,7 @@ since: 1.0.0 stack_path: docs/data-types/json summary: Append one or more json values into the array at path after the last element in it. -syntax_fmt: JSON.ARRAPPEND key path value [value ...] +syntax_fmt: JSON.ARRAPPEND key [path] value [value ...] title: JSON.ARRAPPEND --- Append the JSON values into the array at `path` after the last element in it. diff --git a/content/commands/json.objkeys.md b/content/commands/json.objkeys.md index 027449b427..0508ee72e3 100644 --- a/content/commands/json.objkeys.md +++ b/content/commands/json.objkeys.md @@ -22,7 +22,8 @@ categories: complexity: O(N) when path is evaluated to a single value, where N is the number of keys in the object, O(N) when path is evaluated to multiple values, where N is the size of the key -description: Returns the key names of JSON objects at the paths matching a given path expression +description: Returns the key names of JSON objects at the paths matching a given path + expression group: json hidden: false linkTitle: JSON.OBJKEYS @@ -30,7 +31,7 @@ module: JSON railroad_diagram: /images/railroad/json.objkeys.svg since: 1.0.0 stack_path: docs/data-types/json -summary: Returns the key names of JSON objects at the paths matching a given path expression +summary: Returns the JSON keys of the object at path syntax_fmt: JSON.OBJKEYS key [path] title: JSON.OBJKEYS --- diff --git a/content/commands/json.objlen.md b/content/commands/json.objlen.md index 40637ebd80..ccae8348b6 100644 --- a/content/commands/json.objlen.md +++ b/content/commands/json.objlen.md @@ -21,7 +21,8 @@ categories: - clients complexity: O(1) when path is evaluated to a single value, O(N) when path is evaluated to multiple values, where N is the size of the key -description: Returns the number of keys in JSON objects at the paths matching a given path expression +description: Returns the number of keys in JSON objects at the paths matching a given + path expression group: json hidden: false linkTitle: JSON.OBJLEN @@ -29,7 +30,7 @@ module: JSON railroad_diagram: /images/railroad/json.objlen.svg since: 1.0.0 stack_path: docs/data-types/json -summary: Returns the number of keys in JSON objects at the paths matching a given path expression +summary: Returns the number of keys of the object at path syntax_fmt: JSON.OBJLEN key [path] title: JSON.OBJLEN --- diff --git a/content/commands/json.strappend.md b/content/commands/json.strappend.md index c91151c810..0d5d409827 100644 --- a/content/commands/json.strappend.md +++ b/content/commands/json.strappend.md @@ -31,7 +31,7 @@ module: JSON railroad_diagram: /images/railroad/json.strappend.svg since: 1.0.0 stack_path: docs/data-types/json -summary: Appends a string to JSON strings at the paths matching a given path expression +summary: Appends a string to a JSON string value at path syntax_fmt: JSON.STRAPPEND key [path] value title: JSON.STRAPPEND --- diff --git a/content/commands/json.strlen.md b/content/commands/json.strlen.md index 815e58700d..96e0ddc73a 100644 --- a/content/commands/json.strlen.md +++ b/content/commands/json.strlen.md @@ -21,7 +21,8 @@ categories: - clients complexity: O(1) when path is evaluated to a single value, O(N) when path is evaluated to multiple values, where N is the size of the key -description: Returns the length of JSON strings at the paths matching a given path expression +description: Returns the length of JSON strings at the paths matching a given path + expression group: json hidden: false linkTitle: JSON.STRLEN @@ -29,7 +30,7 @@ module: JSON railroad_diagram: /images/railroad/json.strlen.svg since: 1.0.0 stack_path: docs/data-types/json -summary: Returns the length of JSON strings at the paths matching a given path expression +summary: Returns the length of the JSON String at path in key syntax_fmt: JSON.STRLEN key [path] title: JSON.STRLEN --- diff --git a/content/commands/msetex.md b/content/commands/msetex.md index 68506d9989..2b72d8e3b8 100644 --- a/content/commands/msetex.md +++ b/content/commands/msetex.md @@ -95,7 +95,8 @@ linkTitle: MSETEX railroad_diagram: /images/railroad/msetex.svg since: 8.4.0 summary: Atomically sets multiple string keys with a shared expiration in a single - operation. + operation. Supports flexible argument parsing where condition and expiration flags + can appear in any order. syntax_fmt: "MSETEX numkeys key value [key value ...] [NX | XX] [EX\_seconds |\n \ \ PX\_milliseconds | EXAT\_unix-time-seconds |\n PXAT\_unix-time-milliseconds |\ \ KEEPTTL]" diff --git a/content/commands/set.md b/content/commands/set.md index cff7dc2b82..54dec6dd1d 100644 --- a/content/commands/set.md +++ b/content/commands/set.md @@ -130,9 +130,9 @@ railroad_diagram: /images/railroad/set.svg since: 1.0.0 summary: Sets the string value of a key, ignoring its type. The key is created if it doesn't exist. -syntax_fmt: "SET key value [NX | XX | IFEQ\_ifeq-value | IFNE\_ifne-value |\n\ - \ IFDEQ\_ifdeq-digest | IFDNE\_ifdne-digest] [GET] [EX\_seconds |\n PX\_milliseconds\ - \ | EXAT\_unix-time-seconds |\n PXAT\_unix-time-milliseconds | KEEPTTL]" +syntax_fmt: "SET key value [NX | XX | IFEQ\_ifeq-value | IFNE\_ifne-value |\n IFDEQ\_\ + ifdeq-digest | IFDNE\_ifdne-digest] [GET] [EX\_seconds |\n PX\_milliseconds | EXAT\_\ + unix-time-seconds |\n PXAT\_unix-time-milliseconds | KEEPTTL]" title: SET --- diff --git a/content/commands/tdigest.byrank.md b/content/commands/tdigest.byrank.md index ed93e00b0c..263b869233 100644 --- a/content/commands/tdigest.byrank.md +++ b/content/commands/tdigest.byrank.md @@ -18,7 +18,7 @@ categories: - oss - kubernetes - clients -complexity: O(1) +complexity: O(N) where N is the number of ranks specified description: Returns, for each input rank, a floating-point estimation of the value with that rank group: tdigest diff --git a/content/commands/tdigest.byrevrank.md b/content/commands/tdigest.byrevrank.md index d33048b291..c56501ecc5 100644 --- a/content/commands/tdigest.byrevrank.md +++ b/content/commands/tdigest.byrevrank.md @@ -18,7 +18,7 @@ categories: - oss - kubernetes - clients -complexity: O(1) +complexity: O(N) where N is the number of reverse ranks specified. description: Returns, for each input reverse rank, an estimation of the floating-point value with that reverse rank group: tdigest diff --git a/content/commands/tdigest.quantile.md b/content/commands/tdigest.quantile.md index dfeebf7f66..9ea1e3ea3a 100644 --- a/content/commands/tdigest.quantile.md +++ b/content/commands/tdigest.quantile.md @@ -18,7 +18,7 @@ categories: - oss - kubernetes - clients -complexity: O(1) +complexity: O(N) where N is the number of quantiles specified. description: Returns, for each input fraction, a floating-point estimation of the value that is smaller than the given fraction of observations group: tdigest diff --git a/content/commands/tdigest.rank.md b/content/commands/tdigest.rank.md index c33efd9717..e27566b3b7 100644 --- a/content/commands/tdigest.rank.md +++ b/content/commands/tdigest.rank.md @@ -18,7 +18,7 @@ categories: - oss - kubernetes - clients -complexity: O(1) +complexity: O(N) where N is the number of values specified. description: Returns, for each floating-point input value, the estimated rank of the value (the number of observations in the sketch that are smaller than the value + half the number of observations that are equal to the value) diff --git a/content/commands/tdigest.revrank.md b/content/commands/tdigest.revrank.md index d5c1e3de61..a58e318a07 100644 --- a/content/commands/tdigest.revrank.md +++ b/content/commands/tdigest.revrank.md @@ -18,7 +18,7 @@ categories: - oss - kubernetes - clients -complexity: O(1) +complexity: O(N) where N is the number of values specified. description: Returns, for each floating-point input value, the estimated reverse rank of the value (the number of observations in the sketch that are larger than the value + half the number of observations that are equal to the value) diff --git a/content/commands/topk.add.md b/content/commands/topk.add.md index e96321a683..cff8ad0990 100644 --- a/content/commands/topk.add.md +++ b/content/commands/topk.add.md @@ -20,7 +20,8 @@ categories: - kubernetes - clients complexity: O(n * k) where n is the number of items and k is the depth -description: Adds an item to a Top-k sketch. Multiple items can be added at the same time. +description: Adds an item to a Top-k sketch. Multiple items can be added at the same + time. group: topk hidden: false linkTitle: TOPK.ADD diff --git a/content/commands/topk.list.md b/content/commands/topk.list.md index 48dfd5126b..4e740cc813 100644 --- a/content/commands/topk.list.md +++ b/content/commands/topk.list.md @@ -20,7 +20,7 @@ categories: - oss - kubernetes - clients -complexity: O(k) where k is the value of top-k +complexity: O(k*log(k)) where k is the value of top-k description: Return the full list of items in the Top-K sketch group: topk hidden: false @@ -29,7 +29,7 @@ module: Bloom railroad_diagram: /images/railroad/topk.list.svg since: 2.0.0 stack_path: docs/data-types/probabilistic -summary: Return full list of items in Top K list +summary: Return the full list of items in Top-K sketch. syntax_fmt: TOPK.LIST key [WITHCOUNT] title: TOPK.LIST --- diff --git a/content/commands/topk.reserve.md b/content/commands/topk.reserve.md index 478fe32801..8d0290e24c 100644 --- a/content/commands/topk.reserve.md +++ b/content/commands/topk.reserve.md @@ -37,7 +37,7 @@ module: Bloom railroad_diagram: /images/railroad/topk.reserve.svg since: 2.0.0 stack_path: docs/data-types/probabilistic -summary: Initializes a TopK with specified parameters +summary: Initializes a Top-K sketch with specified parameters syntax_fmt: TOPK.RESERVE key topk [width depth decay] title: TOPK.RESERVE --- diff --git a/content/commands/ts.alter.md b/content/commands/ts.alter.md index 73446b8436..db1cb71292 100644 --- a/content/commands/ts.alter.md +++ b/content/commands/ts.alter.md @@ -37,7 +37,6 @@ arguments: optional: true token: DUPLICATE_POLICY type: oneof - - arguments: - name: label type: string @@ -73,7 +72,7 @@ summary: Update the retention, chunk size, duplicate policy, and labels of an ex syntax: "TS.ALTER key \n [RETENTION retentionPeriod] \n [CHUNK_SIZE size] \n [DUPLICATE_POLICY\ \ policy] \n [LABELS [label value ...]]\n" syntax_fmt: "TS.ALTER key [RETENTION\_retentionPeriod] [CHUNK_SIZE\_size]\n [DUPLICATE_POLICY\_\ - ] [LABELS\_label value\n [label value ...]]" + ]\n [LABELS\_label value [label value ...]]" title: TS.ALTER --- diff --git a/content/commands/ts.create.md b/content/commands/ts.create.md index 05fd7b8e8b..dc43205a28 100644 --- a/content/commands/ts.create.md +++ b/content/commands/ts.create.md @@ -48,15 +48,6 @@ arguments: optional: true token: DUPLICATE_POLICY type: oneof -- arguments: - - name: ignoreMaxTimediff - type: integer - - name: ignoreMaxValDiff - type: double - name: ignore - optional: true - token: IGNORE - type: block - arguments: - name: label type: string diff --git a/content/commands/ts.createrule.md b/content/commands/ts.createrule.md index 77c4376058..1c9adb2502 100644 --- a/content/commands/ts.createrule.md +++ b/content/commands/ts.createrule.md @@ -49,11 +49,11 @@ arguments: since: 1.8.0 token: TWA type: pure-token - - name: countNaN + - name: countnan since: 8.6.0 token: COUNTNAN type: pure-token - - name: countAll + - name: countall since: 8.6.0 token: COUNTALL type: pure-token @@ -89,8 +89,8 @@ summary: Create a compaction rule syntax: "TS.CREATERULE sourceKey destKey \n AGGREGATION aggregator bucketDuration\ \ \n [alignTimestamp]\n" syntax_fmt: "TS.CREATERULE sourceKey destKey AGGREGATION\_ bucketDuration\ - \ [alignTimestamp]" + \ MIN | MAX | SUM | RANGE | COUNT | STD.P | STD.S | VAR.P | VAR.S |\n TWA | COUNTNAN\ + \ | COUNTALL> bucketDuration [alignTimestamp]" title: TS.CREATERULE --- {{< note >}} diff --git a/content/commands/ts.decrby.md b/content/commands/ts.decrby.md index 362acc6f5b..039b0f76f2 100644 --- a/content/commands/ts.decrby.md +++ b/content/commands/ts.decrby.md @@ -24,38 +24,6 @@ arguments: optional: true token: CHUNK_SIZE type: integer -- arguments: - - name: block - token: BLOCK - type: pure-token - - name: first - token: FIRST - type: pure-token - - name: last - token: LAST - type: pure-token - - name: min - token: MIN - type: pure-token - - name: max - token: MAX - type: pure-token - - name: sum - token: SUM - type: pure-token - name: policy - optional: true - token: DUPLICATE_POLICY - type: oneof -- arguments: - - name: ignoreMaxTimediff - type: integer - - name: ignoreMaxValDiff - type: double - name: ignore - optional: true - token: IGNORE - type: block - arguments: - name: label type: string diff --git a/content/commands/ts.incrby.md b/content/commands/ts.incrby.md index 69b3692278..1f767051a4 100644 --- a/content/commands/ts.incrby.md +++ b/content/commands/ts.incrby.md @@ -24,38 +24,6 @@ arguments: optional: true token: CHUNK_SIZE type: integer -- arguments: - - name: block - token: BLOCK - type: pure-token - - name: first - token: FIRST - type: pure-token - - name: last - token: LAST - type: pure-token - - name: min - token: MIN - type: pure-token - - name: max - token: MAX - type: pure-token - - name: sum - token: SUM - type: pure-token - name: policy - optional: true - token: DUPLICATE_POLICY - type: oneof -- arguments: - - name: ignoreMaxTimediff - type: integer - - name: ignoreMaxValDiff - type: double - name: ignore - optional: true - token: IGNORE - type: block - arguments: - name: label type: string diff --git a/content/commands/ts.mget.md b/content/commands/ts.mget.md index 350fae8ecd..17b3375041 100644 --- a/content/commands/ts.mget.md +++ b/content/commands/ts.mget.md @@ -63,7 +63,7 @@ since: 1.0.0 stack_path: docs/data-types/timeseries summary: Get the sample with the highest timestamp from each time series matching a specific filter -syntax: "TS.MGET [LATEST] [WITHLABELS | ] FILTER filterExpr..." +syntax: TS.MGET [LATEST] [WITHLABELS | ] FILTER filterExpr... syntax_fmt: "TS.MGET [LATEST] [WITHLABELS | SELECTED_LABELS label1 [label1 ...]]\n\ \ FILTER\_" diff --git a/content/commands/ts.mrange.md b/content/commands/ts.mrange.md index b016ad17a2..3a95de8b80 100644 --- a/content/commands/ts.mrange.md +++ b/content/commands/ts.mrange.md @@ -94,6 +94,14 @@ arguments: since: 1.8.0 token: TWA type: pure-token + - name: countnan + since: 8.6.0 + token: COUNTNAN + type: pure-token + - name: countall + since: 8.6.0 + token: COUNTALL + type: pure-token name: aggregator token: AGGREGATION type: oneof @@ -170,10 +178,10 @@ syntax: "TS.MRANGE fromTimestamp toTimestamp\n [LATEST]\n [FILTER_BY_TS ts...] syntax_fmt: "TS.MRANGE fromTimestamp toTimestamp [LATEST] [FILTER_BY_TS\_Timestamp\n\ \ [Timestamp ...]] [FILTER_BY_VALUE min max] [WITHLABELS |\n SELECTED_LABELS label1\ \ [label1 ...]] [COUNT\_count] [[ALIGN\_value]\n AGGREGATION\_ bucketDuration\n\ - \ [BUCKETTIMESTAMP] [EMPTY]] FILTER\_\ - \ [GROUPBY label REDUCE\n reducer]" + \ | MIN | MAX | SUM | RANGE | COUNT\n | STD.P | STD.S | VAR.P | VAR.S | TWA | COUNTNAN\ + \ | COUNTALL>\n bucketDuration [BUCKETTIMESTAMP] [EMPTY]] FILTER\_ [GROUPBY label REDUCE\n reducer]" title: TS.MRANGE --- {{< note >}} diff --git a/content/commands/ts.mrevrange.md b/content/commands/ts.mrevrange.md index 55f5fca968..9879c3cc62 100644 --- a/content/commands/ts.mrevrange.md +++ b/content/commands/ts.mrevrange.md @@ -8,10 +8,11 @@ arguments: type: string - name: toTimestamp type: string -- name: LATEST +- name: latest optional: true since: 1.8.0 - type: string + token: LATEST + type: pure-token - multiple: true name: Timestamp optional: true @@ -94,6 +95,14 @@ arguments: since: 1.8.0 token: TWA type: pure-token + - name: countnan + since: 8.6.0 + token: COUNTNAN + type: pure-token + - name: countall + since: 8.6.0 + token: COUNTALL + type: pure-token name: aggregator token: AGGREGATION type: oneof @@ -170,10 +179,10 @@ syntax: "TS.MREVRANGE fromTimestamp toTimestamp\n [LATEST]\n [FILTER_BY_TS ts. syntax_fmt: "TS.MREVRANGE fromTimestamp toTimestamp [LATEST]\n [FILTER_BY_TS\_Timestamp\ \ [Timestamp ...]] [FILTER_BY_VALUE min max]\n [WITHLABELS | SELECTED_LABELS label1\ \ [label1 ...]] [COUNT\_count]\n [[ALIGN\_value] AGGREGATION\_\n\ - \ bucketDuration [BUCKETTIMESTAMP] [EMPTY]] FILTER\_ [GROUPBY label REDUCE\n reducer]" + \ | MIN | MAX | SUM |\n RANGE | COUNT | STD.P | STD.S | VAR.P | VAR.S | TWA | COUNTNAN\ + \ |\n COUNTALL> bucketDuration [BUCKETTIMESTAMP] [EMPTY]] FILTER\_ [GROUPBY label REDUCE\n reducer]" title: TS.MREVRANGE --- {{< note >}} diff --git a/content/commands/ts.queryindex.md b/content/commands/ts.queryindex.md index f01a09a34c..0ae2da8fd2 100644 --- a/content/commands/ts.queryindex.md +++ b/content/commands/ts.queryindex.md @@ -40,7 +40,7 @@ railroad_diagram: /images/railroad/ts.queryindex.svg since: 1.0.0 stack_path: docs/data-types/timeseries summary: Get all time series keys matching a filter list -syntax: "TS.QUERYINDEX filterExpr..." +syntax: TS.QUERYINDEX filterExpr... syntax_fmt: "TS.QUERYINDEX " title: TS.QUERYINDEX diff --git a/content/commands/ts.range.md b/content/commands/ts.range.md index 398a9ed1bc..046ddbd000 100644 --- a/content/commands/ts.range.md +++ b/content/commands/ts.range.md @@ -80,6 +80,14 @@ arguments: since: 1.8.0 token: TWA type: pure-token + - name: countnan + since: 8.6.0 + token: COUNTNAN + type: pure-token + - name: countall + since: 8.6.0 + token: COUNTALL + type: pure-token name: aggregator token: AGGREGATION type: oneof @@ -125,7 +133,7 @@ syntax: "TS.RANGE key fromTimestamp toTimestamp\n [LATEST]\n [FILTER_BY_TS ts. syntax_fmt: "TS.RANGE key fromTimestamp toTimestamp [LATEST]\n [FILTER_BY_TS\_Timestamp\ \ [Timestamp ...]] [FILTER_BY_VALUE min max]\n [COUNT\_count] [[ALIGN\_value] AGGREGATION\_\ \n bucketDuration [BUCKETTIMESTAMP] [EMPTY]]" + \ | VAR.S | TWA\n | COUNTNAN | COUNTALL> bucketDuration [BUCKETTIMESTAMP] [EMPTY]]" title: TS.RANGE --- diff --git a/content/commands/ts.revrange.md b/content/commands/ts.revrange.md index 450f590d8c..656b955e66 100644 --- a/content/commands/ts.revrange.md +++ b/content/commands/ts.revrange.md @@ -80,16 +80,43 @@ arguments: since: 1.8.0 token: TWA type: pure-token + - name: countnan + since: 8.6.0 + token: COUNTNAN + type: pure-token + - name: countall + since: 8.6.0 + token: COUNTALL + type: pure-token name: aggregator token: AGGREGATION type: oneof - name: bucketDuration type: integer - - name: buckettimestamp + - arguments: + - name: '-' + token: '-' + type: pure-token + - name: start + token: start + type: pure-token + - name: + + token: + + type: pure-token + - name: end + token: end + type: pure-token + - name: '~' + token: '~' + type: pure-token + - name: mid + token: mid + type: pure-token + name: buckettimestamp optional: true since: 1.8.0 token: BUCKETTIMESTAMP - type: pure-token + type: oneof - name: empty optional: true since: 1.8.0 @@ -125,7 +152,8 @@ syntax: "TS.REVRANGE key fromTimestamp toTimestamp\n [LATEST]\n [FILTER_BY_TS syntax_fmt: "TS.REVRANGE key fromTimestamp toTimestamp [LATEST]\n [FILTER_BY_TS\_\ Timestamp [Timestamp ...]] [FILTER_BY_VALUE min max]\n [COUNT\_count] [[ALIGN\_\ value] AGGREGATION\_\n bucketDuration [BUCKETTIMESTAMP] [EMPTY]]" + \ | STD.S | VAR.P | VAR.S | TWA\n | COUNTNAN | COUNTALL> bucketDuration [BUCKETTIMESTAMP\_\ + <- | start\n | + | end | ~ | mid>] [EMPTY]]" title: TS.REVRANGE --- diff --git a/content/commands/vadd.md b/content/commands/vadd.md index b5c20d2279..810fbc4ff6 100644 --- a/content/commands/vadd.md +++ b/content/commands/vadd.md @@ -1,4 +1,71 @@ --- +arguments: +- display_text: key + key_spec_index: 0 + name: key + type: key +- arguments: + - display_text: dim + name: dim + type: integer + name: reduce + optional: true + token: REDUCE + type: block +- arguments: + - display_text: fp32 + name: fp32 + token: FP32 + type: pure-token + - display_text: values + name: values + token: VALUES + type: pure-token + name: format + type: oneof +- display_text: vector + name: vector + type: string +- display_text: element + name: element + type: string +- display_text: cas + name: cas + optional: true + token: CAS + type: pure-token +- arguments: + - display_text: noquant + name: noquant + token: NOQUANT + type: pure-token + - display_text: bin + name: bin + token: BIN + type: pure-token + - display_text: q8 + name: q8 + token: Q8 + type: pure-token + name: quant_type + optional: true + type: oneof +- display_text: build-exploration-factor + name: build-exploration-factor + optional: true + token: EF + type: integer +- display_text: attributes + name: attributes + optional: true + token: SETATTR + type: string +- display_text: numlinks + name: numlinks + optional: true + token: M + type: integer +arity: -5 categories: - docs - develop @@ -9,15 +76,38 @@ categories: - oss - kubernetes - clients -complexity: O(log(N)) for each element added, where N is the number of elements in the vector set. -description: Add a new element to a vector set, or update its vector if it already exists. -group: vector_set +command_flags: +- write +- denyoom +- module +complexity: O(log(N)) for each element added, where N is the number of elements in + the vector set. +description: Add a new element to a vector set, or update its vector if it already + exists. +group: module hidden: false +key_specs: +- RW: true + access: true + begin_search: + spec: + index: 1 + type: index + find_keys: + spec: + keystep: 1 + lastkey: 0 + limit: 0 + type: range + update: true linkTitle: VADD +module: vectorset railroad_diagram: /images/railroad/vadd.svg since: 8.0.0 -summary: Add a new element to a vector set, or update its vector if it already exists. -syntax_fmt: "VADD key [REDUCE dim] (FP32 | VALUES num) vector element [CAS] [NOQUANT | Q8 | BIN]\n [EF build-exploration-factor] [SETATTR attributes] [M numlinks]" +summary: Add one or more elements to a vector set, or update its vector if it already + exists +syntax_fmt: "VADD key [REDUCE\_dim] vector element [CAS] [NOQUANT\n\ + \ | BIN | Q8] [EF\_build-exploration-factor] [SETATTR\_attributes]\n [M\_numlinks]" title: VADD --- diff --git a/content/commands/vcard.md b/content/commands/vcard.md index e385628302..ddbac79a83 100644 --- a/content/commands/vcard.md +++ b/content/commands/vcard.md @@ -1,4 +1,10 @@ --- +arguments: +- display_text: key + key_spec_index: 0 + name: key + type: key +arity: 2 categories: - docs - develop @@ -9,15 +15,34 @@ categories: - oss - kubernetes - clients +command_flags: +- readonly +- module +- fast complexity: O(1) description: Return the number of elements in a vector set. -group: vector_set +group: module hidden: false +key_specs: +- RW: true + access: true + begin_search: + spec: + index: 1 + type: index + find_keys: + spec: + keystep: 1 + lastkey: 0 + limit: 0 + type: range + update: true linkTitle: VCARD +module: vectorset railroad_diagram: /images/railroad/vcard.svg since: 8.0.0 -summary: Return the number of elements in a vector set. -syntax_fmt: "VCARD key" +summary: Return the number of elements in a vector set +syntax_fmt: VCARD key title: VCARD --- diff --git a/content/commands/vdim.md b/content/commands/vdim.md index 601a1d70cf..a7a54d85ee 100644 --- a/content/commands/vdim.md +++ b/content/commands/vdim.md @@ -1,4 +1,10 @@ --- +arguments: +- display_text: key + key_spec_index: 0 + name: key + type: key +arity: 2 categories: - docs - develop @@ -9,15 +15,34 @@ categories: - oss - kubernetes - clients +command_flags: +- readonly +- module +- fast complexity: O(1) description: Return the dimension of vectors in the vector set. -group: vector_set +group: module hidden: false +key_specs: +- RW: true + access: true + begin_search: + spec: + index: 1 + type: index + find_keys: + spec: + keystep: 1 + lastkey: 0 + limit: 0 + type: range + update: true linkTitle: VDIM +module: vectorset railroad_diagram: /images/railroad/vdim.svg since: 8.0.0 -summary: Return the dimension of vectors in the vector set. -syntax_fmt: "VDIM key" +summary: Return the dimension of vectors in the vector set +syntax_fmt: VDIM key title: VDIM --- diff --git a/content/commands/vemb.md b/content/commands/vemb.md index 5e46c945ff..4969c3ca62 100644 --- a/content/commands/vemb.md +++ b/content/commands/vemb.md @@ -1,4 +1,18 @@ --- +arguments: +- display_text: key + key_spec_index: 0 + name: key + type: key +- display_text: element + name: element + type: string +- display_text: raw + name: raw + optional: true + token: RAW + type: pure-token +arity: -3 categories: - docs - develop @@ -9,15 +23,34 @@ categories: - oss - kubernetes - clients +command_flags: +- readonly +- module +- fast complexity: O(1) description: Return the vector associated with an element. -group: vector_set +group: module hidden: false +key_specs: +- RW: true + access: true + begin_search: + spec: + index: 1 + type: index + find_keys: + spec: + keystep: 1 + lastkey: 0 + limit: 0 + type: range + update: true linkTitle: VEMB +module: vectorset railroad_diagram: /images/railroad/vemb.svg since: 8.0.0 -summary: Return the vector associated with an element. -syntax_fmt: "VEMB key element [RAW]" +summary: Return the vector associated with an element +syntax_fmt: VEMB key element [RAW] title: VEMB --- diff --git a/content/commands/vgetattr.md b/content/commands/vgetattr.md index 562604b2a0..094c51673b 100644 --- a/content/commands/vgetattr.md +++ b/content/commands/vgetattr.md @@ -1,4 +1,13 @@ --- +arguments: +- display_text: key + key_spec_index: 0 + name: key + type: key +- display_text: element + name: element + type: string +arity: 3 categories: - docs - develop @@ -9,15 +18,34 @@ categories: - oss - kubernetes - clients +command_flags: +- readonly +- module +- fast complexity: O(1) description: Retrieve the JSON attributes of elements. -group: vector_set +group: module hidden: false +key_specs: +- RW: true + access: true + begin_search: + spec: + index: 1 + type: index + find_keys: + spec: + keystep: 1 + lastkey: 0 + limit: 0 + type: range + update: true linkTitle: VGETATTR +module: vectorset railroad_diagram: /images/railroad/vgetattr.svg since: 8.0.0 -summary: Retrieve the JSON attributes of elements. -syntax_fmt: "VGETATTR key element" +summary: Retrieve the JSON attributes of elements +syntax_fmt: VGETATTR key element title: VGETATTR --- diff --git a/content/commands/vinfo.md b/content/commands/vinfo.md index 7da1ab96e5..449c74d98c 100644 --- a/content/commands/vinfo.md +++ b/content/commands/vinfo.md @@ -1,4 +1,10 @@ --- +arguments: +- display_text: key + key_spec_index: 0 + name: key + type: key +arity: 2 categories: - docs - develop @@ -9,15 +15,34 @@ categories: - oss - kubernetes - clients +command_flags: +- readonly +- module +- fast complexity: O(1) description: Return information about a vector set. -group: vector_set +group: module hidden: false +key_specs: +- RW: true + access: true + begin_search: + spec: + index: 1 + type: index + find_keys: + spec: + keystep: 1 + lastkey: 0 + limit: 0 + type: range + update: true linkTitle: VINFO +module: vectorset railroad_diagram: /images/railroad/vinfo.svg since: 8.0.0 -summary: Return information about a vector set. -syntax_fmt: "VINFO key" +summary: Return information about a vector set +syntax_fmt: VINFO key title: VINFO --- diff --git a/content/commands/vismember.md b/content/commands/vismember.md index cbd2d55832..5744ba0f71 100644 --- a/content/commands/vismember.md +++ b/content/commands/vismember.md @@ -1,8 +1,11 @@ --- arguments: -- name: key +- display_text: key + key_spec_index: 0 + name: key type: key -- name: element +- display_text: element + name: element type: string arity: 3 categories: @@ -16,16 +19,32 @@ categories: - kubernetes - clients command_flags: -- READONLY +- readonly +- module complexity: O(1) description: Check if an element exists in a vector set. function: vismemberCommand -group: vector_set +group: module hidden: false +key_specs: +- RW: true + access: true + begin_search: + spec: + index: 1 + type: index + find_keys: + spec: + keystep: 1 + lastkey: 0 + limit: 0 + type: range + update: true linkTitle: VISMEMBER +module: vectorset railroad_diagram: /images/railroad/vismember.svg -since: 8.0.0 -summary: Check if an element exists in a vector set. +since: 8.2.0 +summary: Check if an element exists in a vector set syntax_fmt: VISMEMBER key element title: VISMEMBER --- diff --git a/content/commands/vlinks.md b/content/commands/vlinks.md index dd1044c5ca..9eaa2f7f2f 100644 --- a/content/commands/vlinks.md +++ b/content/commands/vlinks.md @@ -1,4 +1,18 @@ --- +arguments: +- display_text: key + key_spec_index: 0 + name: key + type: key +- display_text: element + name: element + type: string +- display_text: withscores + name: withscores + optional: true + token: WITHSCORES + type: pure-token +arity: -3 categories: - docs - develop @@ -9,15 +23,34 @@ categories: - oss - kubernetes - clients +command_flags: +- readonly +- module +- fast complexity: O(1) description: Return the neighbors of an element at each layer in the HNSW graph. -group: vector_set +group: module hidden: false +key_specs: +- RW: true + access: true + begin_search: + spec: + index: 1 + type: index + find_keys: + spec: + keystep: 1 + lastkey: 0 + limit: 0 + type: range + update: true linkTitle: VLINKS +module: vectorset railroad_diagram: /images/railroad/vlinks.svg since: 8.0.0 -summary: Return the neighbors of an element at each layer in the HNSW graph. -syntax_fmt: "VLINKS key element [WITHSCORES]" +summary: Return the neighbors of an element at each layer in the HNSW graph +syntax_fmt: VLINKS key element [WITHSCORES] title: VLINKS --- diff --git a/content/commands/vrandmember.md b/content/commands/vrandmember.md index 94ed7d7910..a4f37884da 100644 --- a/content/commands/vrandmember.md +++ b/content/commands/vrandmember.md @@ -1,4 +1,14 @@ --- +arguments: +- display_text: key + key_spec_index: 0 + name: key + type: key +- display_text: count + name: count + optional: true + type: integer +arity: -2 categories: - docs - develop @@ -9,15 +19,33 @@ categories: - oss - kubernetes - clients +command_flags: +- readonly +- module complexity: O(N) where N is the absolute value of the count argument. description: Return one or multiple random members from a vector set. -group: vector_set +group: module hidden: false +key_specs: +- RW: true + access: true + begin_search: + spec: + index: 1 + type: index + find_keys: + spec: + keystep: 1 + lastkey: 0 + limit: 0 + type: range + update: true linkTitle: VRANDMEMBER +module: vectorset railroad_diagram: /images/railroad/vrandmember.svg since: 8.0.0 -summary: Return one or multiple random members from a vector set. -syntax_fmt: "VRANDMEMBER key [count]" +summary: Return one or multiple random members from a vector set +syntax_fmt: VRANDMEMBER key [count] title: VRANDMEMBER --- diff --git a/content/commands/vrange.md b/content/commands/vrange.md index b24eee315f..6058e267e8 100644 --- a/content/commands/vrange.md +++ b/content/commands/vrange.md @@ -1,12 +1,17 @@ --- arguments: -- name: key +- display_text: key + key_spec_index: 0 + name: key type: key -- name: start +- display_text: start + name: start type: string -- name: end +- display_text: end + name: end type: string -- name: count +- display_text: count + name: count optional: true type: integer arity: -4 @@ -21,17 +26,33 @@ categories: - kubernetes - clients command_flags: -- READONLY +- readonly +- module complexity: O(log(K)+M) where K is the number of elements in the start prefix, and M is the number of elements returned. In practical terms, the command is just O(M) description: Return elements in a lexicographical range function: vrangeCommand -group: vector_set +group: module hidden: false +key_specs: +- RW: true + access: true + begin_search: + spec: + index: 1 + type: index + find_keys: + spec: + keystep: 1 + lastkey: 0 + limit: 0 + type: range + update: true linkTitle: VRANGE +module: vectorset railroad_diagram: /images/railroad/vrange.svg since: 8.4.0 -summary: Return elements in a lexicographical range +summary: Return vector set elements in a lex range syntax_fmt: VRANGE key start end [count] title: VRANGE --- diff --git a/content/commands/vrem.md b/content/commands/vrem.md index c5c4f2dbc1..901821ae83 100644 --- a/content/commands/vrem.md +++ b/content/commands/vrem.md @@ -1,4 +1,13 @@ --- +arguments: +- display_text: key + key_spec_index: 0 + name: key + type: key +- display_text: element + name: element + type: string +arity: 3 categories: - docs - develop @@ -9,15 +18,34 @@ categories: - oss - kubernetes - clients -complexity: O(log(N)) for each element removed, where N is the number of elements in the vector set. +command_flags: +- write +- module +complexity: O(log(N)) for each element removed, where N is the number of elements + in the vector set. description: Remove an element from a vector set. -group: vector_set +group: module hidden: false +key_specs: +- RW: true + access: true + begin_search: + spec: + index: 1 + type: index + find_keys: + spec: + keystep: 1 + lastkey: 0 + limit: 0 + type: range + update: true linkTitle: VREM +module: vectorset railroad_diagram: /images/railroad/vrem.svg since: 8.0.0 -summary: Remove an element from a vector set. -syntax_fmt: "VREM key element" +summary: Remove an element from a vector set +syntax_fmt: VREM key element title: VREM --- diff --git a/content/commands/vsetattr.md b/content/commands/vsetattr.md index 6b96597250..e7f49954ee 100644 --- a/content/commands/vsetattr.md +++ b/content/commands/vsetattr.md @@ -1,4 +1,16 @@ --- +arguments: +- display_text: key + key_spec_index: 0 + name: key + type: key +- display_text: element + name: element + type: string +- display_text: json + name: json + type: string +arity: 4 categories: - docs - develop @@ -9,15 +21,34 @@ categories: - oss - kubernetes - clients +command_flags: +- write +- module +- fast complexity: O(1) description: Associate or remove the JSON attributes of elements. -group: vector_set +group: module hidden: false +key_specs: +- RW: true + access: true + begin_search: + spec: + index: 1 + type: index + find_keys: + spec: + keystep: 1 + lastkey: 0 + limit: 0 + type: range + update: true linkTitle: VSETATTR +module: vectorset railroad_diagram: /images/railroad/vsetattr.svg since: 8.0.0 -summary: Associate or remove the JSON attributes of elements. -syntax_fmt: "VSETATTR key element \"{ JSON obj }\"" +summary: Associate or remove the JSON attributes of elements +syntax_fmt: VSETATTR key element json title: VSETATTR --- diff --git a/content/commands/vsim.md b/content/commands/vsim.md index b972e929c3..154e297216 100644 --- a/content/commands/vsim.md +++ b/content/commands/vsim.md @@ -1,4 +1,73 @@ --- +arguments: +- display_text: key + key_spec_index: 0 + name: key + type: key +- arguments: + - display_text: ele + name: ele + token: ELE + type: pure-token + - display_text: fp32 + name: fp32 + token: FP32 + type: pure-token + - display_text: values + name: values + token: VALUES + type: pure-token + name: format + type: oneof +- display_text: vector_or_element + name: vector_or_element + type: string +- display_text: withscores + name: withscores + optional: true + token: WITHSCORES + type: pure-token +- display_text: withattribs + name: withattribs + optional: true + token: WITHATTRIBS + type: pure-token +- display_text: count + name: count + optional: true + token: COUNT + type: integer +- display_text: max_distance + name: max_distance + optional: true + token: EPSILON + type: double +- display_text: search-exploration-factor + name: search-exploration-factor + optional: true + token: EF + type: integer +- display_text: expression + name: expression + optional: true + token: FILTER + type: string +- display_text: max-filtering-effort + name: max-filtering-effort + optional: true + token: FILTER-EF + type: integer +- display_text: truth + name: truth + optional: true + token: TRUTH + type: pure-token +- display_text: nothread + name: nothread + optional: true + token: NOTHREAD + type: pure-token +arity: -4 categories: - docs - develop @@ -9,18 +78,38 @@ categories: - oss - kubernetes - clients +command_flags: +- readonly +- module complexity: O(log(N)) where N is the number of elements in the vector set. description: Return elements by vector similarity. -group: vector_set +group: module hidden: false history: - - 8.2.0 - added the WITHATTRIBS option. +key_specs: +- RW: true + access: true + begin_search: + spec: + index: 1 + type: index + find_keys: + spec: + keystep: 1 + lastkey: 0 + limit: 0 + type: range + update: true linkTitle: VSIM +module: vectorset railroad_diagram: /images/railroad/vsim.svg since: 8.0.0 -summary: Return elements by vector similarity. -syntax_fmt: "VSIM key (ELE | FP32 | VALUES num) (vector | element) [WITHSCORES] [WITHATTRIBS] [COUNT num]\n [EPSILON delta] [EF search-exploration-factor] [FILTER expression] [FILTER-EF max-filtering-effort]\n [TRUTH] [NOTHREAD]" +summary: Return elements by vector similarity +syntax_fmt: "VSIM key vector_or_element [WITHSCORES]\n [WITHATTRIBS]\ + \ [COUNT\_count] [EPSILON\_max_distance]\n [EF\_search-exploration-factor] [FILTER\_\ + expression]\n [FILTER-EF\_max-filtering-effort] [TRUTH] [NOTHREAD]" title: VSIM --- diff --git a/content/commands/xackdel.md b/content/commands/xackdel.md index f2103dc11c..c250d18406 100644 --- a/content/commands/xackdel.md +++ b/content/commands/xackdel.md @@ -52,9 +52,9 @@ categories: command_flags: - write - fast -complexity: O(1) for each entry ID processed. -description: Acknowledges and conditionally deletes one or multiple entries for a stream consumer - group. +complexity: O(1) for each message ID processed. +description: Acknowledges and conditionally deletes one or multiple entries for a + stream consumer group. group: stream hidden: false key_specs: @@ -74,7 +74,7 @@ key_specs: linkTitle: XACKDEL railroad_diagram: /images/railroad/xackdel.svg since: 8.2.0 -summary: Acknowledges and conditionally deletes one or multiple entries for a stream consumer group. +summary: Acknowledges and deletes one or multiple messages for a stream consumer group. syntax_fmt: "XACKDEL key group [KEEPREF | DELREF | ACKED] IDS\_numids id [id ...]" title: XACKDEL --- diff --git a/content/commands/xadd.md b/content/commands/xadd.md index f26bdc4769..9c35c0e563 100644 --- a/content/commands/xadd.md +++ b/content/commands/xadd.md @@ -4,70 +4,89 @@ acl_categories: - '@stream' - '@fast' arguments: -- key_spec_index: 0 +- display_text: key + key_spec_index: 0 name: key type: key -- name: nomkstream +- display_text: nomkstream + name: nomkstream optional: true since: 6.2.0 token: NOMKSTREAM type: pure-token - arguments: - - name: keepref + - display_text: keepref + name: keepref token: KEEPREF type: pure-token - - name: delref + - display_text: delref + name: delref token: DELREF type: pure-token - - name: acked + - display_text: acked + name: acked token: ACKED type: pure-token name: condition optional: true type: oneof - arguments: - - display_text: producer-id - name: pid - token: IDMPAUTO - type: string - arguments: - - display_text: producer-id + - display_text: idmpauto-token + name: idmpauto-token + token: IDMPAUTO + type: pure-token + - display_text: pid + name: pid + type: string + name: idmpauto-with-pid + type: block + - arguments: + - display_text: idmp-token + name: idmp-token + token: IDMP + type: pure-token + - display_text: pid name: pid type: string - - display_text: idempotent-id + - display_text: iid name: iid type: string - name: idmp - token: IDMP + name: idmp-with-pid-iid type: block name: idmp optional: true - since: 8.6.0 type: oneof - arguments: - arguments: - - name: maxlen + - display_text: maxlen + name: maxlen token: MAXLEN type: pure-token - - name: minid + - display_text: minid + name: minid since: 6.2.0 token: MINID type: pure-token name: strategy type: oneof - arguments: - - name: equal + - display_text: equal + name: equal token: '=' type: pure-token - - name: approximately + - display_text: approximately + name: approximately token: '~' type: pure-token name: operator optional: true type: oneof - - name: threshold + - display_text: threshold + name: threshold type: string - - name: count + - display_text: count + name: count optional: true since: 6.2.0 token: LIMIT @@ -76,17 +95,21 @@ arguments: optional: true type: block - arguments: - - name: auto-id + - display_text: auto-id + name: auto-id token: '*' type: pure-token - - name: id + - display_text: id + name: id type: string name: id-selector type: oneof - arguments: - - name: field + - display_text: field + name: field type: string - - name: value + - display_text: value + name: value type: string multiple: true name: data @@ -121,23 +144,26 @@ history: - - 8.2.0 - Added the `KEEPREF`, `DELREF` and `ACKED` options. key_specs: -- begin_search: - index: - pos: 1 +- RW: true + begin_search: + spec: + index: 1 + type: index find_keys: - range: + spec: + keystep: 1 lastkey: 0 limit: 0 type: range notes: UPDATE instead of INSERT because of the optional trimming feature + update: true linkTitle: XADD railroad_diagram: /images/railroad/xadd.svg since: 5.0.0 summary: Appends a new message to a stream. Creates the key if it doesn't exist. -syntax_fmt: "XADD key [NOMKSTREAM] [KEEPREF | DELREF | ACKED]\n \ - \ [IDMPAUTO producer-id | IDMP producer-id idempotent-id]\n \ - \ [ [= | ~] threshold [LIMIT\_count]] <* | id>\n \ - \ field value [field value ...]" +syntax_fmt: "XADD key [NOMKSTREAM] [KEEPREF | DELREF | ACKED] [IDMPAUTO pid |\n IDMP\ + \ pid iid] [ [= | ~] threshold [LIMIT\_count]]\n <* | id> field\ + \ value [field value ...]" title: XADD --- diff --git a/content/commands/xcfgset.md b/content/commands/xcfgset.md index 0daf4c5ac0..87ad67f381 100644 --- a/content/commands/xcfgset.md +++ b/content/commands/xcfgset.md @@ -4,17 +4,32 @@ acl_categories: - '@stream' - '@fast' arguments: -- key_spec_index: 0 +- display_text: key + key_spec_index: 0 name: key type: key -- name: idmp-duration +- arguments: + - display_text: idmp-duration-token + name: idmp-duration-token + token: IDMP-DURATION + type: pure-token + - display_text: duration + name: duration + type: integer + name: idmp-duration-block optional: true - token: IDMP-DURATION - type: integer -- name: idmp-maxsize + type: block +- arguments: + - display_text: idmp-maxsize-token + name: idmp-maxsize-token + token: IDMP-MAXSIZE + type: pure-token + - display_text: maxsize + name: maxsize + type: integer + name: idmp-maxsize-block optional: true - token: IDMP-MAXSIZE - type: integer + type: block arity: -2 categories: - docs @@ -50,7 +65,7 @@ linkTitle: XCFGSET railroad_diagram: /images/railroad/xcfgset.svg since: 8.6.0 summary: Sets the IDMP configuration parameters for a stream. -syntax_fmt: "XCFGSET key [IDMP-DURATION\_idmp-duration]\n [IDMP-MAXSIZE\_idmp-maxsize]" +syntax_fmt: XCFGSET key [IDMP-DURATION duration] [IDMP-MAXSIZE maxsize] title: XCFGSET --- Sets the IDMP (Idempotent Message Processing) configuration parameters for a stream. This command configures how long idempotent IDs are retained and the maximum number of idempotent IDs tracked per producer. diff --git a/content/commands/xinfo-stream.md b/content/commands/xinfo-stream.md index c9ffd89e06..6bd0da6914 100644 --- a/content/commands/xinfo-stream.md +++ b/content/commands/xinfo-stream.md @@ -4,14 +4,17 @@ acl_categories: - '@stream' - '@slow' arguments: -- key_spec_index: 0 +- display_text: key + key_spec_index: 0 name: key type: key - arguments: - - name: full + - display_text: full + name: full token: FULL type: pure-token - - name: count + - display_text: count + name: count optional: true token: COUNT type: integer diff --git a/content/commands/xread.md b/content/commands/xread.md index aac44f8df3..e5c3e34e1a 100644 --- a/content/commands/xread.md +++ b/content/commands/xread.md @@ -44,9 +44,10 @@ command_flags: - blocking - movablekeys complexity: 'For each stream mentioned: O(M) with M being the number of elements returned. - If M is constant (for example, always asking for the first 10 elements with COUNT), you - can consider it O(1). On the other side when XREADGROUP blocks, XADD will pay the - O(N) time in order to serve the N clients blocked on the stream getting new data.' + If M is constant (for example, always asking for the first 10 elements with COUNT), + you can consider it O(1). On the other side when XREADGROUP blocks, XADD will pay + the O(N) time in order to serve the N clients blocked on the stream getting new + data.' description: Returns messages from multiple streams with IDs greater than the ones requested. Blocks until a message is available otherwise. group: stream diff --git a/content/commands/xtrim.md b/content/commands/xtrim.md index 2a8015cdca..96d827d2f7 100644 --- a/content/commands/xtrim.md +++ b/content/commands/xtrim.md @@ -42,6 +42,22 @@ arguments: since: 6.2.0 token: LIMIT type: integer + - arguments: + - display_text: keepref + name: keepref + token: KEEPREF + type: pure-token + - display_text: delref + name: delref + token: DELREF + type: pure-token + - display_text: acked + name: acked + token: ACKED + type: pure-token + name: condition + optional: true + type: oneof name: trim type: block arity: -4 @@ -68,6 +84,8 @@ hints: history: - - 6.2.0 - Added the `MINID` trimming strategy and the `LIMIT` option. +- - 8.2.0 + - Added the `KEEPREF`, `DELREF` and `ACKED` options. key_specs: - RW: true begin_search: @@ -85,7 +103,8 @@ linkTitle: XTRIM railroad_diagram: /images/railroad/xtrim.svg since: 5.0.0 summary: Deletes messages from the beginning of a stream. -syntax_fmt: "XTRIM key [= | ~] threshold [LIMIT\_count] [KEEPREF | DELREF | ACKED]" +syntax_fmt: "XTRIM key [= | ~] threshold [LIMIT\_count] [KEEPREF\n\ + \ | DELREF | ACKED]" title: XTRIM ---