Get SQL search results
Generally available; Added in 6.3.0
All methods and paths for this operation:
Run an SQL request.
highlight#highlightFromAnchor" href="#topic-required-authorization"> Required authorization
- Index privileges:
read
Query parameters
-
The format for the response. You can also specify a format using the
AcceptHTTP header. If you specify both this parameter and theAcceptHTTP header, this parameter takes precedence.Values are
csv,json,tsv,txt,yaml,cbor, orsmile.
Body
Required
-
If
true, the response has partial results when there are shard request timeouts or shard failures. Iffalse, 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.External documentation -
The cursor used to retrieve a set of paginated results. If you specify a cursor, the API only uses the
columnarandtime_zonerequest 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. Iftrue, 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.
External documentation -
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) andd(days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. -
If
true, Elasticsearch stores synchronous searches if you also specify thewait_for_completion_timeoutparameter. Iffalse, Elasticsearch only stores async searches that don't finish before thewait_for_completion_timeout.Default value is
false. -
A duration. Units can be
nanos,micros,ms(milliseconds),s(seconds),m(minutes),h(hours) andd(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.
External documentation -
A duration. Units can be
nanos,micros,ms(milliseconds),s(seconds),m(minutes),h(hours) andd(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) andd(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"
}