MongoDB\Database::listCollectionNames()

定義

MongoDB\Database::listCollectionNames()

このデータベース内のすべてのコレクションの名前を返します。

function listCollectionNames(array $options = []): Iterator

パラメーター

$options : 配列

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

名前	タイプ	説明
authorizedCollections	ブール値	アクセス制御を可能にする場合に特権に基づいて返されるコレクションを決定するフラグ。 詳しくは、 listCollectionsコマンドのドキュメント を参照してください。 1.12バージョン の新機能。:
comment	混合	データベースプロファイラ、 currentOp出力、およびログから操作を追跡するのに役立つ任意のコメントを指定できるようにします。 このオプションは MongoDB 4.4 以降で使用可能であり、古いサーバー バージョンで指定すると実行時に例外が発生します。 1.13バージョン の新機能。:
フィルター	array|object	コレクションの一覧をフィルター処理するクエリ式です。 コレクション フィールドにクエリ式を指定できます（例: name 、 options ）。
maxTimeMS	integer	カーソルに対する情報処理操作の累積時間制限（ミリ秒単位）。 MongoDB は、次の割り込みポイントが最も近い時点で操作を中止します。
セッション	MongoDB\Driver\Session	操作に関連付けるクライアント セッション。

Return Values

データベース内の各コレクションの名前を提供する イテレータ 。

例

次の例では、 testデータベース内のすべてのコレクションを一覧表示します。

<?php
$database = (new MongoDB\Client)->test;
foreach ($database->listCollectionNames() as $collectionName) {
    var_dump($collectionName);
}

出力は次のようになります。

string(11) "restaurants"
string(5) "users"
string(6) "restos"

次の例では、 testデータベース内の名前が"rest"で始まるすべてのコレクションを一覧表示します。

<?php
$database = (new MongoDB\Client)->test;
$collections = $database->listCollectionNames([
    'filter' => [
        'name' => new MongoDB\BSON\Regex('^rest.*'),
    ],
]);
foreach ($collections as $collectionName) {
    var_dump($collectionName);
}

出力は次のようになります。

string(11) "restaurants"
string(6) "restos"

その他の参照

• MongoDB\Database::listCollections()

• MongoDB マニュアルのlistCollectionsコマンド参照

• コレクションの列挙の仕様