MongoDB\Collection::estimatedDocumentCount()

定義

MongoDB\Collection::estimatedDocumentCount()

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

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

パラメーター

$options : 配列

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

名前	タイプ	説明
comment	混合	ユーザーが任意のコメントを指定して、 データベースプロファイラ、 currentOp出力、ログから操作を追跡できるようにします。 このオプションを使用するには、 MongoDB 6.0 以降に接続する必要があります。以前のバージョンに接続している場合、サーバーは実行時に例外を返します。 バージョン 1.13 の新機能。
maxTimeMS	integer	カーソルに対する情報処理操作の累積時間制限（ミリ秒単位）。 MongoDB は、次の割り込みポイントが最も近い時点で操作を中止します。
ReadConcern	MongoDB\Driver\ReadConcern	操作に使用する読み取り保証。 デフォルトはコレクションの読み取り保証 (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を有効にしてこのメソッドを使用する場合は、エラーの発生を回避するためにサーバーのバージョンをMongoDB 6.0 にアップグレードするか、厳密モードを無効にしてください。

その他の参照

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

• MongoDB\Collection::countDocuments()