Skip to content

Commit

Permalink
ESQL: Document the profile option
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
nik9000 committed Jul 10, 2024
1 parent 4d67414 commit eaa7ea1
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/reference/esql/esql-query-api.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,12 @@ For syntax, refer to <<esql-locale-param>>.
(Optional, array) Values for parameters in the `query`. For syntax, refer to
<<esql-rest-params>>.

`profile`::
(Optional, boolean) If provided and `true` the response will include an extra `profile` object
with information on how the query was executed. This information is for human debugging
and its format can change at any time but it can give some insight into the performance
of each part of the query.

`query`::
(Required, string) {esql} query to run. For syntax, refer to <<esql-syntax>>.

Expand All @@ -100,3 +106,8 @@ returned if `drop_null_columns` is sent with the request.
`rows`::
(array of arrays)
Values for the search results.

`profile`::
(object)
Profile describing the execution of the query. Only returned if `profile` was sent in the body.
The object itself is for human debugging can change at any time.

0 comments on commit eaa7ea1

Please sign in to comment.