MongoDB Search highlight 选项将字段添加到结果设立，这些字段在原始上下文中显示搜索词。您可以将其与所有 $search 操作符结合使用，以显示返回文档中出现的搜索词以及相邻的文本内容（如果有）。highlight 结果作为 $meta字段的一部分返回。
highlight 选项限制
不能将MongoDB Search highlight 选项与 embeddedDocument 操作符结合使用。
语法
highlight 通过以下语法实现：
{ $search: { "index": "<index name>", // optional, defaults to "default" "<operator>": { // such as "text", "compound", or "phrase" <operator-specification> }, "highlight": { "path": "<field-to-search>", "maxCharsToExamine": "<number-of-chars-to-examine>", // optional, defaults to 500,000 "maxNumPassages": "<number-of-passages>" // optional, defaults to 5 } } }, { $project: { "highlights": { "$meta": "searchHighlights" } } }
选项
字段 | 类型 | 说明 | 必需？ |
|---|---|---|---|
| 字符串 | 要搜索的文档字段。
| 是 |
| int | 对字段执行突出显示时在文档上检查的最大字符数。如果省略，则默认为 | no |
| int | 每个字段的 | no |
The "$meta": "searchHighlights" field contains the highlighted results. That field isn't part of the original document, so it is necessary to use a $project pipeline stage to add it to the query output.
输出
highlights 字段是一个包含以下输出字段的数组：
字段 | 类型 | 说明 |
|---|---|---|
| 字符串 | 返回匹配项的文档字段。 |
| 文档数组 | 每个搜索匹配都会返回一个或多个对象，其中包含匹配文本和周围文本（如果有）。 |
| 字符串 | 返回匹配项的字段中的文本。 |
| 字符串 | 结果类型。值可以是以下值之一：
|
| float | 分配给匹配结果的分数。 |
先决条件
您必须将要索引显示的字段索引为MongoDB Search 字符串 类型，并将 indexOptions设立为 offsets（默认）。
示例
您可以在MongoDB Search Playground 或集群中尝试以下示例。
示例集合
本页上的示例使用名为 fruit 的集合，其中包含以下文档：
{ "_id" : 1, "type" : "fruit", "summary" : "Apple varieties", "description" : "Apples come in several varieties, including Fuji, Granny Smith, and Honeycrisp. The most popular varieties are McIntosh, Gala, and Granny Smith.", "category": "organic" }, { "_id" : 2, "type" : "fruit", "summary" : "Banana", "description" : "Bananas are usually sold in bunches of five or six.", "category": "nonorganic" }, { "_id" : 3, "type" : "fruit", "summary" : "Pear varieties", "description" : "Bosc and Bartlett are the most common varieties of pears.", "category": "nonorganic" }
样本索引
fruit 集合也有使用英文版分析器和动态字段映射的索引定义。
{ "analyzer": "lucene.english", "searchAnalyzer": "lucene.english", "mappings": { "dynamic": true } }
样本查询
以下查询演示了MongoDB Search 查询中的$search highlight 选项。
基本示例
以下查询在启用了 highlight 选项的情况下在fruit 集合的 description 字段中搜索 variety 和 bunch。
The $project pipeline stage restricts the output to the description field and adds a new field called highlights, which contains highlighting information.
1 db.fruit.aggregate([ 2 { 3 $search: { 4 "text": { 5 "path": "description", 6 "query": ["variety", "bunch"] 7 }, 8 "highlight": { 9 "path": "description" 10 } 11 } 12 }, 13 { 14 $project: { 15 "description": 1, 16 "_id": 0, 17 "highlights": { "$meta": "searchHighlights" } 18 } 19 } 20 ])
搜索词语 bunch 返回包含 _id: 2 的文档的匹配项，因为 description 字段包含词语 bunches。搜索词语 variety 返回包含 _id: 3 和 _id: 1的文档的匹配项，因为 description 字段包含词语 varieties。
➤ 在MongoDB Search Playground中尝试一下。
高级示例
以下查询在 fruit 集合的 description 字段中搜索 variety 和 bunch，启用了 highlight 选项，将要检查的最大字符数设置为 40，并且仅为每个文档返回 1 个高分段落。
The $project pipeline stage restricts the output to the description field and adds a new field called highlights, which contains highlighting information.
1 db.fruit.aggregate([ 2 { 3 $search: { 4 "text": { 5 "path": "description", 6 "query": ["variety", "bunch"] 7 }, 8 "highlight": { 9 "path": "description", 10 "maxNumPassages": 1, 11 "maxCharsToExamine": 40 12 } 13 } 14 }, 15 { 16 $project: { 17 "description": 1, 18 "_id": 0, 19 "highlights": { "$meta": "searchHighlights" } 20 } 21 } 22 ])
即使搜索字段包含搜索术语varieties，上述结果中的第二个文档也包含空 highlights大量，因为MongoDB Search 仅检查 40 个字符以进行突出显示。同样，单词 includ 会被截断，因为MongoDB Search 仅检查搜索字段中的 40 个字符以进行突出显示。在第三个文档中，尽管多个段落包含搜索术语，但MongoDB Search 仅在 highlights 结果中返回一个段落，因为查询仅需要 highlights 结果中每个文档的 1 个段落。
➤ 在MongoDB Search Playground中尝试一下。
多字段示例
以下查询在fruit 集合的 description 字段中搜索 varieties，并为 description 和 summary 字段启用了 highlight 选项。
The $project pipeline stage adds a new field called highlights, which contains highlighting information for the query term across all fields in the highlight option.
1 db.fruit.aggregate([ 2 { 3 $search: { 4 "text": { 5 "path": "description", 6 "query": "varieties" 7 }, 8 "highlight": { 9 "path": ["description", "summary" ] 10 } 11 } 12 }, 13 { 14 $project: { 15 "description": 1, 16 "summary": 1, 17 "_id": 0, 18 "highlights": { "$meta": "searchHighlights" } 19 } 20 } 21 ])
搜索词语 varieties 返回包含 _id: 1 和 _id: 3 的文档的匹配项，因为这两个文档中的查询字段 description 包含查询词语 varieties。此外，highlights 数组还包括 summary 字段，因为该字段包含查询词语 varieties。
➤ 在MongoDB Search Playground中尝试一下。
通配符示例
以下查询在 fruit 集合中以 des 开头的字段中搜索词语 varieties，并为以 des 开头的字段启用了 highlight 选项。
The $project pipeline stage adds a new field called highlights, which contains highlighting information.
1 db.fruit.aggregate([ 2 { 3 "$search": { 4 "text": { 5 "path": {"wildcard": "des*"}, 6 "query": ["variety"] 7 }, 8 "highlight": { 9 "path": {"wildcard": "des*"} 10 } 11 } 12 }, 13 { 14 "$project": { 15 "description": 1, 16 "_id": 0, 17 "highlights": { "$meta": "searchHighlights" } 18 } 19 } 20 ])
在MongoDB搜索结果中，以 des 开头的字段会突出显示。
➤ 在MongoDB Search Playground中尝试一下。
复合示例
以下查询在 category 字段中搜索词语 organic，并在 description 字段中搜索词语 variety。$search compound 查询中的 highlight 选项仅为针对 description 字段的 text 查询请求突出显示信息。请注意，$search 阶段中的 highlight 选项必须是 $search 阶段的子阶段，而不是 $search 阶段中的任何操作符的子操作符。
The $project pipeline stage adds a new field called highlights, which contains highlighting information.
1 db.fruit.aggregate([ 2 { 3 "$search": { 4 "compound": { 5 "should": [{ 6 "text": { 7 "path": "category", 8 "query": "organic" 9 } 10 }, 11 { 12 "text": { 13 "path": "description", 14 "query": "variety" 15 } 16 }] 17 }, 18 "highlight": { 19 "path": "description" 20 } 21 } 22 }, 23 { 24 "$project": { 25 "description": 1, 26 "category": 1, 27 "_id": 0, 28 "highlights": { "$meta": "searchHighlights" } 29 } 30 } 31 ])
➤ 在MongoDB Search Playground中尝试一下。
自动完成示例
在本例中，fruit 集合也有如下索引定义。
{ "mappings": { "dynamic": false, "fields": { "description": [ { "type": "autocomplete", "tokenization": "edgeGram", "minGrams": 2, "maxGrams": 15, "foldDiacritics": true } ] } } }
以下查询在fruit 集合的 description 字段中搜索 var 字符，并为 description 字段启用了 highlight 选项。
The $project pipeline stage adds a new field called highlights, which contains highlighting information.
重要
要突出显示路径的自动完成索引版本，autocomplete 操作符必须是在查询中使用该路径的唯一操作符。
1 db.fruit.aggregate([ 2 { 3 "$search": { 4 "autocomplete": { 5 "path": "description", 6 "query": ["var"] 7 }, 8 "highlight": { 9 "path": "description" 10 } 11 } 12 }, 13 { 14 "$project": { 15 "description": 1, 16 "_id": 0, 17 "highlights": { "$meta": "searchHighlights" } 18 } 19 } 20 ])
MongoDB搜索会为查询字符串 var 返回包含 _id: 1 和 id_: 2 的文档的匹配项，因为 fruit集合中的 description字段在单词开头包含字符 var。 当突出显示的路径仅在突出显示的查询的 autocomplete 操作符中引用时， MongoDB搜索会更粗略地将突出显示的 hit 与查询词语进行匹配。
➤ 在MongoDB Search Playground中尝试一下。