› › ›

ES|QL 查询 API

ES|QL 查询 API编辑

POST /_query
{
  "query": """
    FROM library
    | EVAL year = DATE_TRUNC(1 YEARS, release_date)
    | STATS MAX(page_count) BY year
    | SORT year
    | LIMIT 5
  """
}

请求编辑

POST _query

先决条件编辑

如果启用了 Elasticsearch 安全功能，则您必须对要搜索的数据流、索引或别名具有 read 索引权限。

查询参数编辑

delimiter

（可选，字符串）CSV 结果的分隔符。默认为 ,。API 仅针对 CSV 响应支持此参数。

drop_null_columns

（可选，布尔值）是否应从结果的 columns 和 values 部分中删除完全为 null 的列？默认为 false。如果为 true，则响应将在名为 all_columns 的部分下包含一个额外的部分，其中包含所有列的名称。

format

（可选，字符串）响应的格式。有关有效值，请参阅响应格式。

您还可以使用 Accept HTTP 标头指定格式。如果同时指定了此参数和 Accept HTTP 标头，则此参数优先。

请求正文编辑

columnar: （可选，布尔值）如果为 true，则以列格式返回结果。默认为 false。API 仅针对 CBOR、JSON、SMILE 和 YAML 响应支持此参数。请参阅列式结果。
locale: （可选，字符串）返回根据语言环境的约定格式化的结果（尤其是日期）。有关语法，请参阅返回本地化结果。
params: （可选，数组）query 中参数的值。有关语法，请参阅将参数传递给查询。
query: （必填，字符串）要运行的 ES|QL 查询。有关语法，请参阅语法参考。

响应正文编辑

columns: （对象数组）values 中返回的每个列的列 name 和 type。每个对象都是一个单独的列。
all_columns: （对象数组）每个查询列的列 name 和 type。每个对象都是一个单独的列。仅当请求中发送了 drop_null_columns 时才会返回此项。
rows: （数组数组）搜索结果的值。

« ES|QL API ES|QL 异步查询 API »