Browse Source

ESQL: Mention EXPLAIN ANALYZE in profile docs (#114025) (#114029)

This mentions EXPLAIN ANALYZE and EXPLAIN PLAN in the docs for ESQL's
`profile` option. Those are things that folks from PostgreSQL and Oracle
are used to and might search for. And `profile` is the closest thing we
have to them.

EXPLAIN PLAN doesn't run the query - it just tells you what the plan is.
ESQL's `profile` always runs the query. So that's different. But it's
close!

EXPLAIN ANALYZE *does* run the query. It's pretty much the same.
Nik Everett 1 year ago
parent
commit
45f94e6f66
1 changed files with 5 additions and 1 deletions
  1. 5 1
      docs/reference/esql/esql-query-api.asciidoc

+ 5 - 1
docs/reference/esql/esql-query-api.asciidoc

@@ -79,6 +79,8 @@ For syntax, refer to <<esql-locale-param>>.
 (Optional, boolean) If provided and `true` the response will include an extra `profile` object
 with information about how the query was executed. It provides insight into the performance
 of each part of the query. This is for human debugging as the object's format might change at any time.
+Think of this like https://www.postgresql.org/docs/current/sql-explain.html[EXPLAIN ANALYZE] or
+https://docs.oracle.com/en/database/oracle/oracle-database/19/sqlrf/EXPLAIN-PLAN.html[EXPLAIN PLAN].
 
 `query`::
 (Required, string) {esql} query to run. For syntax, refer to <<esql-syntax>>.
@@ -109,4 +111,6 @@ 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 and can change at any time.
+The object itself is for human debugging and can change at any time. Think of this like
+https://www.postgresql.org/docs/current/sql-explain.html[EXPLAIN ANALYZE] or
+https://docs.oracle.com/en/database/oracle/oracle-database/19/sqlrf/EXPLAIN-PLAN.html[EXPLAIN PLAN].