Skip to content

Commit 188c98f

Browse files
committed
DEV: add RESP2/3 information to the RQE commands
1 parent dc15c3a commit 188c98f

32 files changed

+427
-9
lines changed

content/commands/cf.exists.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ redis> CF.EXISTS cf item2
5959
(integer) 0
6060
{{< / highlight >}}
6161

62+
## Return information
63+
6264
{{< multitabs id="cf-exists-return-info"
6365
tab1="RESP2"
6466
tab2="RESP3" >}}

content/commands/cms.info.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ redis> CMS.INFO test
4747
6) (integer) 0
4848
```
4949

50+
## Return information
51+
5052
{{< multitabs id=“cms-info-return-info"
5153
tab1="RESP2"
5254
tab2="RESP3" >}}

content/commands/cms.query.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ redis> CMS.QUERY test foo bar
4646
2) (integer) 42
4747
```
4848

49+
## Return information
50+
4951
{{< multitabs id=“cms-merge-return-info"
5052
tab1="RESP2"
5153
tab2="RESP3" >}}

content/commands/ft._list.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,25 @@ In the future, a [`SCAN`]({{< relref "/commands/scan" >}}) type of command will
3838
contains a large number of indices.
3939
{{% /alert %}}
4040

41-
## Return
42-
43-
[Array reply]({{< relref "/develop/reference/protocol-spec#arrays" >}}) with index names.
44-
4541
## Examples
4642

4743
```sql
4844
FT._LIST
4945
1) "idx"
5046
2) "movies"
5147
3) "imdb"
52-
```
48+
```
49+
50+
## Return information
51+
52+
{{< multitabs id=“ft-list-name-return-info"
53+
tab1="RESP2"
54+
tab2="RESP3" >}}
55+
56+
[Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of index names as [simple strings]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}).
57+
58+
-tab-sep-
59+
60+
[Set]({{< relref "/develop/reference/protocol-spec#sets" >}}) of index names as [simple strings]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}).
61+
62+
{{< /multitabs >}}

content/commands/ft.aggregate.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -489,9 +489,28 @@ Next, count GitHub events by user (actor), to produce the most active users.
489489

490490
</details>
491491

492+
## Return information
493+
494+
{{< multitabs id="ft-aggregate-return-info"
495+
tab1="RESP2"
496+
tab2="RESP3" >}}
497+
498+
[Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) with the first element being the total number of results, followed by result rows as [arrays]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of field-value pairs.
499+
500+
-tab-sep-
501+
502+
[Map]({{< relref "/develop/reference/protocol-spec#maps" >}}) with the following fields:
503+
- `total_results`: [Integer]({{< relref "/develop/reference/protocol-spec#integers" >}}) - total number of results
504+
- `results`: [Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of [maps]({{< relref "/develop/reference/protocol-spec#maps" >}}) containing aggregated data
505+
- `attributes`: [Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of attribute names
506+
- `format`: [Simple string]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) - result format
507+
- `warning`: [Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of warning messages
508+
509+
{{< /multitabs >}}
510+
492511
## See also
493512

494-
[`FT.CONFIG SET`]({{< relref "commands/ft.config-set/" >}}) | [`FT.SEARCH`]({{< relref "commands/ft.search/" >}})
513+
[`FT.CONFIG SET`]({{< relref "commands/ft.config-set/" >}}) | [`FT.SEARCH`]({{< relref "commands/ft.search/" >}})
495514

496515
## Related topics
497516

content/commands/ft.aliasadd.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,20 @@ Attempting to add the same alias returns a message that the alias already exists
7474
{{< / highlight >}}
7575
</details>
7676

77+
## Return information
78+
79+
{{< multitabs id="ft-aliasadd-return-info"
80+
tab1="RESP2"
81+
tab2="RESP3" >}}
82+
83+
[Simple string]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) reply.
84+
85+
-tab-sep-
86+
87+
[Simple string]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) reply.
88+
89+
{{< /multitabs >}}
90+
7791
## See also
7892

7993
[`FT.ALIASDEL`]({{< relref "commands/ft.aliasdel/" >}}) | [`FT.ALIASUPDATE`]({{< relref "commands/ft.aliasupdate/" >}})

content/commands/ft.aliasdel.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,20 @@ OK
6060
{{< / highlight >}}
6161
</details>
6262

63+
## Return information
64+
65+
{{< multitabs id="ft-aliasdel-return-info"
66+
tab1="RESP2"
67+
tab2="RESP3" >}}
68+
69+
[Simple string]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) reply.
70+
71+
-tab-sep-
72+
73+
[Simple string]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) reply.
74+
75+
{{< /multitabs >}}
76+
6377
## See also
6478

6579
[`FT.ALIASADD`]({{< relref "commands/ft.aliasadd/" >}}) | [`FT.ALIASUPDATE`]({{< relref "commands/ft.aliasupdate/" >}})

content/commands/ft.aliasupdate.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,20 @@ Update the alias of an index.
6262
OK
6363
{{< / highlight >}}
6464

65+
## Return information
66+
67+
{{< multitabs id="ft-aliasupdate-return-info"
68+
tab1="RESP2"
69+
tab2="RESP3" >}}
70+
71+
[Simple string]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) reply.
72+
73+
-tab-sep-
74+
75+
[Simple string]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) reply.
76+
77+
{{< /multitabs >}}
78+
6579
## See also
6680

6781
[`FT.ALIASADD`]({{< relref "commands/ft.aliasadd/" >}}) | [`FT.ALIASDEL`]({{< relref "commands/ft.aliasdel/" >}})

content/commands/ft.alter.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,20 @@ OK
9696
{{< / highlight >}}
9797
</details>
9898

99+
## Return information
100+
101+
{{< multitabs id="ft-alter-return-info"
102+
tab1="RESP2"
103+
tab2="RESP3" >}}
104+
105+
[Simple string]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) reply.
106+
107+
-tab-sep-
108+
109+
[Simple string]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) reply.
110+
111+
{{< /multitabs >}}
112+
99113
## See also
100114

101115
[`FT.CREATE`]({{< relref "commands/ft.create/" >}})

content/commands/ft.config-get.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,9 +140,23 @@ FT.CONFIG GET returns an array reply of the configuration name and value.
140140
{{< / highlight >}}
141141
</details>
142142

143+
## Return information
144+
145+
{{< multitabs id="ft-config-get-return-info"
146+
tab1="RESP2"
147+
tab2="RESP3" >}}
148+
149+
[Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of [arrays]({{< relref "/develop/reference/protocol-spec#arrays" >}}), where each sub-array contains a configuration option name and its value.
150+
151+
-tab-sep-
152+
153+
[Map]({{< relref "/develop/reference/protocol-spec#maps" >}}) where keys are configuration option names and values are their corresponding values.
154+
155+
{{< /multitabs >}}
156+
143157
## See also
144158

145-
[`FT.CONFIG SET`]({{< relref "commands/ft.config-set/" >}}) | [`FT.CONFIG HELP`]({{< relref "commands/ft.config-help/" >}})
159+
[`FT.CONFIG SET`]({{< relref "commands/ft.config-set/" >}}) | [`FT.CONFIG HELP`]({{< relref "commands/ft.config-help/" >}})
146160

147161
## Related topics
148162

0 commit comments

Comments
 (0)