cursor.hint()（mongoshメソッド）

定義

cursor.hint(index)

重要

mongosh メソッド

このページでは、 mongosh メソッドが文書化されます。これは Node.js などの言語固有のドライバーのドキュメントではありません。

MongoDB API ドライバーについては、各言語の MongoDB ドライバー ドキュメントを参照してください。

MongoDB のデフォルトのインデックス選択とクエリ最適化プロセスを上書きするには、クエリでこのメソッドを呼び出します。コレクションの現在のインデックスのリストを返すには db.collection.getIndexes() を使用します。

cursor.hint()メソッドには次のパラメーターがあります。

Parameter	タイプ	説明
index	文字列またはドキュメント	クエリを実行する際に MongoDB が使用するように「ヒント」を与える、または強制するインデックス。インデックス名またはインデックス仕様ドキュメントのいずれかでインデックスを指定します。 また、{ $natural : 1 } を指定して、クエリで順方向にコレクションスキャンを強制的に実行したり、 { $natural : -1 } を指定して、逆方向にコレクションスキャンを実行したりすることもできます。

互換性

このメソッドは、次の環境でホストされている配置で使用できます。

• MongoDB Atlas はクラウドでの MongoDB 配置のためのフルマネージド サービスです

• MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン

• MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン

動作

• クエリシェイプにインデックス フィルターが存在する場合、MongoDB は hint() を無視します。

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

• 表示のインデックス、または存在しないインデックスで hint() を使用すると、操作はエラーを返します。

• 時系列コレクションでは、インデックス名を使用してヒントのみを指定でき、インデックス キー パターンは指定できません。

• クエリ設定は、インデックスのヒントよりも優先されます。 MongoDB は、一致するクエリ設定にインデックスヒントが含まれている場合、コマンド フィールドとして渡すインデックスヒントを無視します。インデックスのヒントはクエリシェイプには影響しません。ヒントとクエリ設定の詳細については、「 クエリ設定のシンタックス 」を参照してください。

例

db.users.find().hint( { age: 1 } )

db.users.find().hint( "age_1" )

db.users.find().hint( { $natural : 1 } )

db.users.find().hint( { $natural : -1 } )