Skip to content

Commit

Permalink
[ES|QL] Cleanup FROM OPTIONS from documentation (#183586)
Browse files Browse the repository at this point in the history
## Summary

We decided to remove the FROM OPTIONS from ES|QL support
elastic/elasticsearch#108700. This PR:

- removes it from the inline docs
- removes it from the ai assistant docs
  • Loading branch information
stratoula authored May 16, 2024
1 parent 9d8b3d4 commit fd647ab
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 20 deletions.
10 changes: 0 additions & 10 deletions packages/kbn-text-based-editor/src/esql_documentation_sections.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -106,16 +106,6 @@ Also, similar to the index fields, once an aggregation is performed, a metadata
FROM employees [METADATA _index, _id]
| STATS max = MAX(emp_no) BY _index
\`\`\`
The \`OPTIONS\` directive of the FROM command allows you to configure the way ES|QL accesses the data to be queried. The argument passed to this directive is a comma-separated list of option name-value pairs, with the option name and the corresponding value double-quoted.
For example:
\`\`\`
FROM index_pattern [OPTIONS "option1"="value1"[,...[,"optionN"="valueN"]]]
\`\`\`
Learn more about the \`OPTIONS\` directive in the [main documentation page](https://www.elastic.co/guide/en/elasticsearch/reference/master/esql-index-options.html#esql-index-options).
`,
description:
'Text is in markdown. Do not translate function names, special characters, or field names like sum(bytes)',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,14 @@ FROM

Syntax
```esql
FROM index_pattern [METADATA fields] [OPTIONS options]
FROM index_pattern [METADATA fields]
```

Parameters
index_pattern
A list of indices, data streams or aliases. Supports wildcards and date math.
fields
A comma-separated list of metadata fields to retrieve.
options
A comma-separated list of index options to configure
data access.
DescriptionThe
```esql
FROM source command returns a table with data from a data stream, index,
Expand Down Expand Up @@ -64,9 +61,3 @@ See using ES|QL across clusters.Use the optional METADATA directive to enable me
```esql
FROM employees METADATA _id
```

Use the optional OPTIONS directive to specify index access options.
This directive must follow METADATA, if both are specified:
```esql
FROM employees* METADATA _index OPTIONS "ignore_unavailable"="true"
```

0 comments on commit fd647ab

Please sign in to comment.