github-mirrors/elasticsearch
1
0
Fork 0
mirror of https://github.com/elastic/elasticsearch.git synced 2025-06-29 01:44:36 -04:00
Code Issues Projects Releases Packages Wiki Activity

ESQL: Add docs for the OPTIONS directive (#107013)

Browse source 
This adds the docs for the newly added `OPTIONS` directive to `FROM`.
This commit is contained in:
Bogdan Pintea 2024-04-03 16:23:36 +02:00 • committed by GitHub
parent 377c7e568f
commit f9ae6db319
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 76 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

14
docs/reference/esql/source-commands/from.asciidoc
View file

@ -6,7 +6,7 @@
[source,esql]
----
FROM index_pattern [METADATA fields]
FROM index_pattern [METADATA fields] [OPTIONS options]
----
*Parameters*
@ -17,6 +17,10 @@ A list of indices, data streams or aliases. Supports wildcards and date math.
`fields`::
A comma-separated list of <<esql-metadata-fields,metadata fields>> to retrieve.
`options`::
A comma-separated list of <<esql-index-options,index options>> to configure
data access.
*Description*
The `FROM` source command returns a table with data from a data stream, index,
@ -82,3 +86,11 @@ Use the optional `METADATA` directive to enable <<esql-metadata-fields,metadata
----
FROM employees METADATA _id
----
Use the optional `OPTIONS` directive to specify <<esql-index-options,index access options>>.
This directive must follow `METADATA`, if both are specified:
[source,esql]
----
FROM employees* METADATA _index OPTIONS "ignore_unavailable"="true"
----