Skip to content

Commit da7fec9

Browse files
Small ES|QL editor changes for 9.1 (#1818)
Batching a few changes for the various ES|QL editor improvements that don't require a lot of docs. The main need here for newly supported commands and functions is to make the ES|QL reference quicker to find for anyone reading these docs. - Adding a direct link to the ES|QL syntax docs from a few pages - Adding a section about keyboard shortcuts supported by the editor - Moving the LOOKUP_JOIN section from Discover docs to ES|QL editor docs as it's not Discover specific, and to prepare for future improvements around this command (file upload...) closes: #1677 closes: #1678 closes: #1680 closes: #1681 Other ES|QL-related docs content changes are in the works and will be treated separately: - #1810 - #1679 - #1669
1 parent 64af5df commit da7fec9

File tree

3 files changed

+28
-10
lines changed

3 files changed

+28
-10
lines changed

explore-analyze/discover/try-esql.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The Elasticsearch Query Language, {{esql}}, makes it easier to explore your data
1515
The examples on this page use the {{kib}} sample web logs in Discover and Lens to explore the data and create visualizations. You can also install it by following [Add sample data](../index.md#gs-get-data-into-kibana).
1616

1717
::::{tip}
18-
For the complete {{esql}} documentation, refer to the [{{esql}} documentation](../query-filter/languages/esql.md). For a more detailed overview of {{esql}} in {{kib}}, refer to [Use {{esql}} in Kibana](../query-filter/languages/esql-kibana.md).
18+
For the complete {{esql}} documentation, including all supported commands, functions, and operators, refer to the [{{esql}} reference](elasticsearch://reference/query-languages/esql/esql-syntax-reference.md). For a more detailed overview of {{esql}} in {{kib}}, refer to [Use {{esql}} in Kibana](../query-filter/languages/esql-kibana.md).
1919

2020
::::
2121

@@ -134,10 +134,3 @@ FROM kibana_sample_data_ecommerce
134134
:alt: ESQL query with a custom time field enabled
135135
:::
136136

137-
138-
### ES|QL and LOOKUP JOINs
139-
140-
The ES|QL editor supports [`LOOKUP JOIN`](elasticsearch://reference/query-languages/esql/commands/processing-commands.md#esql-lookup-join) commands and suggests lookup mode indices and join condition fields.
141-
142-
![Using the LOOKUP JOIN command to autocomplete an ES|QL query](https://images.contentstack.io/v3/assets/bltefdd0b53724fa2ce/blte43a30a93241d650/67c23670045f5839e5bfd1e4/lookup-join-demo.gif)
143-
Lines changed: 3 additions & 0 deletions
Loading

explore-analyze/query-filter/languages/esql-kibana.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ More specifically, {{esql}} is a powerful tool in Kibana that can help you with
2020

2121
This guide shows you how to use {{esql}} in Kibana. To follow along with the queries, load the "Sample web logs" sample data set by selecting **Sample Data** from the **Integrations** page in {{kib}}, selecting **Other sample data sets**, and clicking **Add data** on the **Sample web logs** card.
2222

23+
:::{tip}
24+
Find the complete list of supported commands, functions, and operators in the [{{esql}} reference](elasticsearch://reference/query-languages/esql/esql-syntax-reference.md).
25+
:::
2326

2427
## Enable or disable {{esql}} [esql-kibana-enable]
2528

@@ -38,7 +41,7 @@ To get started with {{esql}}, go to **Discover**. Next, select **Try ES|QL** fro
3841
After switching to {{esql}} mode, the query bar shows your previous KQL or Lucene query converted into {{esql}}. If the query was empty, it shows a sample query. For example:
3942

4043
```esql
41-
from kibana_sample_data_logs | limit 10
44+
FROM kibana_sample_data_logs | LIMIT 10
4245
```
4346

4447
Every query starts with a [source command](elasticsearch://reference/query-languages/esql/esql-commands.md#esql-source-commands). In this query, the source command is [`FROM`](elasticsearch://reference/query-languages/esql/commands/source-commands.md#esql-from). `FROM` retrieves data from data streams, indices, or aliases. In this example, the data is retrieved from `kibana_sample_data_logs`.
@@ -123,7 +126,7 @@ In the **Starred** tab, find all the queries you have previously starred.
123126
:::
124127

125128

126-
### Organizing the query results [esql-kibana-results-table]
129+
### Organize the query results [esql-kibana-results-table]
127130

128131
For the example query, the results table shows 10 rows. Omitting the `LIMIT` command, the results table defaults to up to 1000 rows. Using `LIMIT`, you can increase the limit to up to 10,000 rows.
129132

@@ -201,6 +204,25 @@ FROM kibana_sample_data_logs
201204
| WHERE timestamp > NOW() - 15minutes
202205
```
203206

207+
### LOOKUP JOINs
208+
209+
The ES|QL editor supports [`LOOKUP JOIN`](elasticsearch://reference/query-languages/esql/commands/processing-commands.md#esql-lookup-join) commands and suggests lookup mode indices and join condition fields.
210+
211+
![Using the LOOKUP JOIN command to autocomplete an ES|QL query](https://images.contentstack.io/v3/assets/bltefdd0b53724fa2ce/blte43a30a93241d650/67c23670045f5839e5bfd1e4/lookup-join-demo.gif)
212+
213+
214+
### Keyboard shortcuts
215+
216+
The ES|QL editor supports several shortcuts to help you write and run your queries faster:
217+
218+
| Mac | Windows/Linux | Description |
219+
|---------------|----------------|-----------------------------|
220+
| `Cmd + Enter` | `Ctrl + Enter` | Run a query |
221+
| `Cmd + /` | `Ctrl + /` | Comment or uncomment a line |
222+
223+
:::{tip}
224+
You can find the list of shortcuts directly from the editor. Look for the ![keyboard](../../images/keyboard.svg "keyboard =2%") icon.
225+
:::
204226

205227
## Analyze and visualize data [esql-kibana-visualizations]
206228

0 commit comments

Comments
 (0)