Skip to content

Commit

Permalink
ESQL: Document the existing result-set limitations (elastic#99880)
Browse files Browse the repository at this point in the history
Document the newly implicit limit of 500 (if no other limit is
provided), as well as the global 10K one.

Related: elastic#99816
  • Loading branch information
bpintea authored and piergm committed Oct 2, 2023
1 parent fd4d1c0 commit da1a49a
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 14 deletions.
36 changes: 22 additions & 14 deletions docs/reference/esql/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,11 @@ POST /_query?format=txt
----
// TEST[setup:library]

The above query's `LIMIT` command limits results to 5 rows.

If not specified, `LIMIT` defaults to `500`. A single query will not return
more than 10,000 rows, regardless of the `LIMIT` value.

[discrete]
==== {kib}

Expand All @@ -105,20 +110,23 @@ with the time filter.
[[esql-limitations]]
=== Limitations

{esql} currently supports the following <<mapping-types,field types>>:

- `alias`
- `boolean`
- `date`
- `double` (`float`, `half_float`, `scaled_float` are represented as `double`)
- `ip`
- `keyword` family including `keyword`, `constant_keyword`, and `wildcard`
- `int` (`short` and `byte` are represented as `int`)
- `long`
- `null`
- `text`
- `unsigned_long`
- `version`
* {esql} currently supports the following <<mapping-types,field types>>:

** `alias`
** `boolean`
** `date`
** `double` (`float`, `half_float`, `scaled_float` are represented as `double`)
** `ip`
** `keyword` family including `keyword`, `constant_keyword`, and `wildcard`
** `int` (`short` and `byte` are represented as `int`)
** `long`
** `null`
** `text`
** `unsigned_long`
** `version`

* A single query will not return more than 10,000 rows, regardless of the
`LIMIT` command's value.
--

include::esql-get-started.asciidoc[]
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/esql/processing-commands/limit.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,6 @@ The `LIMIT` processing command enables you to limit the number of rows:
----
include::{esql-specs}/docs.csv-spec[tag=limit]
----

If not specified, `LIMIT` defaults to `500`. A single query will not return
more than 10,000 rows, regardless of the `LIMIT` value.

0 comments on commit da1a49a

Please sign in to comment.