Supported REST parameters

In addition to the query and fetch_size, a request a number of user-defined fields for specifying the request time-outs or localization information (such as timezone).

The table below lists the supported parameters:

name

Default value

Description

query

Mandatory

SQL query to execute

fetch_size

1000

The maximum number of rows (or entries) to return in one response

filter

none

Optional Elasticsearch query DSL for additional filtering.

request_timeout

90s

The timeout before the request fails.

page_timeout

45s

The timeout before a pagination request fails.

time_zone

Z (or UTC)

Time-zone in ISO 8601 used for executing the query on the server. More information available here.

columnar

false

Return the results in a columnar fashion, rather than row-based fashion. Valid for json, yaml, cbor and smile.

field_multi_value_leniency

false

Throw an exception when encountering multiple values for a field (default) or be lenient and return the first value from the list (without any guarantees of what that will be - typically the first in natural ascending order).

index_include_frozen

false

Whether to include frozen-indices in the query execution or not (default).

Do note that most parameters (outside the timeout and columnar ones) make sense only during the initial query - any follow-up pagination request only requires the cursor parameter as explained in the pagination chapter. That’s because the query has already been executed and the calls are simply about returning the found results - thus the parameters are simply ignored.