SQL 搜索 API
编辑SQL 搜索 API编辑
返回 SQL 搜索 的结果。
POST _sql?format=txt
{
"query": "SELECT * FROM library ORDER BY page_count DESC LIMIT 5"
}
查询参数编辑
-
delimiter - （可选，字符串）CSV 结果的分隔符。默认为
,。该 API 仅支持 CSV 响应的此参数。 -
format -
（可选，字符串）响应的格式。有关有效值，请参阅 响应数据格式。
您还可以使用
AcceptHTTP 标头指定格式。如果同时指定了此参数和AcceptHTTP 标头，则此参数优先。
请求正文编辑
-
allow_partial_search_results - （可选，布尔值）如果为
true，则在出现分片请求超时或 分片故障 时返回部分结果。如果为false，则返回错误，不返回部分结果。默认为false。 -
catalog -
（可选，字符串）查询的默认目录（集群）。如果未指定，则查询仅在本地集群中的数据上执行。
[预览] 此功能处于技术预览阶段，可能会在未来版本中更改或删除。Elastic 将努力解决任何问题，但技术预览版中的功能不受官方 GA 功能的支持 SLA 的约束。 请参阅 跨集群搜索。
-
columnar - （可选，布尔值）如果为
true，则以列式格式返回结果。默认为false。该 API 仅支持 CBOR、JSON、SMILE 和 YAML 响应的此参数。请参阅 列式结果。 -
cursor - （可选，字符串）用于检索一组分页结果的 游标。如果指定了
cursor，则 API 仅使用columnar和time_zone请求正文参数。它会忽略其他请求正文参数。
-
field_multi_value_leniency - （可选，布尔值）如果为
false，则 API 会针对包含 数组值 的字段返回错误。如果为true，则 API 会从数组中返回第一个值，但不保证结果一致。默认为false。 -
filter - （可选，对象）用于过滤 SQL 搜索文档的 查询 DSL。请参阅 使用 Elasticsearch 查询 DSL 进行过滤。
-
index_include_frozen - （可选，布尔值）如果为
true，则搜索可以在冻结的索引上运行。默认为false。 -
keep_alive - （可选，时间值）异步 或 已保存的同步搜索 的保留期。默认为
5d（五天）。 -
keep_on_completion - （可选，布尔值）如果为
true，则如果还指定了wait_for_completion_timeout参数，Elasticsearch 会 存储同步搜索。如果为false，则 Elasticsearch 仅存储在wait_for_completion_timeout之前未完成的 异步搜索。默认为false。 -
page_timeout - （可选，时间值）滚动游标的最小保留期。在此时间段之后，分页请求 可能会失败，因为滚动游标不再可用。后续滚动请求会将滚动游标的生命周期延长滚动请求中
page_timeout的持续时间。默认为45s（45 秒）。 -
params - （可选，数组）
query中参数的值。有关语法，请参阅 将参数传递给查询。 -
query - （必填，对象）要运行的 SQL 查询。有关语法，请参阅 SQL 语言。
-
request_timeout - （可选，时间值）请求失败之前的超时时间。默认为
90s（90 秒）。 -
runtime_mappings -
（可选，对象的 object）在搜索请求中定义一个或多个 运行时字段。这些字段优先于同名的映射字段。
runtime_mappings对象的属性-
<字段名称> -
（必填，对象）运行时字段的配置。键是字段名称。
<字段名称> 的属性
-
type -
（必填，字符串）字段类型，可以是以下任意一种
-
boolean -
composite -
date -
double -
geo_point -
ip -
keyword -
long -
lookup
-
-
script -
（可选，字符串）在查询时执行的 Painless 脚本。该脚本可以访问文档的整个上下文，包括原始
_source和任何映射字段及其值。此脚本必须包含
emit才能返回计算值。例如"script": "emit(doc['@timestamp'].value.dayOfWeekEnum.toString())"
-
-
-
time_zone - （可选，字符串）搜索的 ISO-8601 时区 ID。一些 SQL 日期/时间函数 使用此时区。默认为
Z（UTC）。 -
wait_for_completion_timeout -
（可选，时间值）等待完整结果的时间段。默认为无超时，这意味着请求会等待完整的搜索结果。如果搜索未在此时间段内完成，则搜索将变为 异步。
要 保存同步搜索，您必须指定此参数和
keep_on_completion参数。
响应正文编辑
SQL 搜索 API 支持 多种响应格式。大多数响应格式使用表格布局。JSON 响应包含以下属性
-
id - （字符串）搜索的标识符。此值仅针对 异步 和 已保存的同步搜索 返回。对于 CSV、TSV 和 TXT 响应，此值在
Async-IDHTTP 标头中返回。 -
is_running - （布尔值）如果为
true，则搜索仍在运行。如果为false，则搜索已完成。此值仅针对 异步 和 已保存的同步搜索 返回。对于 CSV、TSV 和 TXT 响应，此值在Async-partialHTTP 标头中返回。 -
is_partial -
（布尔值）如果为
true，则响应不包含完整的搜索结果。如果is_partial为true且is_running为true，则搜索仍在运行。如果is_partial为true但is_running为false，则结果是部分结果，原因是出现故障或超时。此值仅针对 异步 和 已保存的同步搜索 返回。对于 CSV、TSV 和 TXT 响应，此值在
Async-partialHTTP 标头中返回。 -
rows - （数组的数组）搜索结果的值。
-
columns -
（对象的数组）搜索结果的列标题。每个对象都是一列。
columns对象的属性-
name - （字符串）列的名称。
-
type - （字符串）列的数据类型。
-
-
cursor - （字符串）下一组分页结果的 游标。对于 CSV、TSV 和 TXT 响应，此值在
CursorHTTP 标头中返回。