/ /

ドキュメントをカウント

Overview

このガイドでは、 MongoDB PHPライブラリを使用して、コレクション内のドキュメント数の正確な推定値を取得する方法を説明します。次のメソッドは、コレクション内のドキュメントをカウントします。

MongoDB\Collection::countDocuments():クエリフィルターに一致するドキュメント、またはコレクションに存在するドキュメントの正確な数を返します
MongoDB\Collection::estimatedDocumentCount():コレクション内のドキュメントの推定数を返します

サンプルデータ

このガイドの例では、 Atlasサンプルデータセットのsample_trainingデータベースのcompaniesコレクションを使用します。 PHPアプリケーションからこのコレクションにアクセスするには、Atlas クラスターに接続するMongoDB\Clientをインスタンス化し、次の値を$collection変数に割り当てます。

$collection = $client->sample_training->companies;

MongoDB配置を作成し、サンプルデータセットをロードする方法については、MongoDBの使用開始ガイドを参照してください。

正確なカウントの取得

コレクション内のドキュメントの数をカウントするには、 MongoDB\Collection::countDocuments()メソッドを使用します。特定の検索条件に一致するドキュメントの数をカウントするには、クエリフィルターをcountDocuments()メソッドに渡します。

クエリの指定の詳細については、「クエリの指定」ガイドを参照してください。

すべてのドキュメントをカウントする

コレクション内のすべてのドキュメントの数を返すには、次の例に示すように、空のクエリフィルター配列をcountDocuments()メソッドに渡します。

$result = $collection->countDocuments([]);
echo 'Number of documents: ', $result;

Number of documents: 9500

特定のドキュメントのカウント

特定の検索条件に一致するドキュメントの数を返すには、クエリフィルターをcountDocuments()メソッドに渡します。

次の例では、 founded_yearフィールドの値が2010であるドキュメントの数をカウントします。

$result = $collection->countDocuments(['founded_year' => 2010]);
echo 'Number of companies founded in 2010: ', $result;

Number of companies founded in 2010: 33

カウント動作をカスタマイズする

オプション値を指定する配列を渡すことで、 countDocuments()メソッドの動作を変更できます。次の表では、カウント操作をカスタマイズするために設定できるいくつかのオプションについて説明しています。

オプション	説明
`collation`	操作に使用する照合。詳細を学ぶには、このページの「照合」セクションを参照してください。タイプ: `array\|object`
`hint`	操作に使用するインデックス。タイプ: `string\|array\|object`
`comment`	操作に添付するコメント。タイプ: 有効な BSON タイプ
`limit`	カウントするドキュメントの最大数。この値は正の整数である必要があります。タイプ:`integer`
`maxTimeMS`	操作が実行できる最大時間 (ミリ秒)。タイプ: `integer`
`skip`	ドキュメントをカウントする前にスキップするドキュメントの数。タイプ: `integer`
`readPreference`	操作に使用する読み込み設定（read preference）。詳細については、サーバーマニュアルの読み込み設定（read preference）を参照してください。タイプ: `MongoDB\Driver\ReadPreference`

次の例では、 countDocuments()メソッドを使用して、 number_of_employeesフィールドの値が50であるドキュメントの数をカウントし、最大100の結果をカウントするように操作に指示します。

$result = $collection->countDocuments(
    ['number_of_employees' => 50],
    ['limit' => 100],
);
echo 'Number of companies with 50 employees: ', $result;

Number of companies with 50 employees: 100

照合

操作の照合を指定するには、collation オプションを設定する $options 配列パラメータを操作メソッドに渡します。照合ルールを構成する配列に collation オプションを割り当てます。

次の表では、照合を構成するために設定できるフィールドについて説明しています。

フィールド	説明
`locale`	（必須）Unicode 用の国際コンポーネント（ICU）ロケールを指定します。サポートされているロケールのリストについては、 MongoDB Serverマニュアルの「照合ロケールとデフォルトパラメーター」を参照してください。データ型:`string`
`caseLevel`	（任意）大文字と小文字の比較を含めるかどうかを指定します。 `true`に設定すると、比較動作はフィールドの値によって異なります。`strength` が`strength` `1`の場合、 PHPライブラリは基本文字と大文字と小文字を比較します。 - が`strength` `2`の場合、 PHPライブラリは基本文字、発音区別符号、その他のセカンダリレベルの相違、大文字と小文字を比較します。 -`strength` がその他の値の場合、このフィールドは無視されます。 `false`に設定されている場合、 PHPライブラリには強度レベル`1` または`2` での大文字と小文字の比較が含まれません。データ型:`bool` デフォルト:`false`
`caseFirst`	（任意）三次レベルの比較中に、大文字と小文字の相違のソート順序を指定します。データ型:`string` デフォルト:`"off"`
`strength`	（任意） ICU ドキュメントで定義されている比較のレベルを指定します。データ型:`int` デフォルト:`3`
`numericOrdering`	(任意) ドライバーが数字の文字列を数値として比較するかどうかを指定します。 `true` に設定すると、PHP ライブラリは数字の文字列を数値として比較します。例えば、文字列「10」と「2」を比較する場合、ライブラリは文字列の数値を使用し、「10」を「2」より大きいとして処理します。 `false`に設定すると、PHP ライブラリは数値型の文字列を文字列として比較します。例えば、文字列 "10" と "2" を比較する場合、ライブラリは 1 文字ずつ比較し、"10" を "2" より小さいとして取り扱います。詳細については、MongoDB Server マニュアルの「照合制限」を参照してください。データ型: `bool` デフォルト: `false`
`alternate`	(任意) ライブラリが空白と句読点を比較目的の基本文字として考慮するかどうかを指定します。データ型: `string` デフォルト: `"non-ignorable"`
`maxVariable`	（任意） `alternate"shifted"`フィールドがに設定されている場合にライブラリが無視可能と見なす文字を指定します。データ型:`string` デフォルト:`"punct"`
`backwards`	（任意）発音区別符号を含む string を、string の後ろから前にソートするかどうかを指定します。データ型:`bool` デフォルト:`false`

照合と各フィールドに可能な値の詳細については、 MongoDB Serverマニュアルの「照合」エントリを参照してください。

推定カウントの取得

MongoDB\Collection::estimatedDocumentCount()メソッドを呼び出すと、コレクション内のドキュメント数の推定値を取得できます。メソッドは、コレクションメタデータに基づいてドキュメントの量を推定します。これは、正確なカウントを実行するよりも高速である可能性があります。

次の例では、コレクション内のドキュメントの数を見積ります。

$result = $collection->estimatedDocumentCount();
echo 'Estimated number of documents: ', $result;

Estimated number of documents: 9500

推定カウント動作をカスタマイズ

オプション値を指定する配列をパラメーターとして渡すことで、 estimatedDocumentCount()メソッドの動作を変更できます。次の表では、配列に設定できるオプションについて説明しています。

オプション	説明
`comment`	操作に添付するコメント。タイプ: 有効な BSON タイプ
`maxTimeMS`	操作が実行できる最大時間 (ミリ秒)。タイプ: `integer`
`readConcern`	操作に使用する読み取り保証 (read concern)。詳細については、サーバーマニュアルの「読み取り保証 (read concern)」を参照してください。タイプ: `MongoDB\Driver\ReadConcern`
`readPreference`	操作に使用する読み込み設定（read preference）。詳細については、サーバーマニュアルの読み込み設定（read preference）を参照してください。タイプ: `MongoDB\Driver\ReadPreference`
`session`	操作に関連付けるクライアントセッション。タイプ: `MongoDB\Driver\Session`

次の例では、 estimatedDocumentCount()メソッドを使用してコレクション内のドキュメント数の推定値を返し、操作のタイムアウトを1000ミリ秒に設定します。

$result = $collection->estimatedDocumentCount(['maxTimeMS' => 1000]);
echo 'Estimated number of documents: ', $result;

Estimated number of documents: 9500

API ドキュメント

このガイドで説明したメソッドや型の詳細については、次の API ドキュメントを参照してください。

戻る

クエリを指定する

個別のフィールド値