Commit Graph

30 Commits

Author SHA1 Message Date
Liam Thompson 9b7e9b5d59
[DOCS] ESQL goes GA (#108342) 2024-05-07 14:12:50 +02:00
Liam Thompson 33a71e3289
[DOCS] Refactor book-scoped variables in `docs/reference/index.asciidoc` (#107413)
* Remove `es-test-dir` book-scoped variable

* Remove `plugins-examples-dir` book-scoped variable

* Remove `:dependencies-dir:` and `:xes-repo-dir:` book-scoped variables

- In `index.asciidoc`, two variables (`:dependencies-dir:` and `:xes-repo-dir:`) were removed.
- In `sql/index.asciidoc`, the `:sql-tests:` path was updated to fuller path
- In `esql/index.asciidoc`, the `:esql-tests:` path was updated idem

* Replace `es-repo-dir` with `es-ref-dir`

* Move `:include-xpack: true` to few files that use it, remove from index.asciidoc
2024-04-17 14:37:07 +02:00
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
Abdon Pijpelink 84d9392d74
[DOCS] Warn against using ES|QL on production environments (#103797) 2024-01-02 17:00:22 +01:00
Abdon Pijpelink 9132f95fb4
[DOCS] Add 'Using ES|QL in Elastic Security' (#101677)
* [DOCS] Add 'Using ES|QL in Elastic Security'

* Add a note about enabling knowledge base

* Update links
2023-11-07 11:35:37 +01:00
Abdon Pijpelink 76ab37b35d
[DOCS] Uniform formatting for ES|QL commands (#101728)
* Source commands

* Missing word

* Processing commands

* Apply suggestions from code review

Co-authored-by: Alexander Spies <alexander.spies@elastic.co>

* Review feedback

* Add sort detail for mv

* More review feedback

---------

Co-authored-by: Alexander Spies <alexander.spies@elastic.co>
2023-11-06 08:42:13 +01:00
Abdon Pijpelink 8e96d285c0
[DOCS] One more round of restructuring the ES|QL documentation (#101340)
* Reorg some pages

* Add links to landing page
2023-10-26 10:57:05 +02:00
AlexB b19ae8d5ee
esql docs: structure, examples, minor improvements (#101292)
Small improvements in ESQL docs and addition of examples

---------

Co-authored-by: Alexandros Batsakis <abatsakis@elastic.co>
Co-authored-by: Abdon Pijpelink <abdon.pijpelink@elastic.co>
2023-10-25 05:00:48 -07:00
AlexB 931dcae41d
Add improvements to the ES|QL docs (#101195)
Content and structural improvements to the ES|QL docs

---------

Co-authored-by: Alexandros Batsakis <abatsakis@splunk.com>
Co-authored-by: Abdon Pijpelink <abdon.pijpelink@elastic.co>
2023-10-23 07:45:42 -07:00
Abdon Pijpelink 8ac4ba751e
Restructure ES|QL docs (#100806)
* Break out 'Limitations' into separate page

* Add REST API docs

* Restructure commands, functions, and operators refs

* Add placeholder for getting started guide

* Group 'Syntax', 'Metafields', and 'MV fields' under 'Language'

* Add placeholder for Kibana page

* Add link from landing page

* Apply uniform formatting to ACOS, CASE, and DATE_PARSE function refs

* Reword default LIMIT

* Add support for COUNT(*)

* Move 'Commands' and 'Functions and operators' to individual pages

---------

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2023-10-17 17:36:14 +02:00
Bogdan Pintea eaf21483fb
ESQL: Document the existing result-set limitations (#99880)
Document the newly implicit limit of 500 (if no other limit is
provided), as well as the global 10K one.

Related: #99816
2023-09-26 04:12:23 -04:00
Bogdan Pintea 9beddb18d6
ESQ: Add metadata fields documentation (#98991)
This adds documentation for the supported metadata fields.

---------

Co-authored-by: Abdon Pijpelink <abdon.pijpelink@elastic.co>
2023-08-30 12:51:31 +02:00
Abdon Pijpelink b6c85dbe82
[DOCS] Update ES|QL Kibana instructions (#98940) 2023-08-30 11:18:49 +02:00
Bogdan Pintea 372458c9fd
ESQL: date_trunc(): swap order of arguments (#98624)
Swap arguments order so that the range parameter is first and datetime
one second, inline with other languages.
2023-08-22 18:20:05 +02:00
Abdon Pijpelink 0c14d5d332 Update types list 2023-08-08 18:11:59 +02:00
Abdon Pijpelink 47566f4276 Update supported types list 2023-08-08 17:47:45 +02:00
Abdon Pijpelink 843eacab27 Add tech preview admonition 2023-08-08 17:29:24 +02:00
Nik Everett 7c30146858 Add query to esql task (ESQL-1511)
This adds the `query` to the main ESQL task so you can see long running
queries. And adds some docs about it including an example of cancelling
a query.

---------

Co-authored-by: Abdon Pijpelink <abdon.pijpelink@elastic.co>
2023-08-02 05:30:36 +10:00
Bogdan Pintea 5aa1feb63f Add `_query` endpoint as `_esql` replacement (ESQL-1463)
This adds a new ES|QL endpoint, `_query`, to replace the now deprecated
`_esql`. The latter is still kept for a while, emitting a deprecation
warning.

Fixes ESQL-1379.
2023-07-25 12:25:38 +02:00
Abdon Pijpelink 02d62d29f4 Remove meta tags 2023-07-07 13:54:39 +02:00
Abdon Pijpelink f4581bb4bd Change ESQL into ES|QL 2023-07-07 13:42:06 +02:00
Nik Everett 82d67dc289 Docs for aggregation functions (ESQL-1268)
This adds docs for all of ESQL's aggregation functions. Hopefully from
here on out we can add the docs as we add new functions.

I've created a few tagged regions in the aggs docs themselves so we can
include them into the ESQL docs.

---------

Co-authored-by: Abdon Pijpelink <abdon.pijpelink@elastic.co>
2023-06-14 09:23:34 -05:00
Nik Everett 74c97dd75b Add more docs for multivalue fields (ESQL-1252)
Describes how we fetch multivalued fields by default, return them as
json arrays, how the internal sort order is not guaranteed, how most
functions will turn them into null, and how some fields remove
duplicates on save.

---------

Co-authored-by: Abdon Pijpelink <abdon.pijpelink@elastic.co>
2023-06-09 08:42:02 -04:00
Nik Everett 87e6fcc948 Docs for `split` (ESQL-1084)
This adds docs for the new `split` function.
2023-05-04 06:26:48 -04:00
Abdon Pijpelink 278faf1cce List 'alias' as a supported field type 2023-04-28 15:02:34 +02:00
Abdon Pijpelink ad72b725b8 Add ip and version to supported field types 2023-04-24 15:31:12 +02:00
Abdon Pijpelink 8c81f3a921 Fix description and keywords meta fields 2023-04-17 11:18:51 +02:00
Abdon Pijpelink 1364f50cbf Edits 2023-04-17 11:18:51 +02:00
Abdon Pijpelink 81fd338297 Initial commit 2023-04-17 11:18:50 +02:00
Nik Everett 02e8293f54 Add shell for ESQL docs (ESQL-913)
This adds a super basic shell for the esql docs. You can build them with
the standard docs build commend:
```
../docs/build_docs --doc docs/reference/index.asciidoc \
  --resource x-pack/docs/ --chunk 1 --open
```
2023-03-23 13:53:43 -04:00