find（データベースコマンド）

find

string

クエリするコレクションまたはビューの名前。

filter

ドキュメント

任意.クエリ述語。指定しない場合、コレクション内のすべてのドキュメントが述語と一致します。

sort

ドキュメント

任意。結果の順序の並び替え指定。

projection

ドキュメント

任意。返される文書に含めるフィールドを決定するためのプロジェクション仕様。

find()ビューに対する 操作では、次の検索コマンドプロジェクション演算子をサポートしていません。

• $

• $elemMatch

• $slice

• $meta

hint

文字列またはドキュメント

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

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

skip

正の整数

任意。スキップするドキュメントの数。デフォルトは 0 です。

limit

non-negative integer

任意。返されるドキュメントの最大数。指定しない場合、デフォルトは制限なしになります。limit の値が 0 の場合、制限を設定しない場合と同等です。

batchSize

non-negative integer

任意。クエリ結果の各バッチで返されることができるドキュメントの最大数。デフォルトでは、find コマンドの初期 batchSize は、101 件のドキュメントまたは 16 メビバイト（MiB）相当のドキュメントのうち、少ない方となります。以降のバッチの最大サイズは 16 MiB です。このオプションは、16 MiB より小さい制限を強制することはできますが、それを超える制限を設定することはできません。設定されている場合、batchSize は batchSize 件のドキュメントまたは 16 MiB 相当のドキュメントのうち、少ない方になります。

batchSize が 0 の場合、カーソルが確立されているものの最初のバッチで返されるドキュメントはないことを表します。

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

後続の getMore 操作のバッチ サイズを指定するには、mongosh で batchSize() を使用します。

singleBatch

ブール値

任意。最初のバッチするの後にカーソルを閉じるかどうかを決定します。デフォルトは false です。

comment

any

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

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

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

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

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

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

maxTimeMS

non-negative integer

任意。

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

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

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

maxTimeMS() は noCursorTimeout() とは無関係です。maxTimeMS() はプロセシング時間を制限しますが、noCursorTimeout() はアイドル時間による期限切れを防ぎます。カーソルのアイドル時間は、そのプロセシング時間には寄与しません。

readConcern

ドキュメント

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

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

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

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

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

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

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

• "snapshot"。マルチドキュメントトランザクションおよびマルチドキュメントトランザクション以外の特定の読み取り操作で利用可能です。

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

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

max

ドキュメント

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

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

min

ドキュメント

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

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

returnKey

ブール値

任意。trueの場合、結果のドキュメントに含まれるインデックス キーのみを返します。デフォルトは false です。returnKey が true で、find コマンドがインデックスを使用しない場合、返されるドキュメントは空になります。

showRecordId

ブール値

任意。各ドキュメントのレコード識別子を返すかどうかを決定します。true の場合、返されるドキュメントにフィールド $recordId が追加されます。

tailable

ブール値

任意。上限付きコレクションの追尾可能 (tailable) カーソルを返します。

awaitData

ブール値

任意.追尾可能オプションと組み合わせて使用すると、データを返さずに、データの終端でカーソル上の getMore コマンドを一時的にブロックできます。タイムアウト期間が経過すると、find は通常通りにデータを返します。

noCursorTimeout

ブール値

任意。30 分間の非アクティブ期間後に、サーバーが非セッション アイドル カーソルをタイムアウトしないようにします。セッションの一部であるカーソルに対しては無視されます。詳細については、「セッションのアイドル タイムアウト」を参照してください。

allowPartialResults

ブール値

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

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

collation

ドキュメント

任意。

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

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

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

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()」を参照してください。

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

let

ドキュメント

任意。

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

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

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

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

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

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

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

querySettings

ドキュメント

任意。このコマンドの実行にのみ適用されるクエリ設定。querySettingsドキュメントは、次のフィールドを受け入れます。

• indexHints

• queryFramework

• reject

• comment

• queryKnobs

• maxTimeMS

これらのフィールドの説明については、コマンドフィールドを参照してください。

MongoDB は、これらの設定をクラスター上に保存しません。また、同じクエリシェイプを持つ他のクエリには適用されません。クエリシェイプに対して持続するクエリ設定を設定するには、setQuerySettings. を使用します。

MongoDBは、コマンドで渡された設定と、同じクエリシェイプに対してクラスターに保存されているクエリ設定を組み合わせます。両方の設定で同じフィールドが指定されている場合、保存されているクラスター設定が優先されます。