find

sort

任意。返される文書に含めるフィールドを決定するためのプロジェクション仕様。「プロジェクション」および「プロジェクション演算子」を参照してください。

ビューに対するfind()操作では、次のクエリ 演算子およびプロジェクション 演算子をサポートしていません。

• $

• $elemMatch

• $slice

• $meta

任意。インデックスの仕様。インデックス名を 文字列またはインデックス キー パターンを指定します。指定すると、クエリ システムはヒント指定したインデックスを使用するプランのみを考慮します。

次の例外を除き、コマンドに min フィールドや max フィールドが含まれている場合は、hint が必要です。hint は、filter が _id フィールドの等価条件（{ _id: <value> }）である場合、min や max では必要ありません。

任意。最初のバッチで返すドキュメントの数。デフォルトは 101 です。BatchSize が 0 の場合、カーソルは作成されますが、最初のバッチではドキュメントは返されません。

以前のワイヤプロトコル バージョンとは異なり、find コマンドの BatchSize が 1 の場合、カーソルは閉じられません。

任意。このコマンドに添付するユーザー指定のコメント。設定すると、このコメントは以下の場所にこのコマンドの記録と合わせて表示されます。

• attr.command.cursor.comment フィールド内のmongod ログ メッセージ。

• command.comment フィールドのデータベースプロファイラー出力。

• command.comment フィールドのcurrentOp出力。

コメントには、有効な BSON 型（string, integer, object, array など）を使用できます。

find コマンドに設定されたコメントは、find カーソルで実行される後続の getMore コマンドに継承されます。

任意。

時間制限をミリ秒単位で指定します。maxTimeMS の値を指定しない場合、操作はタイムアウトしません。値を 0 にすると、デフォルトの無制限動作を明示的に指定します。

MongoDB は、db.killOp() と同じメカニズムを使用して、割り当てられた時間制限を超えた操作を終了します。MongoDB は、指定された割り込みポイントのいずれかでのみ操作を終了します。

linearizable read concern を指定する場合、データを保持するノードの大部分が利用できない場合に備えて、常に maxTimeMS を使用します。maxTimeMS を指定すると、操作が無期限にブロックされることはなく、読み取り保証 (read concern) が満たされない場合は、代わりにエラーが返されます。

任意。読み取り保証 (read concern) を指定します。

readConcern オプションの構文は、次のとおりです。readConcern: { level: <value> }

次の読み取り保証レベルが利用できます。

• "local"。これは、プライマリとセカンダリに対する読み取り操作での、デフォルトの読み取り保証レベルです。

• "available" 。プライマリおよびセカンダリに対する読み取り操作に使用できます。"available" は、プライマリおよびシャーディングされていないセカンダリに対して "local" と同じように動作します。クエリは、インスタンスの最新データを返します。

• "majority" 。WiredTiger ストレージ エンジンを使用するレプリカセットで使用できます。

• "linearizable" 。primary の読み取り操作にのみ使用できます。

読み取り保証 (read concern) のレベルについて詳しくは、「読み取り保証 (read concern) レベル」を参照してください。

getMore コマンドは、元の find コマンドで指定された readConcern レベルを使用します。

任意。特定のインデックスの排他的上限。詳細については、「cursor.max()」を参照してください。

max フィールドを使用するには、指定した filter が _id フィールドの等価条件（{ _id: <value> }）でない限り、コマンドでも hint を使用する必要があります。

任意。特定のインデックスの包括的下限。詳細については、「cursor.min()」を参照してください。

min フィールドを使用するには、指定した filter が _id フィールドの等価条件（{ _id: <value> }）でない限り、コマンドでも hint を使用する必要があります。

任意。シャーディングされたコレクションに対するクエリで、クエリされたシャードが 1 つ以上使用できない場合に、コマンド（または後続の getMore コマンド）がエラーではなく部分的な結果を返します。

クエリされたシャードが使用できないために find コマンド（または後続の getMore コマンド）が部分的な結果を返す場合、find の出力には partialResultsReturned インジケーター フィールドが含まれます。クエリされたシャードが最初の find コマンドで使用できるが、後続の getMore コマンドで 1 つ以上のシャードが使用できなくなった場合、シャードが使用できないときに実行される getMore コマンドのみ、出力に partialResultsReturned が含まれます。

任意。

操作に使用する照合を指定します。

照合を指定すると、大文字・小文字やアクセント記号など、文字列を比較するための言語独自のルールを指定できます。

照合オプションの構文は次のとおりです。

collation: {
   locale: <string>,
   caseLevel: <boolean>,
   caseFirst: <string>,
   strength: <int>,
   numericOrdering: <boolean>,
   alternate: <string>,
   maxVariable: <string>,
   backwards: <boolean>
}

照合を指定する場合、locale フィールドは必須ですが、その他の照合フィールドはすべて任意です。フィールドの説明については、照合ドキュメントを参照してください。

照合が指定されていなくても、コレクションにデフォルトの照合が設定されている場合（db.createCollection() を参照）には、コレクションの照合が使用されます。

コレクションにも操作にも照合が指定されていない場合、MongoDB では以前のバージョンで使用されていた単純なバイナリ比較によって文字列が比較されます。

1 つの操作に複数の照合は指定できません。たとえば、フィールドごとに異なる照合を指定できません。また、ソートと検索を一度に実行する場合、検索とソートで別の照合を使用できません。

allowDiskUse

任意。

このオプションを使用して、特定のクエリの allowDiskUseByDefault をオーバーライドできます。このオプションは下記のいずれかに使用できます。

• デフォルトでディスクの使用が許可されているシステムで、ディスクの使用を禁止する。

• デフォルトでディスクの使用が禁止されているシステムで、ディスクの使用を許可する。

MongoDB 6.0 以降では、 allowDiskUseByDefault が true に設定されており、かつパイプライン実行ステージのために 100 MB を超えるメモリがサーバーに必要な場合、クエリで { allowDiskUse: false } が指定されていない限り、MongoDB では一時ファイルが自動的にディスクに書き込まれます。

詳細については、allowDiskUseByDefault を参照してください。

allowDiskUse は、MongoDB がインデックスを使用して指定された sort を満たすことができる場合、またはブロッキングソートに必要なメモリが 100 メガバイト未満の場合、効果がありません。

allowDiskUse の詳細なドキュメントについては、「cursor.allowDiskUse()」を参照してください。

大規模なブロッキングソートのメモリ制限の詳細については、「ソートとインデックスの使用」を参照してください。

任意。

変数のリストを含むドキュメントを指定します。これにより、変数をクエリテキストから分離することで、コマンドの読みやすさを向上させることができます。

ドキュメントの構文は次のとおりです。

{
  <variable_name_1>: <expression_1>,
  ...,
  <variable_name_n>: <expression_n>
}

変数は式によって返された値に設定され、その後は変更できません。

コマンド内の変数の値にアクセスするには、二重ドル記号の接頭辞（$$）を $$<variable_name> 形式にした変数名とともに使用します。たとえば次のとおりです。$$targetTotal

結果のフィルタリングに変数を使用するには、$expr 演算子内の変数にアクセスする必要があります。

let と変数を使用した完全な例については、「let における変数の使用」を参照してください。