1.5.5. /db/_design/design-doc/_search/index-name

警告

搜索端点需要一个运行的搜索插件连接到每个集群节点。有关详细信息，请参阅 搜索插件安装。

3.0 版新增。

GET /{db}/_design/{ddoc}/_search/{index}

对指定设计文档中的命名索引执行搜索请求。

参数：

  • db – 数据库名称

  • ddoc – 设计文档名称

  • index – 搜索索引名称

请求头：

  • Accept –

    • application/json

    • text/plain

查询参数：

  • bookmark (string) – 从先前搜索接收到的书签。此参数允许对结果进行分页。如果书签之后没有更多结果，您将收到一个响应，其中包含一个空的 rows 数组和相同的书签，确认结果列表的末尾。

  • counts (json) – 要请求计数的字符串字段名称数组。响应包含此字段名称在匹配搜索查询的文档中每个唯一值的计数。 分面 必须为此参数启用才能正常工作。

  • drilldown (json) – 此字段可以多次使用。每次使用都定义一对，包含字段名称和值。搜索仅匹配包含在命名字段中提供的值的文档。它与在 q 参数中使用 "fieldname:value" 不同，因为值不会被分析。 分面 必须为此参数启用才能正常工作。

  • group_field (string) – 用于对搜索匹配项进行分组的字段。:query number group_limit: 最大组计数。仅当指定了 group_field 时，才能使用此字段。

  • group_sort (json) – 此字段定义使用 group_field 的搜索中组的顺序。默认排序顺序为相关性。

  • highlight_fields (json) – 指定要突出显示的字段。如果指定，结果对象将包含一个 highlights 字段，其中包含每个指定字段的条目。

  • highlight_pre_tag (string) – 在突出显示的单词之前插入到突出显示输出中的字符串。

  • highlight_post_tag (string) – 在突出显示的单词之后插入到突出显示输出中的字符串。

  • highlight_number (number) – 在突出显示中返回的片段数量。如果搜索词出现的频率低于指定的片段数量，则返回更长的片段。

  • highlight_size (number) – 每个突出显示片段的字符数。

  • include_docs (boolean) – 在响应中包含文档的完整内容。

  • include_fields (json) – 要包含在搜索结果中的字段名称的 JSON 数组。任何包含的字段都必须使用 store:true 选项进行索引。

  • limit (number) – 将返回的文档数量限制为指定的数量。对于分组搜索，此参数限制每个组的文档数量。

  • q (string) – query 的别名。

  • query (string) – 必需。Lucene 查询字符串。

  • ranges (json) – 此字段定义分面、数字搜索字段的范围。该值是一个 JSON 对象，其中字段名称是分面数字搜索字段，字段的值是 JSON 对象。JSON 对象的字段名称是范围的名称。值是描述范围的字符串，例如“[0 TO 10]”。

  • sort (json) – 指定结果的排序顺序。在分组搜索（当使用 group_field 时），此参数指定组内的排序顺序。默认排序顺序为相关性。形式为 "fieldname<type>" 或 -fieldname<type> 的 JSON 字符串，用于降序排列，其中 fieldname 是字符串或数字字段的名称，type 是数字、字符串或字符串的 JSON 数组。type 部分是可选的，默认为数字。一些示例是 "foo"、"-foo"、"bar<string>"、"-foo<number>" 和 ["-foo<number>", "bar<string>"]。用于排序的字符串字段不能是分析字段。用于排序的字段必须由与搜索查询使用的相同索引器索引。

  • stale (string) – 设置为 ok 以允许使用过时的索引。

响应头：
响应 JSON 对象：

  • rows (array) – 视图行对象的数组。默认情况下，返回的信息仅包含文档 ID 和修订版。

  • total_rows (number) – 数据库/视图中的文档数量。

  • bookmark (string) – 用于启用分页的不透明标识符。

状态码：

注意

您必须启用 分面 才能使用 counts、drilldown 和 ranges 参数。

注意

分面和分组在分区搜索中不受支持，因此以下查询参数不应在这些请求中使用：counts、drilldown、ranges 以及 group_field、group_limit、group_sort``。

注意

不要将 bookmark 和 stale 选项组合在一起。这些选项限制了对响应使用分片副本的选择。当一起使用时，这些选项可能会在尝试与速度慢或不可用的副本联系时导致问题。

另请参阅

有关搜索工作原理的更多信息，请参阅 搜索用户指南。

1.5.6. /db/_design/design-doc/_search_info/index-name

警告

搜索端点需要一个运行的搜索插件连接到每个集群节点。有关详细信息，请参阅 搜索插件安装。

3.0 版新增。

GET /{db}/_design/{ddoc}/_search_info/{index}
参数：

  • db – 数据库名称

  • ddoc – 设计文档名称

  • index – 搜索索引名称

状态码：

请求:

GET /recipes/_design/cookbook/_search_info/ingredients HTTP/1.1
Accept: application/json
Host: localhost:5984

响应:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "name": "_design/cookbook/ingredients",
    "search_index": {
        "pending_seq": 7125496,
        "doc_del_count": 129180,
        "doc_count": 1066173,
        "disk_size": 728305827,
        "committed_seq": 7125496
    }
}