The format for the response.
You can also specify a format using the Accept HTTP header.
If you specify both this parameter and the Accept HTTP header, this parameter takes precedence.
Values are csv, json, tsv, txt, yaml, cbor, or smile.
If true, the response has partial results when there are shard request timeouts or shard failures.
If false, the API returns an error with no partial results.
Default value is false.
The default catalog (cluster) for queries. If unspecified, the queries execute on the data in the local cluster only.
If true, the results are in a columnar fashion: one row represents all the values of a certain column from the current page of results.
The API supports this parameter only for CBOR, JSON, SMILE, and YAML responses.
Default value is false.
The cursor used to retrieve a set of paginated results.
If you specify a cursor, the API only uses the columnar and time_zone request body parameters.
It ignores other request body parameters.
The maximum number of rows (or entries) to return in one response.
Default value is 1000.
If false, the API returns an exception when encountering multiple values for a field.
If true, the API is lenient and returns the first value from the array with no guarantee of consistent results.
Default value is false.
An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
If true, the search can run on frozen indices.
Default value is false.
A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and
d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
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.
Default value is false.
A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and
d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
The values for parameters in the query.
The SQL query to run.
A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and
d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and
d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
POST _sql?format=txt
{
"query": "SELECT * FROM library ORDER BY page_count DESC LIMIT 5"
}resp = client.sql.query(
format="txt",
query="SELECT * FROM library ORDER BY page_count DESC LIMIT 5",
)const response = await client.sql.query({
format: "txt",
query: "SELECT * FROM library ORDER BY page_count DESC LIMIT 5",
});response = client.sql.query(
format: "txt",
body: {
"query": "SELECT * FROM library ORDER BY page_count DESC LIMIT 5"
}
)$resp = $client->sql()->query([
"format" => "txt",
"body" => [
"query" => "SELECT * FROM library ORDER BY page_count DESC LIMIT 5",
],
]);curl -X POST -H "Authorization: ApiKey $ELASTIC_API_KEY" -H "Content-Type: application/json" -d '{"query":"SELECT * FROM library ORDER BY page_count DESC LIMIT 5"}' "$ELASTICSEARCH_URL/_sql?format=txt"client.sql().query(q -> q
.format(SqlFormat.Txt)
.query("SELECT * FROM library ORDER BY page_count DESC LIMIT 5")
);
{
"query": "SELECT * FROM library ORDER BY page_count DESC LIMIT 5"
}