Skip to content

Commit f903acb

Browse files
dwdoughertydwdougherty
committed
2nd commit
1 parent 188c98f commit f903acb

29 files changed

+149
-123
lines changed

‎content/commands/ft._list.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ FT._LIST
4949

5050
## Return information
5151

52-
{{< multitabs id=“ft-list-name-return-info"
52+
{{< multitabs id="ft-_list-return-info"
5353
tab1="RESP2"
5454
tab2="RESP3" >}}
5555

‎content/commands/ft.aggregate.md

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -354,12 +354,7 @@ You can use `@__score` in a pipeline as shown in the following example:
354354
selects the dialect version under which to execute the query. If not specified, the query will execute under the default dialect version set during module initial loading or via [`FT.CONFIG SET`]({{< relref "commands/ft.config-set/" >}}) command.
355355
</details>
356356

357-
## Return
358-
359-
FT.AGGREGATE returns an array reply where each row is an array reply and represents a single aggregate result.
360-
The [integer reply]({{< relref "develop/reference/protocol-spec#resp-integers" >}}) at position `1` does not represent a valid value.
361-
362-
### Return multiple values
357+
## Return multiple values
363358

364359
See [Return multiple values]({{< relref "commands/ft.search#return-multiple-values/" >}}) in [`FT.SEARCH`]({{< relref "commands/ft.search/" >}})
365360
The `DIALECT` can be specified as a parameter in the FT.AGGREGATE command. If it is not specified, the `DEFAULT_DIALECT` is used, which can be set using [`FT.CONFIG SET`]({{< relref "commands/ft.config-set/" >}}) or by passing it as an argument to the `redisearch` module when it is loaded.
@@ -491,23 +486,26 @@ Next, count GitHub events by user (actor), to produce the most active users.
491486

492487
## Return information
493488

494-
{{< multitabs id="ft-aggregate-return-info"
495-
tab1="RESP2"
489+
{{< multitabs id="ft-aggregate-return-info"
490+
tab1="RESP2"
496491
tab2="RESP3" >}}
497492

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.
493+
One of the following:
494+
* [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.
495+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: incorrect number of arguments, non-existent index, invalid query syntax.
499496

500497
-tab-sep-
501498

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
499+
One of the following:
500+
* [Map]({{< relref "/develop/reference/protocol-spec#maps" >}}) with the following fields:
501+
- `attributes`: [Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of attribute names.
502+
- `format`: [Simple string]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) - result format.
503+
- `results`: [Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of [maps]({{< relref "/develop/reference/protocol-spec#maps" >}}) containing aggregated data.
504+
- `total_results`: [Integer]({{< relref "/develop/reference/protocol-spec#integers" >}}) - total number of results.
505+
- `warning`: [Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of warning messages.
506+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: incorrect number of arguments, non-existent index, invalid query syntax.
508507

509508
{{< /multitabs >}}
510-
511509
## See also
512510

513511
[`FT.CONFIG SET`]({{< relref "commands/ft.config-set/" >}}) | [`FT.SEARCH`]({{< relref "commands/ft.search/" >}})
@@ -517,4 +515,3 @@ Next, count GitHub events by user (actor), to produce the most active users.
517515
- [Aggregations]({{< relref "/develop/ai/search-and-query/advanced-concepts/aggregations" >}})
518516
- [Key and field expiration behavior]({{< relref "/develop/ai/search-and-query/advanced-concepts/expiration" >}})
519517
- [RediSearch]({{< relref "/develop/ai/search-and-query" >}})
520-

‎content/commands/ft.aliasadd.md

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,6 @@ alias.
5050

5151
FT.ALIASADD allows administrators to transparently redirect application queries to alternative indexes.
5252

53-
## Return
54-
55-
FT.ALIASADD returns a simple string reply `OK` if executed correctly, or an error reply otherwise.
56-
5753
## Examples
5854

5955
<details open>
@@ -80,18 +76,17 @@ Attempting to add the same alias returns a message that the alias already exists
8076
tab1="RESP2"
8177
tab2="RESP3" >}}
8278

83-
[Simple string]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) reply.
79+
One of the following:
80+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}): `OK` if executed correctly.
81+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: alias already exists, index does not exist.
8482

8583
-tab-sep-
8684

87-
[Simple string]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) reply.
85+
One of the following:
86+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}): `OK` if executed correctly.
87+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: alias already exists, index does not exist.
8888

8989
{{< /multitabs >}}
90-
9190
## See also
9291

93-
[`FT.ALIASDEL`]({{< relref "commands/ft.aliasdel/" >}}) | [`FT.ALIASUPDATE`]({{< relref "commands/ft.aliasupdate/" >}})
94-
95-
## Related topics
96-
97-
[RediSearch]({{< relref "/develop/ai/search-and-query/" >}})
92+
[`FT.ALIASDEL`]({{< relref "commands/ft.aliasdel/" >}}) | [`FT.ALIASUPDATE`]({{< relref "commands/ft.aliasupdate/" >}})94-

‎content/commands/ft.aliasdel.md

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,6 @@ Remove an alias from an index
4343
is index alias to be removed.
4444
</details>
4545

46-
## Return
47-
48-
FT.ALIASDEL returns a simple string reply `OK` if executed correctly, or an error reply otherwise.
49-
5046
## Examples
5147

5248
<details open>
@@ -66,18 +62,17 @@ OK
6662
tab1="RESP2"
6763
tab2="RESP3" >}}
6864

69-
[Simple string]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) reply.
65+
One of the following:
66+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}): `OK` if executed correctly.
67+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: alias does not exist.
7068

7169
-tab-sep-
7270

73-
[Simple string]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) reply.
71+
One of the following:
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: alias does not exist.
7474

7575
{{< /multitabs >}}
76-
7776
## See also
7877

79-
[`FT.ALIASADD`]({{< relref "commands/ft.aliasadd/" >}}) | [`FT.ALIASUPDATE`]({{< relref "commands/ft.aliasupdate/" >}})
80-
81-
## Related topics
82-
83-
[RediSearch]({{< relref "/develop/ai/search-and-query/" >}})
78+
[`FT.ALIASADD`]({{< relref "commands/ft.aliasadd/" >}}) | [`FT.ALIASUPDATE`]({{< relref "commands/ft.aliasupdate/" >}})

‎content/commands/ft.aliasupdate.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,14 +68,17 @@ OK
6868
tab1="RESP2"
6969
tab2="RESP3" >}}
7070

71-
[Simple string]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) reply.
71+
One of the following:
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: index does not exist.
7274

7375
-tab-sep-
7476

75-
[Simple string]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) reply.
77+
One of the following:
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: index does not exist.
7680

7781
{{< /multitabs >}}
78-
7982
## See also
8083

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

‎content/commands/ft.alter.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,14 +102,17 @@ OK
102102
tab1="RESP2"
103103
tab2="RESP3" >}}
104104

105-
[Simple string]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) reply.
105+
One of the following:
106+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}): `OK` if executed correctly.
107+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: no such index, invalid schema syntax.
106108

107109
-tab-sep-
108110

109-
[Simple string]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) reply.
111+
One of the following:
112+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}): `OK` if executed correctly.
113+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: no such index, invalid schema syntax.
110114

111115
{{< /multitabs >}}
112-
113116
## See also
114117

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

‎content/commands/ft.config-get.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -142,8 +142,8 @@ FT.CONFIG GET returns an array reply of the configuration name and value.
142142

143143
## Return information
144144

145-
{{< multitabs id="ft-config-get-return-info"
146-
tab1="RESP2"
145+
{{< multitabs id="ft-config-get-return-info"
146+
tab1="RESP2"
147147
tab2="RESP3" >}}
148148

149149
[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.
@@ -153,7 +153,6 @@ FT.CONFIG GET returns an array reply of the configuration name and value.
153153
[Map]({{< relref "/develop/reference/protocol-spec#maps" >}}) where keys are configuration option names and values are their corresponding values.
154154

155155
{{< /multitabs >}}
156-
157156
## See also
158157

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

‎content/commands/ft.config-help.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,14 +71,13 @@ FT.CONFIG HELP returns an array reply of the configuration name and value.
7171
tab1="RESP2"
7272
tab2="RESP3" >}}
7373

74-
[Simple string]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) reply.
74+
[Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of help information.
7575

7676
-tab-sep-
7777

78-
[Simple string]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) reply.
78+
[Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of help information.
7979

8080
{{< /multitabs >}}
81-
8281
## See also
8382

8483
[`FT.CONFIG SET`]({{< relref "commands/ft.config-set/" >}}) | [`FT.CONFIG GET`]({{< relref "commands/ft.config-get/" >}})

‎content/commands/ft.config-set.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,14 +83,17 @@ OK
8383
tab1="RESP2"
8484
tab2="RESP3" >}}
8585

86-
[Simple string]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) reply.
86+
One of the following:
87+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}): `OK` if executed correctly.
88+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid option, invalid value.
8789

8890
-tab-sep-
8991

90-
[Simple string]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) reply.
92+
One of the following:
93+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}): `OK` if executed correctly.
94+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid option, invalid value.
9195

9296
{{< /multitabs >}}
93-
9497
## See also
9598

9699
[`FT.CONFIG GET`]({{< relref "commands/ft.config-get/" >}}) | [`FT.CONFIG HELP`]({{< relref "commands/ft.config-help/" >}})

‎content/commands/ft.create.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -469,14 +469,17 @@ The following example uses data similar to the hash examples above but uses JSON
469469
tab1="RESP2"
470470
tab2="RESP3" >}}
471471

472-
[Simple string]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) reply.
472+
One of the following:
473+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}): `OK` if executed correctly.
474+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: index already exists, invalid schema syntax.
473475

474476
-tab-sep-
475477

476-
[Simple string]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) reply.
478+
One of the following:
479+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}): `OK` if executed correctly.
480+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: index already exists, invalid schema syntax.
477481

478482
{{< /multitabs >}}
479-
480483
## See also
481484

482485
[`FT.ALTER`]({{< relref "commands/ft.alter/" >}}) | [`FT.DROPINDEX`]({{< relref "commands/ft.dropindex/" >}})

0 commit comments

Comments
 (0)