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" } }}オプション
フィールド | タイプ | 説明 | 必須 |
|---|---|---|---|
| string | 検索するドキュメント フィールド。
| はい |
| 整数 | フィールドを強調表示するときにドキュメントで確認する最大文字数。省略した場合、デフォルトは | no |
| 整数 | 各フィールドの | no |
"$meta": "searchHighlights"フィールドにはハイライトされた結果が含まれます。そのフィールドは元のドキュメントの一部ではないため、クエリ出力に追加するには $project パイプラインステージを使用する必要があります。
出力
highlightsフィールドは、次の出力フィールドを含む配列です。
フィールド | タイプ | 説明 |
|---|---|---|
| string | 一致を返したドキュメント フィールド。 |
| ドキュメントの配列 | 各検索一致は、一致するテキストとその周囲のテキスト（存在する場合）を含む 1 つ以上の オブジェクトを返します。 |
| string | 一致を返したフィールドのテキスト。 |
| string | 結果のタイプ。 値は次のいずれかになります。
|
| float | 一致する結果に割り当てられたスコア。 |
前提条件
indexOptions を offsets に設定（デフォルト）して、ハイライトするフィールドをMongoDB Search string タイプとしてインデックス必要があります。
例
次の例は、 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 }}注意
強調表示の便利な点の 1 つは、検索クエリーによって返される元のテキストが表示されることです。このテキストは、検索タームと完全に一致しない場合があります。例、言語固有のアナライザを使用すると、テキスト検索では検索タームのすべての語幹付きバリエーションが返されます。
強調表示のもう 1 つの便利な面は、クエリpath内または外部で任意のフィールドを強調表示するために使用できることです。 たとえば、 というタームを検索する場合、クエリ フィールドとhighlightオプションを使用して指定したその他のフィールドのクエリ用語を強調表示できます。 詳細については、「マルチフィールドの例 」を参照してください。
サンプル クエリ
次のクエリは、 MongoDB Search クエリの $search highlight オプションを示しています。
基本的な例
次のクエリは、 fruitコレクションのdescriptionフィールドでvarietyとbunchを検索し、 highlightオプションを有効にします。
$project パイプライン ステージは、出力を description フィールドに制限し、ハイライト情報を含む highlights という新しいフィールドを追加します。
db.fruit.aggregate([ { $search: { "text": { "path": "description", "query": ["variety", "bunch"] }, "highlight": { "path": "description" } } }, { $project: { "description": 1, "_id": 0, "highlights": { "$meta": "searchHighlights" } } }])検索タームbunchは、 _id: 2を含むドキュメントに一致を返します。これは、 descriptionフィールドにbunchesという単語が含まれているためです。 検索タームvarietyは、 _id: 3と_id: 1を含むドキュメントに一致します。これは、 descriptionフィールドにvarietiesという単語が含まれているためです。
➤ MongoDB Search Playground でこれを試してみてください。
高度な例
次のクエリは、 fruitコレクションのdescriptionフィールドでvarietyとbunchを検索し、 highlightオプションを有効にし、検索する最大文字数を40に設定し、 1のみを検索します。ドキュメントごとに返される高スコアのパス。
$project パイプライン ステージは、出力を description フィールドに制限し、ハイライト情報を含む highlights という新しいフィールドを追加します。
db.fruit.aggregate([ { $search: { "text": { "path": "description", "query": ["variety", "bunch"] }, "highlight": { "path": "description", "maxNumPassages": 1, "maxCharsToExamine": 40 } } }, { $project: { "description": 1, "_id": 0, "highlights": { "$meta": "searchHighlights" } } }])上記の結果の 2 番目のドキュメントには、検索フィールドに検索タームvarieties が含まれているにもかかわらず空の highlights 配列が含まれています。これは、 MongoDB Search が強調表示するために 40 文字のみを検査したためです。同様に、 MongoDB Search は強調表示用に検索フィールドの 40文字のみを検査したため、includ という単語は切り捨てられます。3 番目のドキュメントでは、複数のパスに検索タームが含まれていますが、 MongoDB Search は highlights 結果の 1 つのパスのみを返します。クエリでは、highlights 結果内のドキュメントごとに 1 パスのみが必要であったためです。
➤ MongoDB Search Playground でこれを試してみてください。
マルチフィールドの例
varietiesdescriptionfruit次のクエリは、 コレクションの フィールドでhighlight を検索し、description summaryフィールドと フィールドの両方で オプションを有効にします。
$project パイプライン ステージには、highlightsという新しいフィールドが追加されます。このフィールドには、highlight オプションのすべてのフィールドにわたるクエリ用語の強調表示情報が含まれます。
db.fruit.aggregate([ { $search: { "text": { "path": "description", "query": "varieties" }, "highlight": { "path": ["description", "summary" ] } } }, { $project: { "description": 1, "summary": 1, "_id": 0, "highlights": { "$meta": "searchHighlights" } } }])検索タームvarietiesは、 _id: 1と_id: 3を含むドキュメントに一致を返します。両方のドキュメントのクエリ フィールドdescriptionにクエリ用語varietiesが含まれているためです。 さらに、 highlights配列にはsummaryフィールドが含まれます。このフィールドにはクエリ用語varietiesが含まれているためです。
➤ MongoDB Search Playground でこれを試してみてください。
ワイルドカードの例
次のクエリは、 fruitコレクション内のdesで始まるフィールドでvarietiesというタームを検索し、 desで始まるフィールドではhighlightオプションを有効にします。
$project パイプライン ステージには、ハイライト情報を含む highlights という新しいフィールドが追加されます。
db.fruit.aggregate([ { "$search": { "text": { "path": {"wildcard": "des*"}, "query": ["variety"] }, "highlight": { "path": {"wildcard": "des*"} } } }, { "$project": { "description": 1, "_id": 0, "highlights": { "$meta": "searchHighlights" } } }])MongoDB Search の結果では、des で始まるフィールドが強調表示されます。
➤ MongoDB Search Playground でこれを試してみてください。
複合例
次のクエリは、 categoryフィールドでorganicを検索し、 descriptionフィールドでvarietyという用語を検索します。 $search複合クエリのhighlightオプションは、 descriptionフィールドに対するテキストクエリのみの情報を強調表示するリクエストです。 ただし、 $searchステージ内のhighlightオプションは$searchステージの子であり、 $searchステージ内の演算子であってはなりません。
$project パイプライン ステージには、ハイライト情報を含む highlights という新しいフィールドが追加されます。
db.fruit.aggregate([ { "$search": { "compound": { "should": [{ "text": { "path": "category", "query": "organic" } }, { "text": { "path": "description", "query": "variety" } }] }, "highlight": { "path": "description" } } }, { "$project": { "description": 1, "category": 1, "_id": 0, "highlights": { "$meta": "searchHighlights" } } }])➤ MongoDB Search Playground でこれを試してみてください。
オートコンプリートの例
この例では、 fruitコレクションには次のインデックス定義もあります。
{ "mappings": { "dynamic": false, "fields": { "description": [ { "type": "autocomplete", "tokenization": "edgeGram", "minGrams": 2, "maxGrams": 15, "foldDiacritics": true } ] } }}次のクエリは、fruit コレクションの description フィールドで var の文字を検索し、description フィールドで highlight オプションを有効にします。
$project パイプライン ステージには、ハイライト情報を含む highlights という新しいフィールドが追加されます。
重要
パスのオートコンプリート インデックス バージョンを強調表示するには、オートコンプリート演算子がクエリ内でそのパスを使用する唯一の演算子である必要があります。
db.fruit.aggregate([ { "$search": { "autocomplete": { "path": "description", "query": ["var"] }, "highlight": { "path": "description" } } }, { "$project": { "description": 1, "_id": 0, "highlights": { "$meta": "searchHighlights" } } }])MongoDB Search では、クエリ文字列var に対して _id: 1 と id_: 2 を含むドキュメントが一致します。これは、fruitコレクションの descriptionフィールドに単語の先頭に文字 var が含まれているためです。 強調表示されたパスが強調表示されたクエリのオペレーターでのみ参照されている場合、 MongoDB Search は強調表示された hit を、より大まかにクエリタームと一致させます。
➤ MongoDB Search Playground でこれを試してみてください。