Overview
このガイドでは、 MongoDB PHPライブラリを使用して、コレクション内のドキュメント数の正確な推定値を取得する方法を説明します。 次のメソッドは、コレクション内のドキュメントをカウントします。
MongoDB\Collection::countDocuments():クエリフィルターに一致するドキュメント、またはコレクションに存在するドキュメントの正確な数を返しますMongoDB\Collection::estimatedDocumentCount():コレクション内のドキュメントの推定数を返します
サンプル データ
The examples in this guide use the companies collection in the sample_training database from the Atlas sample datasets. To access this collection from your PHP application, instantiate a MongoDB\Client that connects to an Atlas cluster and assign the following value to your $collection variable:
$collection = $client->sample_training->companies;
無料の MongoDB 配置を作成し、サンプルデータセットを読み込む方法については、MongoDB の スタートガイドを参照してください。
正確なカウントの取得
コレクション内のドキュメントの数をカウントするには、 MongoDB\Collection::countDocuments()メソッドを使用します。 特定の検索条件に一致するドキュメントの数をカウントするには、クエリフィルターをcountDocuments()メソッドに渡します。
クエリの指定の詳細については、「 クエリの指定 」ガイドを参照してください。
すべてのドキュメントをカウントする
コレクション内のすべてのドキュメントの数を返すには、次の例に示すように、空のクエリフィルター配列をcountDocuments()メソッドに渡します。
$result = $collection->countDocuments([]); echo 'Number of documents: ', $result;
特定のドキュメントのカウント
特定の検索条件に一致するドキュメントの数を返すには、クエリフィルターをcountDocuments()メソッドに渡します。
次の例では、 founded_yearフィールドの値が2010であるドキュメントの数をカウントします。
$result = $collection->countDocuments(['founded_year' => 2010]); echo 'Number of companies founded in 2010: ', $result;
カウント動作をカスタマイズする
オプション値を指定する配列を渡すことで、 countDocuments()メソッドの動作を変更できます。 次の表では、カウント操作をカスタマイズするために設定できるいくつかのオプションについて説明しています。
オプション | 説明 |
|---|---|
| |
| 操作に使用するインデックス。 |
| 操作に添付するコメント。 |
| カウントするドキュメントの最大数。この値は正の整数である必要があります。 |
| 操作が実行できる最大時間 (ミリ秒)。 |
| ドキュメントをカウントする前にスキップするドキュメントの数。 |
| 操作に使用する読み込み設定 (read preference)です。詳細については、サーバー マニュアルの「 読み込み設定 |
次の例では、 countDocuments()メソッドを使用して、 number_of_employeesフィールドの値が50であるドキュメントの数をカウントし、最大100の結果をカウントするように操作に指示します。
$result = $collection->countDocuments( ['number_of_employees' => 50], ['limit' => 100], ); echo 'Number of companies with 50 employees: ', $result;
照合
操作の 照合 を指定するには、collation オプションを設定する $options 配列パラメータを操作メソッドに渡します。照合ルールを構成する配列に collation オプションを割り当てます。
次の表では、照合を構成するために設定できるフィールドについて説明しています。
フィールド | 説明 |
|---|---|
| (Required) Specifies the International Components for Unicode (ICU) locale. For a list of supported locales, see Collation Locales and Default Parameters in the MongoDB Server manual. |
| (任意) 大文字と小文字の比較を含めるかどうかを指定します。 |
| (任意) 三次レベルの比較中の大文字と小文字の相違のソート順序を指定します。 |
| (Optional) Specifies the level of comparison to perform, as defined in the ICU documentation. |
| （任意）ドライバーが数字の string を数値として比較するかどうかを指定します。 |
| (任意) ライブラリが空白と句読点を比較目的の基本文字として考慮するかどうかを指定します。 |
| (任意) |
| (任意) 発音区別符号を含む string を、string の後ろから前にソートするかどうかを指定します。 |
照合と各フィールドに可能な値の詳細については、 MongoDB Serverマニュアルの「 照合 」エントリを参照してください。
推定カウントの取得
MongoDB\Collection::estimatedDocumentCount()メソッドを呼び出すと、コレクション内のドキュメント数の推定値を取得できます。 メソッドは、コレクションメタデータに基づいてドキュメントの量を推定します。これは、正確なカウントを実行するよりも高速である可能性があります。
次の例では、 コレクション内のドキュメントの数を見積ります。
$result = $collection->estimatedDocumentCount(); echo 'Estimated number of documents: ', $result;
推定カウント動作をカスタマイズ
オプション値を指定する配列をパラメーターとして渡すことで、 estimatedDocumentCount()メソッドの動作を変更できます。 次の表では、 配列に設定できるオプションについて説明しています。
オプション | 説明 |
|---|---|
| 操作に添付するコメント。 |
| 操作が実行できる最大時間 (ミリ秒)。 |
| 操作に使用する読み取り保証 (read concern)です。詳細については、サーバー マニュアルの「 読み取り保証 |
| 操作に使用する読み込み設定 (read preference)です。詳細については、サーバー マニュアルの「 読み込み設定 |
| 操作に関連付けるクライアントセッション。 |
次の例では、 estimatedDocumentCount()メソッドを使用してコレクション内のドキュメント数の推定値を返し、操作のタイムアウトを1000ミリ秒に設定します。
$result = $collection->estimatedDocumentCount(['maxTimeMS' => 1000]); echo 'Estimated number of documents: ', $result;
API ドキュメント
このガイドで説明したメソッドや型の詳細については、次の API ドキュメントを参照してください。