Class QueryRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.sql.QueryRequest
- All Implemented Interfaces:
JsonpSerializable
Executes a SQL request
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<QueryRequest>
Json deserializer forQueryRequest
static final Endpoint<QueryRequest,
QueryResponse, ErrorResponse> Endpoint "sql.query
". -
Method Summary
Modifier and TypeMethodDescriptionfinal String
catalog()
Default catalog (cluster) for queries.final Boolean
columnar()
If true, the results in a columnar fashion: one row represents all the values of a certain column from the current page of results.final String
cursor()
API name:cursor
final Integer
The maximum number of rows (or entries) to return in one responsefinal Boolean
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).final Query
filter()
Optional Elasticsearch query DSL for additional filtering.final String
format()
a short version of the Accept header, e.g.final Boolean
If true, the search can run on frozen indices.final Time
Retention period for an async or saved synchronous search.final Boolean
If true, Elasticsearch stores synchronous searches if you also specify the wait_for_completion_timeout parameter.static QueryRequest
final Time
The timeout before a pagination request fails.params()
Values for parameters in the query.final String
query()
SQL query to executefinal Time
The timeout before the request fails.final Map<String,
RuntimeField> Defines one or more runtime fields in the search request.void
serialize
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this object to JSON.protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static void
final String
timeZone()
Time-zone in ISO 8601 used for executing the query on the server.final Time
Period to wait for complete results.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forQueryRequest
-
_ENDPOINT
Endpoint "sql.query
".
-
-
Method Details
-
of
-
catalog
Default catalog (cluster) for queries. If unspecified, the queries execute on the data in the local cluster only.API name:
catalog
-
columnar
If true, the results in a columnar fashion: one row represents all the values of a certain column from the current page of results.API name:
columnar
-
cursor
API name:cursor
-
fetchSize
The maximum number of rows (or entries) to return in one responseAPI name:
fetch_size
-
fieldMultiValueLeniency
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).API name:
field_multi_value_leniency
-
filter
Optional Elasticsearch query DSL for additional filtering.API name:
filter
-
format
a short version of the Accept header, e.g. json, yamlAPI name:
format
-
indexUsingFrozen
If true, the search can run on frozen indices. Defaults to false.API name:
index_using_frozen
-
keepAlive
Retention period for an async or saved synchronous search.API name:
keep_alive
-
keepOnCompletion
If true, Elasticsearch stores synchronous searches if you also specify the wait_for_completion_timeout parameter. If false, Elasticsearch only stores async searches that don’t finish before the wait_for_completion_timeout.API name:
keep_on_completion
-
pageTimeout
The timeout before a pagination request fails.API name:
page_timeout
-
params
Values for parameters in the query.API name:
params
-
query
SQL query to executeAPI name:
query
-
requestTimeout
The timeout before the request fails.API name:
request_timeout
-
runtimeMappings
Defines one or more runtime fields in the search request. These fields take precedence over mapped fields with the same name.API name:
runtime_mappings
-
timeZone
Time-zone in ISO 8601 used for executing the query on the server. More information available here.API name:
time_zone
-
waitForCompletionTimeout
Period to wait for complete results. Defaults to no timeout, meaning the request waits for complete search results. If the search doesn’t finish within this period, the search becomes async.API name:
wait_for_completion_timeout
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupQueryRequestDeserializer
-