Skip to content

Commit a0fcb77

Browse files
rrelledgerrelledge
committed
Merge branch 'main' into DOC-5333 
2 parents 76527ee + 1a919d1 commit a0fcb77

File tree

97 files changed

+3338
-837
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

97 files changed

+3338
-837
lines changed

‎config.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ rdi_redis_gears_version = "1.2.6"
5555
rdi_debezium_server_version = "2.3.0.Final"
5656
rdi_db_types = "cassandra|mysql|oracle|postgresql|sqlserver"
5757
rdi_cli_latest = "latest"
58-
rdi_current_version = "1.10.0"
58+
rdi_current_version = "1.12.0"
5959

6060
[params.clientsConfig]
6161
"Python"={quickstartSlug="redis-py"}

‎content/commands/cms.incrby.md‎

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,17 +45,30 @@ Increases the count of item by increment. Multiple items can be increased with o
4545
* **item**: The item which counter is to be increased.
4646
* **increment**: Amount by which the item counter is to be increased.
4747

48-
## Return
49-
50-
51-
[Array reply]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}) with an updated min-count of each of the items in the sketch.
52-
53-
Count of each item after increment.
54-
5548
## Examples
5649

5750
```
5851
redis> CMS.INCRBY test foo 10 bar 42
5952
1) (integer) 10
6053
2) (integer) 42
6154
```
55+
56+
## Return information
57+
58+
{{< multitabs id=“cms-incrby-return-info"
59+
tab1="RESP2"
60+
tab2="RESP3" >}}
61+
62+
One of the following:
63+
64+
* [Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of [integer replies]({{< relref "/develop/reference/protocol-spec#integers" >}}) representing updated min-counts of each of the provided items in the sketch.
65+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid arguments, missing key, overflow, or wrong key type.
66+
67+
-tab-sep-
68+
69+
One of the following:
70+
71+
* [Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of [integer replies]({{< relref "/develop/reference/protocol-spec#integers" >}}) representing updated min-counts of each of the provided items in the sketch.
72+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid arguments, missing key, overflow, or wrong key type.
73+
74+
{{< /multitabs >}}

‎content/commands/cms.info.md‎

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,6 @@ Returns width, depth and total count of the sketch.
3535

3636
* **key**: The name of the sketch.
3737

38-
## Return
39-
40-
[Array reply]({{< relref "/develop/reference/protocol-spec#arrays" >}}) with information of the filter.
41-
4238
## Examples
4339

4440
```
@@ -50,3 +46,21 @@ redis> CMS.INFO test
5046
5) count
5147
6) (integer) 0
5248
```
49+
50+
{{< multitabs id=“cms-info-return-info"
51+
tab1="RESP2"
52+
tab2="RESP3" >}}
53+
54+
One of the following:
55+
56+
* [Array reply]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of [simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) and [integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}) pairs containing sketch information.
57+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid arguments, missing key, or wrong key type.
58+
59+
-tab-sep-
60+
61+
One of the following:
62+
63+
* [Map reply]({{< relref "/develop/reference/protocol-spec#maps" >}}) of [simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) and [integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}) pairs containing sketch information.
64+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid arguments, missing key, or wrong key type.
65+
66+
{{< /multitabs >}}

‎content/commands/cms.initbydim.md‎

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,29 @@ Initializes a Count-Min Sketch to dimensions specified by user.
4242
* **depth**: Number of counter-arrays. Reduces the probability for an
4343
error of a certain size (percentage of total count).
4444

45-
## Return
46-
47-
[Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) - `OK` if executed correctly, or [] otherwise.
48-
4945
## Examples
5046

5147
```
5248
redis> CMS.INITBYDIM test 2000 5
5349
OK
54-
```
50+
```
51+
52+
## Return information
53+
54+
{{< multitabs id=“cms-initbydim-return-info"
55+
tab1="RESP2"
56+
tab2="RESP3" >}}
57+
58+
One of the following:
59+
60+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) `OK` if executed correctly.
61+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) if the given key already exists.
62+
63+
-tab-sep-
64+
65+
One of the following:
66+
67+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) `OK` if executed correctly.
68+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) if the given key already exists.
69+
70+
{{< /multitabs >}}

‎content/commands/cms.initbyprob.md‎

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,15 +44,31 @@ Initializes a Count-Min Sketch to accommodate requested tolerances.
4444
be a decimal value between 0 and 1. This effects the depth of the sketch.
4545
For example, for a desired false positive rate of 0.1% (1 in 1000),
4646
error_rate should be set to 0.001. The closer this number is to zero, the
47-
greater the memory consumption per item and the more CPU usage per operation.
48-
49-
## Return
50-
51-
[Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) - `OK` if executed correctly, or [] otherwise.
47+
greater the memory consumption per item and the more CPU usage per operation.
5248

5349
## Examples
5450

5551
```
5652
redis> CMS.INITBYPROB test 0.001 0.01
5753
OK
58-
```
54+
```
55+
56+
## Return information
57+
58+
{{< multitabs id=“cms-initbyprob-return-info"
59+
tab1="RESP2"
60+
tab2="RESP3" >}}
61+
62+
One of the following:
63+
64+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) `OK` if executed correctly.
65+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) if the given key already exists.
66+
67+
-tab-sep-
68+
69+
One of the following:
70+
71+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) `OK` if executed correctly.
72+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) if the given key already exists.
73+
74+
{{< /multitabs >}}

‎content/commands/cms.merge.md‎

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,13 +53,29 @@ Merges several sketches into one sketch. All sketches must have identical width
5353
* **src**: Names of source sketches to be merged.
5454
* **weight**: Multiple of each sketch. Default =1.
5555

56-
## Return
57-
58-
[Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) - `OK` if executed correctly, or [] otherwise.
59-
6056
## Examples
6157

6258
```
6359
redis> CMS.MERGE dest 2 test1 test2 WEIGHTS 1 3
6460
OK
6561
```
62+
63+
## Return information
64+
65+
{{< multitabs id=“cms-merge-return-info"
66+
tab1="RESP2"
67+
tab2="RESP3" >}}
68+
69+
One of the following:
70+
71+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) `OK` if executed correctly.
72+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: non-existent key or destination key is not of the same width and/or depth.
73+
74+
-tab-sep-
75+
76+
One of the following:
77+
78+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) `OK` if executed correctly.
79+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: non-existent key or destination key is not of the same width and/or depth.
80+
81+
{{< /multitabs >}}

‎content/commands/cms.query.md‎

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,16 +38,28 @@ Returns the count for one or more items in a sketch.
3838
* **key**: The name of the sketch.
3939
* **item**: One or more items for which to return the count.
4040

41-
## Return
42-
43-
Count of one or more items
44-
45-
[Array reply]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}) with a min-count of each of the items in the sketch.
46-
4741
## Examples
4842

4943
```
5044
redis> CMS.QUERY test foo bar
5145
1) (integer) 10
5246
2) (integer) 42
53-
```
47+
```
48+
49+
{{< multitabs id=“cms-merge-return-info"
50+
tab1="RESP2"
51+
tab2="RESP3" >}}
52+
53+
One of the following:
54+
55+
* [Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of [integer replies]({{< relref "/develop/reference/protocol-spec#integers" >}}) representing the min-counts of each of the provided items in the sketch.
56+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid arguments, missing key, or wrong key type.
57+
58+
-tab-sep-
59+
60+
One of the following:
61+
62+
* [Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of [integer replies]({{< relref "/develop/reference/protocol-spec#integers" >}}) representing the min-counts of each of the provided items in the sketch.
63+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid arguments, missing key, or wrong key type.
64+
65+
{{< /multitabs >}}

‎content/commands/ft.search.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -352,9 +352,9 @@ does not try to use stemming for query expansion but searches the query terms ve
352352
</details>
353353

354354
<details open>
355-
<summary><code>NOSTOPWORDS</code></summary>
355+
<summary><code>NOSTOPWORDS (deprecated)</code></summary>
356356

357-
ignores any defined stop words in full text searches.
357+
ignores any defined stop words in full text searches. Note: this option is deprecated as of Redis 8.0.
358358
</details>
359359

360360

‎content/commands/tdigest.add.md‎

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,16 +40,14 @@ Adds one or more observations to a t-digest sketch.
4040
## Required arguments
4141

4242
<details open><summary><code>key</code></summary>
43-
is key name for an existing t-digest sketch.
44-
</details>
4543

46-
<details open><summary><code>value</code></summary>
47-
is value of an observation (floating-point).
44+
is the key name for an existing t-digest sketch.
4845
</details>
4946

50-
## Return value
47+
<details open><summary><code>value</code></summary>
5148

52-
[Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) - `OK` if executed correctly, or [] otherwise.
49+
is the floating-point value of an observation.
50+
</details>
5351

5452
## Examples
5553

@@ -62,3 +60,23 @@ OK
6260
redis> TDIGEST.ADD t string
6361
(error) ERR T-Digest: error parsing val parameter
6462
{{< / highlight >}}
63+
64+
## Return information
65+
66+
{{< multitabs id=“tdigest-add-return-info"
67+
tab1="RESP2"
68+
tab2="RESP3" >}}
69+
70+
One of the following:
71+
72+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) `OK` if executed correctly.
73+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: the given key does not exist or the value parameter is of the incorrect type.
74+
75+
-tab-sep-
76+
77+
One of the following:
78+
79+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) `OK` if executed correctly.
80+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: the given key does not exist or the value parameter is of the incorrect type.
81+
82+
{{< /multitabs >}}

‎content/commands/tdigest.byrank.md‎

Lines changed: 37 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -19,51 +19,40 @@ categories:
1919
- kubernetes
2020
- clients
2121
complexity: O(N) where N is the number of ranks specified.
22-
description: Returns, for each input rank, an estimation of the value (floating-point)
22+
description: Returns, for each input rank, a floating-point estimation of the value
2323
with that rank
2424
group: tdigest
2525
hidden: false
2626
linkTitle: TDIGEST.BYRANK
2727
module: Bloom
2828
since: 2.4.0
2929
stack_path: docs/data-types/probabilistic
30-
summary: Returns, for each input rank, an estimation of the value (floating-point)
30+
summary: Returns, for each input rank, a floating-point estimation of the value
3131
with that rank
3232
syntax_fmt: TDIGEST.BYRANK key rank [rank ...]
3333
syntax_str: rank [rank ...]
3434
title: TDIGEST.BYRANK
3535
---
36-
Returns, for each input rank, an estimation of the value (floating-point) with that rank.
37-
38-
Multiple estimations can be retrieved in a signle call.
36+
Returns, for each input rank, a floating-point estimation of the value with that rank.
37+
Multiple estimations can be retrieved in a single call.
3938

4039
## Required arguments
4140

4241
<details open><summary><code>key</code></summary>
43-
is key name for an existing t-digest sketch.
42+
43+
is the key name of an existing t-digest sketch.
4444
</details>
4545

4646
<details open><summary><code>rank</code></summary>
4747

48-
Rank, for which the value should be retrieved.
48+
Ranks for which the values should be retrieved.
4949

5050
0 is the rank of the value of the smallest observation.
5151

52-
_n_-1 is the rank of the value of the largest observation; _n_ denotes the number of observations added to the sketch.
53-
52+
_n_-1 is the rank of the value of the largest observation, where _n_ denotes the number of observations that have been added to the sketch.
5453
</details>
5554

56-
## Return value
57-
58-
[Array reply]({{< relref "/develop/reference/protocol-spec#arrays" >}}) - an array of floating-points populated with value_1, value_2, ..., value_R:
59-
60-
- Return an accurate result when `rank` is 0 (the value of the smallest observation)
61-
- Return an accurate result when `rank` is _n_-1 (the value of the largest observation), where _n_ denotes the number of observations added to the sketch.
62-
- Return 'inf' when `rank` is equal to _n_ or larger than _n_
63-
64-
All values are 'nan' if the sketch is empty.
65-
66-
## Examples
55+
## Example
6756

6857
{{< highlight bash >}}
6958
redis> TDIGEST.CREATE t COMPRESSION 1000
@@ -88,3 +77,31 @@ redis> TDIGEST.BYRANK t 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
8877
15) "5"
8978
16) "inf"
9079
{{< / highlight >}}
80+
81+
## Return information
82+
83+
{{< multitabs id=“tdigest-byrank-return-info"
84+
tab1="RESP2"
85+
tab2="RESP3" >}}
86+
87+
One of the following:
88+
89+
* [Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of [bulk strings]({{< relref "/develop/reference/protocol-spec#bulk-strings" >}}) as floating-points, populated with value_1, value_2, ..., value_R:
90+
* an accurate result when `rank` is `0`, the value of the smallest observation.
91+
* an accurate result when `rank` is _n_-1, the value of the largest observation, where _n_ denotes the number of observations added to the sketch.
92+
* `inf` when `rank` is equal to _n_ or larger than _n_.
93+
* `nan` for all ranks when the given sketch is empty.
94+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: the given key does not exist or is of an incorrect type, rank parsing errors, or incorrect number of arguments.
95+
96+
-tab-sep-
97+
98+
One of the following:
99+
100+
* [Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of [doubles]({{< relref "/develop/reference/protocol-spec#doubles" >}}) as floating-points, populated with value_1, value_2, ..., value_R:
101+
* an accurate result when `rank` is `0`, the value of the smallest observation.
102+
* an accurate result when `rank` is _n_-1, the value of the largest observation, where _n_ denotes the number of observations added to the sketch.
103+
* `inf` when `rank` is equal to _n_ or larger than _n_.
104+
* `nan` for all ranks when the given sketch is empty.
105+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: the given key does not exist or is of an incorrect type, rank parsing errors, or incorrect number of arguments.
106+
107+
{{< /multitabs >}}

0 commit comments

Comments
 (0)