Search / URI Search

search API 允许你执行一个搜索查询并返回与查询匹配的搜索点击。可以使用简单的查询字符串作为参数或使用请求主体提供查询。

Multi-Index, Multi-Type

所有 search API 可以应用于索引内的跨多个类型,并跨多个索引应用,支持多索引语法。 例如,我们可以在 twitter 索引中搜索所有类型的所有文档:

GET /twitter/_search?q=user:kimchy

我们还可以在特定类型中进行搜索:

GET /twitter/tweet,user/_search?q=user:kimchy

我们还可以在多个索引之间搜索具有某个标签的所有 tweet(例如,当每个用户都有自己的索引时):

GET /kimchy,elasticsearch/tweet/_search?q=tag:wow

或者我们可以使用_all占位符搜索所有可用索引中的所有tweet:

GET /_all/tweet/_search?q=tag:wow

甚至搜索所有的索引和所有类型:

GET /_search?q=tag:wow

默认情况下,elasticsearch 拒绝将查询超过 1000 个分片的搜索请求。 原因是这样大量的分片使协调节点的工作非常耗费 CPU 和内存。 使用较少的较大碎片这种方式组织数据通常是一个更好的主意。 如果您想绕过此限制(不鼓励),可以将 action.search.shard_count.limit集群设置更新为更大的值。

Parameters

URI 中允许使用的参数有:

Name

Description

_source

设置为false以禁用检索 _source 字段。您还可以使用 _source_include&_source_exclude 检索文档的一部分(有关更多详细信息,请参阅请求主体文档)。

analyze_wildcard

应该分析通配符和前缀查询还是不分析。默认为 false。

analyzer

分析查询字符串时使用的分析器名称。

default_operator

要使用的默认运算符,可以是 AND 或 OR 。默认为 OR。

df

在查询中未定义字段前缀时使用的默认字段。

explain

对于每个命中,包含对如何计算命中的计分的解释。

from

从命中的索引开始返回。默认值为 0。

lenient

如果设置为 true 将导致基于格式的失败(例如向数字字段提供文本)被忽略。默认为 false。

lowercase_expanded_terms

应将条款自动缩小或不缩小。默认为 true。

q

查询字符串(映射到 query_string 查询,有关更多详细信息,请参阅查询字符串查询)

search_type

要执行的搜索操作的类型。可以是 dfs_query_then_fetch 或 query_then_fetch。默认为 query_then_fetch。有关可以执行的不同类型搜索的更多详细信息,请参阅搜索类型。

size

要返回的匹配数。默认值为 10。

sort

排序执行。可以是 fieldName 或 fieldName:asc/fieldName:desc的形式。 fieldName 可以是文档中的实际字段,也可以是指示基于分数排序的特殊 _score 名称。可以有几个 sort 参数(顺序很重要)。

stored_fields

为每次命中返回文档的选择性存储字段,逗号分隔。未指定任何值将不会返回任何字段。

terminate_after

要为每个分片收集的文档的最大数量,到达时,查询执行将提前终止。如果设置,响应将有布尔型字段 terminated_early 以指示查询执行是否实际已提前终止。默认为无terminate_after。

timeout

搜索超时,将搜索请求限制为在指定的时间值内执行并且保留与到期时累积的点击数。默认为无超时。

track_scores

排序时,设置为 true 以便仍然跟踪分数并将其作为每次匹配的一部分返回。

可以通过提供请求参数来纯粹使用 URI 来执行搜索请求。 在使用此模式执行搜索时,并非所有搜索选项都会公开,但它可以方便快速的“卷曲测试”。

这里给出一个例子:

GET twitter/tweet/_search?q=user:kimchy

并给出一个示例响应:

{
    "timed_out": false,
    "took": 62,
    "_shards":{
        "total" : 1,
        "successful" : 1,
        "failed" : 0
    },
    "hits":{
        "total" : 1,
        "max_score": 1.3862944,
        "hits" : [
            {
                "_index" : "twitter",
                "_type" : "tweet",
                "_id" : "0",
                "_score": 1.3862944,
                "_source" : {
                    "user" : "kimchy",
                    "date" : "2009-11-15T14:12:12",
                    "message" : "trying out Elasticsearch",
                    "likes": 0
                }
            }
        ]
    }
}

Parameters

URI 中允许使用的参数有:

Name

Description

q

查询字符串(映射到 query_string 查询,有关更多详细信息,请参阅查询字符串查询)

df

在查询中未定义字段前缀时使用的默认字段。

analyzer

分析查询字符串时使用的分析器名称。

lowercase_expanded_terms

应将条款自动缩小或不缩小。默认为 true。

analyze_wildcard

应该分析通配符和前缀查询还是不分析。默认为 false。

default_operator

要使用的默认运算符,可以是 AND 或 OR 。默认为 OR。

lenient

如果设置为 true 将导致基于格式的失败(例如向数字字段提供文本)被忽略。默认为 false。

explain

对于每个命中,包含对如何计算命中的计分的解释。

_source

设置为false以禁用检索 _source 字段。您还可以使用 _source_include&_source_exclude 检索文档的一部分(有关更多详细信息,请参阅请求主体文档)。

stored_fields

为每次命中返回文档的选择性存储字段,逗号分隔。未指定任何值将不会返回任何字段。

sort

排序执行。可以是 fieldName 或 fieldName:asc/fieldName:desc的形式。 fieldName 可以是文档中的实际字段,也可以是指示基于分数排序的特殊 _score 名称。可以有几个 sort 参数(顺序很重要)。

track_scores

排序时,设置为 true 以便仍然跟踪分数并将其作为每次匹配的一部分返回。

timeout

搜索超时,将搜索请求限制为在指定的时间值内执行并且保留与到期时累积的点击数。默认为无超时。

terminate_after

要为每个分片收集的文档的最大数量,到达时,查询执行将提前终止。如果设置,响应将有布尔型字段 terminated_early 以指示查询执行是否实际已提前终止。默认为无terminate_after。

from

从命中的索引开始返回。默认值为 0。

size

要返回的匹配数。默认值为 10。

search_type

要执行的搜索操作的类型。可以是 dfs_query_then_fetch 或 query_then_fetch。默认为 query_then_fetch。有关可以执行的不同类型搜索的更多详细信息,请参阅搜索类型。

Last updated