MongoDB\Collection::countDocuments()

定義

MongoDB\Collection::countDocuments()

フィルター条件に一致するドキュメントの数をカウントします。

function countDocuments(array|object $filter = [], array $options = []): integer

パラメーター

$filter : array|object

カウントするドキュメントを指定するフィルター条件。

$options : 配列

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

名前	タイプ	説明
collation	array|object	Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks. When specifying collation, the locale field is mandatory; all other collation fields are optional. For descriptions of the fields, see Collation Document. 照合が指定されていないが、コレクションにデフォルトの照合がある場合、操作はコレクションに指定された照合を使用します。 コレクションにも操作にも照合が指定されていない場合、MongoDB では以前のバージョンで使用されていた単純なバイナリ比較によって string が比較されます。
comment	混合	データベースプロファイラ、 currentOp出力、およびログから操作を追跡するのに役立つ任意のコメントを指定できるようにします。 コメントには、 MongoDB 4.4 以降の有効なBSONタイプであればどれでもかまいません。以前のサーバーバージョンでは string 値のみがサポートされていました。
hint	string|array|object	使用するインデックス。 インデックス名を string またはインデックス キー パターンをドキュメントとして指定します。 指定すると、クエリ システムはヒント指定したインデックスを使用するプランのみを考慮します。
limit	integer	返される一致するドキュメントの最大数。
maxTimeMS	integer	カーソルに対する情報処理操作の累積時間制限（ミリ秒単位）。MongoDB は、割り込みポイントの後の最も早く操作を中止します。
ReadConcern	MongoDB\Driver\ReadConcern	操作に使用する読み取り保証。 デフォルトはコレクションの読み取り保証 (read concern) です。 トランザクションの一部である個々の操作に対して読み取り保証 (read concern)を指定することはできません。代わりに、トランザクションを開始するときにreadConcern オプションを設定します。
readPreference	MongoDB\Driver\ReadPreference	操作に使用する読み取り設定。 コレクションの読み込み設定（read preference）がデフォルトで設定されます。
セッション	MongoDB\Driver\Session	操作に関連付けるクライアント セッション。
スキップ	integer	結果を返す前にスキップするマッチするドキュメントの数。

Return Values

フィルター条件に一致するドキュメントの数。

エラーと例外

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

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

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

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

動作

内部的には、このメソッドは結果を取得するために$group集計パイプライン演算子を使用します。 filterパラメーターが指定されている場合、これは$matchパイプライン演算子に変換されます。 任意の$skipステージと$limitステージは、オプションに存在する場合、 $matchとgroupの間に追加されます。

このメソッドでは集計パイプラインを使用するため、 MongoDB\Collection::count() filter内で受け入れられる一部のクエリ演算子は使用できません。 これらの制限された演算子に対する次の代替手段を検討してください。

When evaluating query criteria, MongoDB compares types and values according to its own comparison rules for BSON types, which differs from PHP's comparison and type juggling rules. When matching a special BSON type the query criteria should use the respective BSON class in the extension (e.g. use MongoDB\BSON\ObjectId to match an ObjectId).

その他の参照

• MongoDB\Collection::estimatedDocumentCount()