Skip to content

SQL: Adapt the limitations page to the new "fields" API usage #69616

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.

Sign up for GitHub

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
merged 2 commits into from
Mar 2, 2021
Merged

SQL: Adapt the limitations page to the new "fields" API usage #69616

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d73fd45
Adapt the limitations page to the new "fields" API usage in SQL
astefan Feb 25, 2021
2939699
Apply suggestions from code review
astefan Mar 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 6 additions & 15 deletions docs/reference/sql/limitations.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,22 +196,13 @@ indexed with some loss of precision from the original values (4.190951585769653E
Therefore calling `ST_Z` function in the filtering, grouping or sorting will return `null`.

[discrete]
[[fields-from-source]]
=== Retrieving from `_source`
[[using-fields-api]]
=== Retrieving using the `fields` search parameter

Most of {es-sql}'s columns are retrieved from the document's `_source` and there is no attempt to get the columns content from
`docvalue_fields` not even in the case <<mapping-source-field,`_source`>> field is disabled in the mapping explicitly.
If a column, for which there is no source stored, is asked for in a query, {es-sql} will not return it. Field types that don't follow
this restriction are: `keyword`, `date`, `scaled_float`, `geo_point`, `geo_shape` since they are NOT returned from `_source` but
from `docvalue_fields`.

[discrete]
[[fields-from-docvalues]]
=== Retrieving from `docvalue_fields`

When the number of columns retrievable from `docvalue_fields` is greater than the configured <<dynamic-index-settings,`index.max_docvalue_fields_search` setting>>
the query will fail with `IllegalArgumentException: Trying to retrieve too many docvalue_fields` error. Either the mentioned {es}
setting needs to be adjusted or fewer columns retrievable from `docvalue_fields` need to be selected.
{es-sql} retrieves column values using the <<search-fields-param,search API's
`fields` parameter>>. Any limitations on the `fields` parameter also apply to
{es-sql} queries. For example, if `_source` is disabled
for any of the returned fields or at index level, the values cannot be retrieved.

[discrete]
[[aggs-in-pivot]]
Expand Down