$text（クエリ述語演算子）

制限事項

• クエリでは、 $text式を 1 つだけ指定できます。

• $text は $nor 式には使用できません。

• $text $elemMatch は、クエリまたはプロジェクション式には使用できません。

• $text を使用するには、すべての $or 句をインデックス化する必要があります。

• クエリに$text式が含まれている場合、 hint()を使用してクエリに使用するインデックスを指定することはできません。

• $text を含むクエリでは $natural 並べ替えを使用できません。

• 特殊なテキストインデックスを必要とする $text 式と、別のタイプの特殊インデックスを必要とするクエリ 演算子を組み合わせることはできません。たとえば、 $text 式を $near 演算子と組み合わせることはできません。

• ビューは$textをサポートしていません。

• Stable API V1 はインデックス作成用の $text をサポートしていません。

集計で $text 演算子を使う場合、以下の制限も適用されます。

• $textを含む$matchステージは、パイプラインの最初のステージである必要があります。

• $text演算子は ステージ内で 1 回のみ発生できます。

• $text演算子式は、 $orまたは$not式には使用できません。

• $textは、デフォルトでは、で一致したドキュメントを一致スコアの順序で返すことはありません。スコアの降順で並べ替えるには、$sort ステージで $meta 集計式を使用します。

$search フィールド

$searchフィールドに、 MongoDB がテキストインデックスをクエリするのに使用する単語を指定します。

"\"ssl certificate\""

"\"ssl certificate\" authority key"

一致操作

大文字と小文字の区別なし

$text は テキストインデックスの大文字と小文字を区別しないにデフォルト設定します。

• バージョン 3 テキストインデックスでは、発音区別符号の有無にかかわらず、ラテン文字や、キリル文字など非ラテン文字では大文字と小文字が区別されません。

• 以前のバージョンでは、発音区別符号のないラテン文字は大文字と小文字を区別しませんでした（[A-z]）。

発音区別符号の区別なし

$text は テキストインデックスの発音区別符号を区別せずにデフォルト設定されます。

• バージョン 3 のテキストインデックスは、発音区別符号を区別しません。インデックスでは、発音区別符号付きの文字と含まない文字を区別しません（é、ê、e）。

• 以前のバージョンでは、発音区別符号が区別されます。

テキストスコア

$text 演算子は各結果ドキュメントにスコアを割り当てます。スコアは、特定のクエリに対するドキュメントの関連性を表します。スコアは、sort() メソッド仕様の一部だけでなく、プロジェクション式の一部にもなります。{ $meta: "textScore" } 式には $text 操作の処理に関する情報が含まれます。プロジェクションまたはソートのためのスコアへのアクセス方法の詳細については、$meta プロジェクション 演算子を参照してください。

1 つの単語を検索

この例では、$searchstring に baseball を指定しています。クエリでは、インデックス付き title または fullplot フィールドに baseball の語幹付きバージョンを含むドキュメントが返されます。

db.movies.find(
   { $text: { $search: "baseball" }, runtime: { $gt: 1000 } },
   { _id: 0, title: 1, year: 1, runtime: 1 }
)

[ { title: 'Baseball', year: 1994, runtime: 1140 } ]

任意の検索期間に一致する

スペースで区切られた $search string は、各期間に対して論理 OR を実行します。MongoDB は、 期間 のいずれかを含むドキュメントを返します。

この例では、スペースで区切られた 2 つの期間を指定しています。クエリでは、インデックス付き title または fullplot フィールドに baseball または colorado の語幹付きバージョンを含むドキュメントが返されます。

db.movies.find(
   { $text: { $search: "baseball colorado" },
     runtime: { $gt: 1000 } },
   { _id: 0, title: 1, year: 1, runtime: 1, fullplot: 1 }
)

[
  {
    runtime: 1140,
    title: 'Baseball',
    fullplot: 'Ken Burns relates the history of baseball in a fashion similar to that of his Civil War mini series. Old-time photos and illustrations depict the games early years, while newsreels and video clips highlight more recent developments. Players and participants speak in their own words, and sports writers and broadcasters offer commentary on the sport and events they witnessed.',
    year: 1994
  },
  {
    runtime: 1256,
    title: 'Centennial',
    fullplot: 'This is the story of the evolution of the town Centennial, Colorado. It follows the paths of dozens of people who come to the area for many reasons: money, freedom, or crime. It also shows the bigoted treatment of the Native Indians by the advancing US colonists. It is topped off with a murder mystery that takes 100 years to solve.',
    year: 1978
  }
]

完全一致の string を検索

複数単語を含む正確な文字列と一致するように引用符をエスケープします。

この例ではken burns というフレーズに完全に一致しています。

db.movies.find(
   { $text: { $search: "\"ken burns\"" },
     runtime: { $gt: 1000 } },
   { _id: 0, title: 1, year: 1, runtime: 1, fullplot: 1 }
)

[
  {
    runtime: 1140,
    title: 'Baseball',
    fullplot: 'Ken Burns relates the history of baseball in a fashion similar to that of his Civil War mini series. Old-time photos and illustrations depict the games early years, while newsreels and video clips highlight more recent developments. Players and participants speak in their own words, and sports writers and broadcasters offer commentary on the sport and events they witnessed.',
    year: 1994
  }
]

この例では、2 つの正確な文字列の論理和を実行します。

db.movies.find(
   { $text: { $search: "\'ken burns\' \'centennial\'" },
     runtime: { $gt: 1000 } },
   { _id: 0, title: 1, year: 1, runtime: 1, fullplot: 1 }
)

[
  {
    runtime: 1140,
    title: 'Baseball',
    fullplot: 'Ken Burns relates the history of baseball in a fashion similar to that of his Civil War mini series. Old-time photos and illustrations depict the games early years, while newsreels and video clips highlight more recent developments. Players and participants speak in their own words, and sports writers and broadcasters offer commentary on the sport and events they witnessed.',
    year: 1994
  },
  {
    runtime: 1256,
    title: 'Centennial',
    fullplot: 'This is the story of the evolution of the town Centennial, Colorado. It follows the paths of dozens of people who come to the area for many reasons: money, freedom, or crime. It also shows the bigoted treatment of the Native Indians by the advancing US colonists. It is topped off with a murder mystery that takes 100 years to solve.',
    year: 1978
  }
]

タームを含むドキュメントを除外する

タームの前に - を付けると、そのタームを含むドキュメントを除外します。

この例では、 baseball または colorado を含むが sport は含まないドキュメントと一致します（ステミング バージョン）。

db.movies.find(
   { $text: { $search: "baseball colorado -sport" },
     runtime: { $gt: 1000 } },
   { _id: 0, title: 1, year: 1, runtime: 1 }
)

[ { title: 'Centennial', year: 1978, runtime: 1256 } ]

関連性スコアの例え

db.movies.find(
   { $text: { $search: "baseball" }, runtime: { $gt: 1000 } },
   { _id: 0, title: 1, year: 1,
     score: { $meta: "textScore" } }
)

[
  {
    title: 'Baseball',
    year: 1994,
    score: ...
  }
]

db.movies.find(
   { $text: { $search: "baseball colorado" },
     runtime: { $gt: 1000 } },
   { _id: 0, title: 1, year: 1,
     score: { $meta: "textScore" } }
).sort( { score: { $meta: "textScore" } } ).limit(2)

[
  { title: 'Baseball', year: 1994, score: ... },
  { title: 'Centennial', year: 1978, score: ... }
]

db.movies.find(
   { runtime: { $gt: 1000 },
     $text: { $search: "baseball colorado" } },
   { _id: 0, title: 1, year: 1,
     score: { $meta: "textScore" } }
).sort( { year: 1, score: { $meta: "textScore" } } )

[
  { title: 'Centennial', year: 1978, score: ... },
  { title: 'Baseball', year: 1994, score: ... }
]

異なる言語のクエリ

このページの残りの例では、バージョン 3 テキストインデックスを持つ articlesコレクションをsubject 上で使用します。

db.articles.createIndex( { subject: "text" } )

コレクションには、次のドキュメントが含まれます。

db.articles.insertMany( [
   { _id: 1, subject: "coffee", author: "xyz", views: 50 },
   { _id: 2, subject: "Coffee Shopping", author: "efg", views: 5 },
   { _id: 3, subject: "Baking a cake", author: "abc", views: 90  },
   { _id: 4, subject: "baking", author: "xyz", views: 100 },
   { _id: 5, subject: "Café Con Leche", author: "abc", views: 200 },
   { _id: 6, subject: "Сырники", author: "jkl", views: 80 },
   { _id: 7, subject: "coffee and cream", author: "efg", views: 10 },
   { _id: 8, subject: "Cafe con Leche", author: "xyz", views: 10 }
] )

$language を使用して、$search string のストップワード、ステマー、トークナイザルールを決定する言語を指定します。

none の値に default_language を指定すると、テキストインデックスはストップワードを含むフィールド内の各単語を解析し、接尾辞の語幹を無視します。

この例では、言語として es（スペイン語）を指定しています。

db.articles.find(
   { $text: { $search: "leche", $language: "es" } }
)

[
  { _id: 5, subject: 'Café Con Leche', author: 'abc', views: 200 },
  { _id: 8, subject: 'Cafe con Leche', author: 'xyz', views: 10 }
]

spanish など、名前で言語を指定することもできます。サポートされている言語については、「自己管理型配置でのテキスト検索言語」を参照してください。

関連性スコアによる並べ替え

{ $meta: "textScore" }プロジェクションで式を指定せずに、 でsort() 式を指定できます。例:

db.articles.find(
   { $text: { $search: "cake" } }
).sort( { score: { $meta: "textScore" } } )

最終的に textScore を投影することなく、結果となるドキュメントを関連性で並べ替えることができます。

{ $meta: "textScore" }式をプロジェクションとsort()の両方に含めると、プロジェクションとソート ドキュメントで式のフィールド名が異なる場合があります。例、次の操作では、プロジェクションは式に score という名前のフィールドを使用し、sort() は ignoredName という名前のフィールドを使用します。

db.articles.find(
   { $text: { $search: "cake" } },
   { score: { $meta: "textScore" } }
).sort( { ignoredName: { $meta: "textScore" } } )

大文字と小文字、発音区別符号を区別しない

$text のデフォルトは テキストインデックスの大文字と小文字を区別せず、発音区別符号も区別しません。バージョン 3 の テキスト インデックスは、発音区別符号を持つラテン文字や、キリル文字のような非ラテン文字では、発音区別符号を区別せず、大文字と小文字を区別しません。「テキストインデックスの大文字と小文字を区別しない」および「テキストインデックスを発音区別符号を区別しない」を参照してください。

この例では、大文字と小文字を区別せず、発音区別符号も区別しないクエリを実行します。クエリは、バージョン 3 のテキスト インデックスを使用すると、次のように 語幹のある バージョンの検索タームを含むドキュメントと一致します。

db.articles.find( { $text: { $search: "сы́рники CAFÉS" } } )

[
  { _id: 6, subject: 'Сырники', author: 'jkl', views: 80 },
  { _id: 5, subject: 'Café Con Leche', author: 'abc', views: 200 },
  { _id: 8, subject: 'Cafe con Leche', author: 'xyz', views: 10 }
]

以前のテキストインデックスバージョンでは一致するドキュメントはありません。

大文字と小文字の区別

$caseSensitive: true で大文字と小文字の区別を有効にします。これにより、パフォーマンスが低下する恐れがあります。

db.articles.find(
   { $text: { $search: "Coffee", $caseSensitive: true } }
)

[ { _id: 2, subject: 'Coffee Shopping', author: 'efg', views: 5 } ]

db.articles.find( {
   $text: { $search: "\"Café Con Leche\"", $caseSensitive: true }
} )

[ { _id: 5, subject: 'Café Con Leche', author: 'abc', views: 200 } ]

db.articles.find(
   { $text: { $search: "Coffee -shop", $caseSensitive: true } }
)

[ { _id: 2, subject: 'Coffee Shopping', author: 'efg', views: 5 } ]

発音区別符号の区別

$diacriticSensitive: true を使用して、バージョン 3 テキスト インデックスで発音区別符号の区別を有効にします。これにより、パフォーマンスが低下する恐れがあります。

db.articles.find(
   { $text: { $search: "CAFÉ", $diacriticSensitive: true } }
)

[ { _id: 5, subject: 'Café Con Leche', author: 'abc', views: 200 } ]

db.articles.find(
   { $text: { $search: "leches -cafés", $diacriticSensitive: true } }
)

[ { _id: 8, subject: 'Cafe con Leche', author: 'xyz', views: 10 } ]