Skip to content

Commit

Permalink
Document version parameter
Browse files Browse the repository at this point in the history
  • Loading branch information
alex-spies committed Apr 16, 2024
1 parent 24da4dd commit d872eaa
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/track.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3138,12 +3138,13 @@ The operation returns no meta-data.
esql
~~~~~~~~~~~~~

With the operation type ``esql`` you can execute `ES|QL query <https://www.elastic.co/guide/en/elasticsearch/reference/master/esql.html>`_.
With the operation type ``esql`` you can execute an `ES|QL query <https://www.elastic.co/guide/en/elasticsearch/reference/current/esql.html>`_.

Properties
""""""""""

* ``query`` (mandatory): An ES|QL query starts with a source command followed processing commands.
* ``query`` (mandatory): An ES|QL query which starts with a source command followed by processing commands.
* ``version`` (optional): The version of the ES|QL query language. Defaults to the first released version, ``2024.04.01``. See the docs for `available versions <https://www.elastic.co/guide/en/elasticsearch/reference/master/esql-version.html>`_.
* ``filter`` (optional): A query filter defined in `Elasticsearch query DSL <https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html>`_.
* ``body`` (optional): The query body.

Expand All @@ -3153,6 +3154,7 @@ Example::
"name": "default",
"operation-type": "esql",
"query": "FROM logs-* | STATS count=count(*) BY agent.hostname | SORT count DESC | LIMIT 20",
"version": "2024.04.01",
"filter": {
"range": {
"timestamp": {
Expand Down

0 comments on commit d872eaa

Please sign in to comment.