MongoDB\Collection::estimatedDocumentCount()

定義

MongoDB\Collection::estimatedDocumentCount()

コレクションのメタデータを使用して、コレクション内のドキュメントの推定数を取得します

function countDocuments(array $options = []): integer

パラメーター

$options : 配列

必要なオプションを指定する配列。

名前	タイプ	説明
comment	混合	データベースプロファイラ、 currentOp出力、およびログから操作を追跡するのに役立つ任意のコメントを指定できるようにします。 このオプションは MongoDB 4.4 以降で使用可能であり、古いサーバー バージョンで指定すると実行時に例外が発生します。 1.13バージョン の新機能。:
maxTimeMS	integer	カーソルに対する情報処理操作の累積時間制限（ミリ秒単位）。 MongoDB は、次の割り込みポイントが最も近い時点で操作を中止します。
ReadConcern	MongoDB\Driver\ReadConcern	操作に使用する読み取り保証。 デフォルトはコレクションの読み取り保証 (read concern) です。 トランザクションの一部である個々の操作に対して読み取り保証 (read concern)を指定することはできません。代わりに、トランザクションを開始するときにreadConcern オプションを設定します。
readPreference	MongoDB\Driver\ReadPreference	操作に使用する読み取り設定。 コレクションの読み込み設定（read preference）がデフォルトで設定されます。
セッション	MongoDB\Driver\Session	操作に関連付けるクライアント セッション。

Return Values

コレクション内のドキュメントの推定数。

エラーと例外

MongoDB\Exception\UnexpectedValueException サーバーからのコマンド応答が不正な形式であった場合、。

MongoDB\Exception\UnsupportedExceptionオプションが使用され、選択したサーバーでサポートされていない場合（例: collation 、 readConcern 、 writeConcern ）。

MongoDB\Exception\InvalidArgumentException は、パラメータまたはオプションの解析に関連するエラーの場合は です。

MongoDB$Driver\Exception\RuntimeException は、拡張レベルの他のエラーの場合（例:）。

動作

このメソッドは、ドキュメントをカウントしたりインデックスをコンサルティングしたりするのではなく、コレクション メタデータを使用してコレクション内のドキュメントの数の推定値を返します。 このメソッドはsessionオプションを取らないため、トランザクション内で実行することはできません。 詳細については、MongoDB マニュアルの「 Count: 動作」を参照してください。

このメソッドは count コマンドを使用して実装されています。count コマンドは、 Stable APIのバージョン "1" には含まれていません。このメソッドを Stable APIで使用している場合は、エラーが発生しないようにサーバーバージョンを 5.0.9 以上にアップグレードするか、厳密モードを無効にすることをお勧めします。

その他の参照

• カウントコマンドの参照（MongoDB マニュアル）

• MongoDB\Collection::countDocuments()