Skip to content

Commit 8f93bd0

Browse files
authored
ESQL: Document the profile option (#110727)
This adds some basic documentation for the `profile` option in ESQL but doesn't really explain the results beyond "this is for human debugging." We're not ready for any kind of specification for this thing, but it is useful to look at.
1 parent 3e7f7f4 commit 8f93bd0

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/reference/esql/esql-query-api.asciidoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,11 @@ For syntax, refer to <<esql-locale-param>>.
7575
(Optional, array) Values for parameters in the `query`. For syntax, refer to
7676
<<esql-rest-params>>.
7777

78+
`profile`::
79+
(Optional, boolean) If provided and `true` the response will include an extra `profile` object
80+
with information about how the query was executed. It provides insight into the performance
81+
of each part of the query. This is for human debugging as the object's format might change at any time.
82+
7883
`query`::
7984
(Required, string) {esql} query to run. For syntax, refer to <<esql-syntax>>.
8085

@@ -100,3 +105,8 @@ returned if `drop_null_columns` is sent with the request.
100105
`rows`::
101106
(array of arrays)
102107
Values for the search results.
108+
109+
`profile`::
110+
(object)
111+
Profile describing the execution of the query. Only returned if `profile` was sent in the body.
112+
The object itself is for human debugging and can change at any time.

0 commit comments

Comments
 (0)