Skip to content

Split ES|QL functions/operators/commands into separate pages for similar functions and make commands examples generated #126279

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
503f943
Split ES|QL functions/operators into separate pages for similar funct…
craigtaverner Apr 4, 2025
ef77664
Merge branch 'main' into esql_split_docs_pages_functions_operators
craigtaverner Apr 4, 2025
030dfc2
Restructure operators to be more like functions
craigtaverner Apr 4, 2025
e6a7913
Fix some broken links
craigtaverner Apr 4, 2025
5a56eb8
Add three missing SVG files for operators
craigtaverner Apr 4, 2025
44e31ac
Fix incorrect example for match operator
craigtaverner Apr 4, 2025
0f3eb18
Split commands into multiple pages
craigtaverner Apr 4, 2025
8d6fb00
Do not delete the static commands files
craigtaverner Apr 4, 2025
62947a0
Merge remote-tracking branch 'origin/main' into esql_split_docs_pages…
craigtaverner Apr 5, 2025
6bac25c
Merge branch 'main' into esql_split_docs_pages_functions_operators
craigtaverner Apr 7, 2025
503313f
Extract examples from ES|QL commands into separate files
craigtaverner Apr 9, 2025
d08fd97
Generate commands examples for the first time
craigtaverner Apr 9, 2025
fe3160d
Kibana docs updates, better operator name/title and symbols
craigtaverner Apr 9, 2025
a17b959
Merge branch 'esql_split_docs_pages_functions_operators' of github.co…
craigtaverner Apr 9, 2025
7b512cc
Update docs/reference/query-languages/esql/functions-operators/aggreg…
craigtaverner Apr 9, 2025
c8b9411
Update docs/reference/query-languages/esql/functions-operators/condit…
craigtaverner Apr 9, 2025
f05d92e
Update docs/reference/query-languages/esql/functions-operators/condit…
craigtaverner Apr 9, 2025
8774077
Update docs/reference/query-languages/esql/functions-operators/date-t…
craigtaverner Apr 9, 2025
2d2a3ae
Update docs/reference/query-languages/esql/functions-operators/search…
craigtaverner Apr 9, 2025
28f3048
Update docs/reference/query-languages/esql/functions-operators/date-t…
craigtaverner Apr 9, 2025
447c2d9
Update docs/reference/query-languages/esql/functions-operators/search…
craigtaverner Apr 9, 2025
4ac5512
Update docs/reference/query-languages/esql/functions-operators/string…
craigtaverner Apr 9, 2025
b41ea7f
Update docs/reference/query-languages/esql/functions-operators/type-c…
craigtaverner Apr 9, 2025
ee30d35
Added redirects.yml from Liam
craigtaverner Apr 9, 2025
7fc19af
Merge branch 'esql_split_docs_pages_functions_operators' of github.co…
craigtaverner Apr 9, 2025
d47514a
Merge remote-tracking branch 'origin/main' into esql_split_docs_pages…
craigtaverner Apr 9, 2025
4d23620
Bring back rename edits after merging main
craigtaverner Apr 9, 2025
806f7ef
redirects: attempt 1 of n
leemthompo Apr 10, 2025
67f70c8
redirects: attempt 2 of n, bulk approach
leemthompo Apr 10, 2025
6e9dda7
redirects: attempt 3 of n, wrong path?
leemthompo Apr 10, 2025
567d1f7
redirects: attempt 4 of n, inconsistent paths?
leemthompo Apr 10, 2025
ccc6aa8
redirects: attempt 5 of n (file in wrong dir?)
leemthompo Apr 10, 2025
c349f28
Update docs/reference/query-languages/esql/functions-operators/spatia…
craigtaverner Apr 10, 2025
95dbf05
Merge branch 'main' into esql_split_docs_pages_functions_operators
craigtaverner Apr 10, 2025
478d73d
Update docs/reference/query-languages/esql/functions-operators/groupi…
craigtaverner Apr 10, 2025
611f00c
Update docs/reference/query-languages/esql/functions-operators/ip-fun…
craigtaverner Apr 10, 2025
bc0c711
Update docs/reference/query-languages/esql/functions-operators/math-f…
craigtaverner Apr 10, 2025
acbcb2c
Update docs/reference/query-languages/esql/functions-operators/math-f…
craigtaverner Apr 10, 2025
2fb4609
Update docs/reference/query-languages/esql/functions-operators/mv-fun…
craigtaverner Apr 10, 2025
bed3693
Update docs/reference/query-languages/esql/functions-operators/operat…
craigtaverner Apr 10, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
3 changes: 3 additions & 0 deletions docs/redirects.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
redirects:
'reference/query-languages/esql/esql-functions-operators.md': '!reference/query-languages/esql/functions-operators/aggregation-functions.md'
'reference/query-languages/esql/esql-commands.md': '!reference/query-languages/esql/commands/processing-commands.md'

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.

```esql
FROM sample_data
| WHERE @timestamp > NOW() - 1 hour
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.

```esql
ROW a = "2023-01-23T12:15:00.000Z - some text - 127.0.0.1"
| DISSECT a """%{date} - %{msg} - %{ip}"""
| KEEP date, msg, ip
```

| date:keyword | msg:keyword | ip:keyword |
| --- | --- | --- |
| 2023-01-23T12:15:00.000Z | some text | 127.0.0.1 |
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.

```esql
ROW a = "2023-01-23T12:15:00.000Z 127.0.0.1 [email protected] 42"
| GROK a """%{TIMESTAMP_ISO8601:date} %{IP:ip} %{EMAILADDRESS:email} %{NUMBER:num}"""
| KEEP date, ip, email, num
```

| date:keyword | ip:keyword | email:keyword | num:keyword |
| --- | --- | --- | --- |
| 2023-01-23T12:15:00.000Z | 127.0.0.1 | [email protected] | 42 |
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.

```esql
ROW a = "2023-01-23T12:15:00.000Z - some text - 127.0.0.1"
| DISSECT a """%{date} - %{msg} - %{ip}"""
| KEEP date, msg, ip
| EVAL date = TO_DATETIME(date)
```

| msg:keyword | ip:keyword | date:date |
| --- | --- | --- |
| some text | 127.0.0.1 | 2023-01-23T12:15:00.000Z |
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.

```esql
ROW a = "2023-01-23T12:15:00.000Z 127.0.0.1 [email protected] 42"
| GROK a """%{TIMESTAMP_ISO8601:date} %{IP:ip} %{EMAILADDRESS:email} %{NUMBER:num:int}"""
| KEEP date, ip, email, num
```

| date:keyword | ip:keyword | email:keyword | num:integer |
| --- | --- | --- | --- |
| 2023-01-23T12:15:00.000Z | 127.0.0.1 | [email protected] | 42 |
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.

```esql
FROM addresses
| KEEP city.name, zip_code
| GROK zip_code """%{WORD:zip_parts} %{WORD:zip_parts}"""
```

| city.name:keyword | zip_code:keyword | zip_parts:keyword |
| --- | --- | --- |
| Amsterdam | 1016 ED | ["1016", "ED"] |
| San Francisco | CA 94108 | ["CA", "94108"] |
| Tokyo | 100-7014 | null |
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.

```esql
ROW a = "2023-01-23T12:15:00.000Z 127.0.0.1 [email protected] 42"
| GROK a """%{TIMESTAMP_ISO8601:date} %{IP:ip} %{EMAILADDRESS:email} %{NUMBER:num:int}"""
| KEEP date, ip, email, num
| EVAL date = TO_DATETIME(date)
```

| ip:keyword | email:keyword | num:integer | date:date |
| --- | --- | --- | --- |
| 127.0.0.1 | [email protected] | 42 | 2023-01-23T12:15:00.000Z |
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.

```esql
FROM employees
| KEEP emp_no, first_name, last_name, height
```

| emp_no:integer | first_name:keyword | last_name:keyword | height:double |
| --- | --- | --- | --- |
| 10001 | Georgi | Facello | 2.03 |
| 10002 | Bezalel | Simmel | 2.08 |
| 10003 | Parto | Bamford | 1.83 |
| 10004 | Chirstian | Koblick | 1.78 |
| 10005 | Kyoichi | Maliniak | 2.05 |
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.

```esql
FROM employees
| KEEP first_name, last_name, first_name*
```

| first_name:keyword | last_name:keyword |
| --- | --- |
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.

```esql
FROM employees
| KEEP h*, *
```

| height:double | height.float:double | height.half_float:double | height.scaled_float:double | hire_date:date | avg_worked_seconds:long | birth_date:date | emp_no:integer | first_name:keyword | gender:keyword | is_rehired:boolean | job_positions:keyword | languages:integer | languages.byte:integer | languages.long:long | languages.short:integer | last_name:keyword | salary:integer | salary_change:double | salary_change.int:integer | salary_change.keyword:keyword | salary_change.long:long | still_hired:boolean |
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.

```esql
FROM employees
| KEEP h*
```

| height:double | height.float:double | height.half_float:double | height.scaled_float:double | hire_date:date |
| --- | --- | --- | --- | --- |
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.

```esql
FROM employees
| KEEP *, first_name
```

| avg_worked_seconds:long | birth_date:date | emp_no:integer | gender:keyword | height:double | height.float:double | height.half_float:double | height.scaled_float:double | hire_date:date | is_rehired:boolean | job_positions:keyword | languages:integer | languages.byte:integer | languages.long:long | languages.short:integer | last_name:keyword | salary:integer | salary_change:double | salary_change.int:integer | salary_change.keyword:keyword | salary_change.long:long | still_hired:boolean | first_name:keyword |
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.

```esql
FROM employees
| KEEP first_name*, last_name, first_na*
```

| last_name:keyword | first_name:keyword |
| --- | --- |
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.

```esql
FROM employees
| KEEP first_name, last_name, still_hired
| RENAME still_hired AS employed
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.

```esql
FROM employees
| KEEP first_name, last_name
| RENAME first_name AS fn, last_name AS ln
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.

```esql
FROM employees
| KEEP first_name, last_name
| RENAME first_name AS fn
| RENAME last_name AS ln
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.

```esql
FROM employees
| KEEP first_name, last_name, height
| SORT height
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.

```esql
FROM employees
| KEEP first_name, last_name, height
| SORT height DESC
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.

```esql
FROM employees
| KEEP first_name, last_name, height
| SORT first_name ASC NULLS FIRST
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.

```esql
FROM employees
| KEEP first_name, last_name, height
| SORT height DESC, first_name ASC
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.

```esql
FROM employees
| KEEP first_name, last_name, still_hired
| WHERE still_hired == true
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.

```esql
FROM employees
| KEEP first_name, last_name, still_hired
| WHERE still_hired
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.

```esql
FROM employees
| KEEP first_name, last_name, height
| WHERE LENGTH(first_name) < 4
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.

```esql
FROM employees
| DROP height
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.

```esql
FROM employees
| DROP height*
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.

```esql
ROW language_code = "1"
| ENRICH languages_policy
```

| language_code:keyword | language_name:keyword |
| --- | --- |
| 1 | English |
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.

```esql
ROW a = "1"
| ENRICH languages_policy ON a
```

| a:keyword | language_name:keyword |
| --- | --- |
| 1 | English |
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.

```esql
ROW a = "1"
| ENRICH languages_policy ON a WITH name = language_name
```

| a:keyword | name:keyword |
| --- | --- |
| 1 | English |
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.

```esql
ROW a = "1"
| ENRICH languages_policy ON a WITH language_name
```

| a:keyword | language_name:keyword |
| --- | --- |
| 1 | English |
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.

```esql
FROM employees
| SORT emp_no
| KEEP first_name, last_name, height
| EVAL height_feet = height * 3.281, height_cm = height * 100
```

| first_name:keyword | last_name:keyword | height:double | height_feet:double | height_cm:double |
| --- | --- | --- | --- | --- |
| Georgi | Facello | 2.03 | 6.66043 | 202.99999999999997 |
| Bezalel | Simmel | 2.08 | 6.82448 | 208.0 |
| Parto | Bamford | 1.83 | 6.004230000000001 | 183.0 |
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.

```esql
FROM employees
| SORT emp_no
| KEEP first_name, last_name, height
| EVAL height = height * 3.281
```

| first_name:keyword | last_name:keyword | height:double |
| --- | --- | --- |
| Georgi | Facello | 6.66043 |
| Bezalel | Simmel | 6.82448 |
| Parto | Bamford | 6.004230000000001 |
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.

```esql
FROM employees
| SORT emp_no
| KEEP first_name, last_name, height
| EVAL height * 3.281
```

| first_name:keyword | last_name:keyword | height:double | height * 3.281:double |
| --- | --- | --- | --- |
| Georgi | Facello | 2.03 | 6.66043 |
| Bezalel | Simmel | 2.08 | 6.82448 |
| Parto | Bamford | 1.83 | 6.004230000000001 |
Loading
Loading