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

警告

搜索端点需要连接到每个群集节点的正在运行的搜索插件。看到了吗 Search Plugin Installation 有关详细信息。

3.0 新版功能.

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

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

参数:
  • db -- 数据库名称
  • ddoc -- 设计文件名称
  • index -- 搜索索引名称
请求标头:
  • Accept --
    • application/json
    • text/plain
查询参数:
  • bookmark (string) -- 从上一次搜索中收到的书签。此参数允许对结果进行分页。如果书签之后没有其他结果，则会得到一个带有空行数组和相同书签的响应，确认结果列表的结尾。
  • counts (json) -- 请求计数的字符串字段的名称数组。响应包含与搜索查询匹配的文档中此字段名的每个唯一值的计数。 Faceting 必须启用此参数才能正常工作。
  • drilldown (json) -- 此字段可以多次使用。每次使用都会定义一对字段名和一个值。搜索只匹配包含在命名字段中提供的值的文档。它不同于使用 "fieldname:value" 在 q 参数只在不分析值的情况下使用。 Faceting 必须启用此参数才能正常工作。
  • 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数组。包含的任何字段都必须使用商店：真选项。
  • limit (number) -- 将返回的文档数限制在指定的数目内。对于分组搜索，此参数限制每个组的文档数。
  • q (string) -- Alias query .
  • query (string) -- 必修的。Lucene查询字符串。
  • ranges (json) -- 此字段定义分面数字搜索字段的范围。该值是一个JSON对象，其中字段名是分面数字搜索字段，字段的值是JSON对象。JSON对象的字段名是范围的名称。值是描述范围的字符串，例如“ [0到10] “。
  • sort (json) -- 指定结果的排序顺序。在分组搜索中（当 group_field ，此参数指定组内的排序顺序。默认的排序顺序是相关性。表单的JSON字符串 "fieldname<type>" 或 -fieldname<type> 对于降序，其中fieldname是字符串或数字字段的名称，并且 type 是数字、字符串或字符串的JSON数组。这个 type part是可选的，默认为number。一些例子是 "foo" ， "-foo" ， "bar<string>" ， "-foo<number>" 和 ["-foo<number>", "bar<string>"] . 用于排序的字符串字段不能是分析字段。用于排序的字段必须由用于搜索查询的同一索引器编制索引。
  • stale (string) -- 设置为 ok 允许使用过期索引。
响应头:
响应JSON对象:
  • rows (array) -- 视图行对象的数组。默认情况下，返回的信息只包含文档ID和修订。
  • total_rows (number) -- 数据库/视图中的文档数。
  • bookmark (string) -- 启用分页的不透明标识符。
状态代码:

注解

您必须启用 faceting 在使用之前 counts ， drilldown 和 ranges 参数。

注解

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

注解

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

参见

有关搜索如何工作的详细信息，请参阅 Search User Guide .

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

警告

搜索端点需要连接到每个群集节点的正在运行的搜索插件。看到了吗 Search Plugin Installation 有关详细信息。

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

响应 ：

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