Skip to content

DEV: restore FT.AGG return info disclaimer #2318

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 29, 2025
Merged

DEV: restore FT.AGG return info disclaimer #2318

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
263477b
DEV: restore FT.AGG return info disclaimer
dwdougherty Oct 29, 2025
b4d6d94
Apply code review comments
dwdougherty Oct 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 13 additions & 12 deletions content/commands/ft.aggregate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,12 +180,12 @@ stack_path: docs/interact/search-and-query
summary: Run a search query on an index and perform aggregate transformations on the
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] \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
\ \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] \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\
Expand Down Expand Up @@ -402,7 +402,7 @@ FT.AGGREGATE idx "@url:\"about.html\""
GROUPBY 2 @day @country
REDUCE count 0 AS num_visits
SORTBY 4 @day
{{< / highlight >}}
{{< /highlight >}}
</details>

<details open>
Expand All @@ -416,7 +416,7 @@ FT.AGGREGATE books-idx *
REDUCE COUNT 0 AS num_published
GROUPBY 0
REDUCE MAX 1 @num_published AS max_books_published_per_year
{{< / highlight >}}
{{< /highlight >}}
</details>

<details open>
Expand All @@ -430,7 +430,7 @@ Search for libraries within 10 kilometers of the longitude -73.982254 and latitu
FT.AGGREGATE libraries-idx "@location:[-73.982254 40.753181 10 km]"
LOAD 1 @location
APPLY "geodistance(@location, -73.982254, 40.753181)"
{{< / highlight >}}
{{< /highlight >}}

Here, notice the required use of `LOAD` to pre-load the `@location` attribute because it is a GEO attribute.

Expand Down Expand Up @@ -480,7 +480,7 @@ Next, count GitHub events by user (actor), to produce the most active users.
3) "num"
4) "2794"
(0.59s)
{{< / highlight >}}
{{< /highlight >}}

</details>

Expand All @@ -502,17 +502,18 @@ FT.AGGREGATE orders "*"
APPLY case(@status == "pending", 1, 0) AS is_pending
APPLY case(@is_pending == 1 && @priority == "high", 1,2) AS status_high
APPLY case(@is_pending == 0 && @priority == "high", 3,4) AS status_completed
{{< / highlight >}}
{{< /highlight >}}

</details>

## Return information

{{< multitabs id="ft-aggregate-return-info"
tab1="RESP2"
tab2="RESP3" >}}

One of the following:
* [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.
* [Array reply]({{< relref "/develop/reference/protocol-spec#arrays" >}}) where each row is an array reply representing a single aggregate result. The [integer reply]({{< relref "develop/reference/protocol-spec#resp-integers" >}}) at position `1` does not represent a valid value.
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: incorrect number of arguments, non-existent index, invalid query syntax.

-tab-sep-
Expand Down