Skip to content

Commit c60bc84

Browse files
authored
[DOCS] Move ESQL docs from docs-content repo (elastic#133301) (elastic#133459)
1 parent b11a7a8 commit c60bc84

16 files changed

+2153
-102
lines changed

docs/reference/query-languages/esql.md

Lines changed: 37 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,48 @@
22
navigation_title: "{{esql}}"
33
mapped_pages:
44
- https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-language.html
5+
- https://www.elastic.co/guide/en/elasticsearch/reference/current/esql.html
6+
- https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-getting-started.html
7+
- https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-using.html
8+
- https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-examples.html
9+
products:
10+
- id: elasticsearch
511
---
612

713
# {{esql}} reference [esql-language]
814

9-
:::{note}
10-
This section provides detailed **reference information** about the {{esql}} language, including syntax, functions, and operators.
15+
**Elasticsearch Query Language ({{esql}})** is a piped query language for filtering, transforming, and analyzing data.
1116

12-
For overview, conceptual, and getting started information, refer to the [{{esql}} language overview](docs-content://explore-analyze/query-filter/languages/esql.md) in the **Explore and analyze** section.
13-
:::
17+
## What's {{esql}}? [_the_esql_compute_engine]
1418

15-
{{esql}} is a piped query language for exploring and analyzing data in {{es}}. It is designed to be easy to use and understand, while also being powerful enough to handle complex data processing.
19+
You can author {{esql}} queries to find specific events, perform statistical analysis, and create visualizations. It supports a wide range of commands, functions, and operators to perform various data operations, such as filter, aggregation, time-series analysis, and more. It initially supported a subset of the features available in Query DSL, but it is rapidly evolving with every {{serverless-full}} and Stack release.
1620

17-
This reference section provides detailed technical information about {{esql}} features, syntax, and behavior:
21+
{{esql}} is designed to be easy to read and write, making it accessible for users with varying levels of technical expertise. It is particularly useful for data analysts, security professionals, and developers who need to work with large datasets in Elasticsearch.
22+
23+
## How does it work? [search-analyze-data-esql]
24+
25+
{{esql}} uses pipes (`|`) to manipulate and transform data in a step-by-step fashion. This approach allows you to compose a series of operations, where the output of one operation becomes the input for the next, enabling complex data transformations and analysis.
26+
27+
Here's a simple example of an {{esql}} query:
28+
29+
```esql
30+
FROM sample_data
31+
| SORT @timestamp DESC
32+
| LIMIT 3
33+
```
34+
35+
Note that each line in the query represents a step in the data processing pipeline:
36+
- The `FROM` clause specifies the index or data stream to query
37+
- The `SORT` clause sorts the data by the `@timestamp` field in descending order
38+
- The `LIMIT` clause restricts the output to the top 3 results
39+
40+
### User interfaces
41+
42+
You can interact with {{esql}} in two ways:
43+
44+
- **Programmatic access**: Use {{esql}} syntax with the {{es}} `_query` endpoint.
45+
- Refer to [](esql/esql-rest.md)
46+
47+
- **Interactive interfaces**: Work with {{esql}} through Elastic user interfaces including Kibana Discover, Dashboards, Dev Tools, and analysis tools in Elastic Security and Observability.
48+
- Refer to [Using {{esql}} in {{kib}}](docs-content://explore-analyze/query-filter/languages/esql-kibana.md).
1849

19-
* [Syntax reference](esql/esql-syntax-reference.md): Learn the basic syntax of commands, functions, and operators
20-
* [Advanced workflows](esql/esql-advanced.md): Learn how to handle more complex tasks with these guides, including how to extract, transform, and combine data from multiple indices
21-
* [Types and fields](esql/esql-types-and-fields.md): Learn about how {{esql}} handles different data types and special fields
22-
* [Limitations](esql/limitations.md): Learn about the current limitations of {{esql}}
23-
* [Examples](esql/esql-examples.md): Explore some example queries
24-
* [Troubleshooting](esql/esql-troubleshooting.md): Learn how to diagnose and resolve issues with {{esql}}

0 commit comments

Comments
 (0)