elasticsearch/docs/reference/esql/source-commands/from.asciidoc
Nhat Nguyen 863cbf6bb4
Add docs for cross cluster search in ES|QL(#105934)
This change adds a documentation for cross cluster search in ES|QL.

Relates #102954
Closes #105529
2024-03-07 13:15:01 -08:00

84 lines
1.6 KiB
Text

[discrete]
[[esql-from]]
=== `FROM`
**Syntax**
[source,esql]
----
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 <<esql-metadata-fields,metadata fields>> to retrieve.
*Description*
The `FROM` source command returns a table with data from a data stream, index,
or alias. Each row in the resulting table represents a document. Each column
corresponds to a field, and can be accessed by the name of that field.
[NOTE]
====
By default, an {esql} query without an explicit <<esql-limit>> uses an implicit
limit of 1000. This applies to `FROM` too. A `FROM` command without `LIMIT`:
[source,esql]
----
FROM employees
----
is executed as:
[source,esql]
----
FROM employees
| LIMIT 1000
----
====
*Examples*
[source,esql]
----
FROM employees
----
You can use <<api-date-math-index-names,date math>> to refer to indices, aliases
and data streams. This can be useful for time series data, for example to access
today's index:
[source,esql]
----
FROM <logs-{now/d}>
----
Use comma-separated lists or wildcards to query multiple data streams, indices,
or aliases:
[source,esql]
----
FROM employees-00001,other-employees-*
----
Use the format `<remote_cluster_name>:<target>` to query data streams and indices
on remote clusters:
[source,esql]
----
FROM cluster_one:employees-00001,cluster_two:other-employees-*
----
See <<esql-cross-clusters, using {esql} across clusters>>.
Use the optional `METADATA` directive to enable <<esql-metadata-fields,metadata fields>>:
[source,esql]
----
FROM employees METADATA _id
----