MongoDB\Client::listDatabases()

定義

MongoDB\Client::listDatabases()

サーバー上のすべてのデータベースの情報を返します。

function listDatabases(array $options = []): MongoDB\Model\DatabaseInfoIterator

パラメーター

$options : 配列

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

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

Return Values

MongoDB\Model\DatabaseInfoIteratorMongoDB\Model\DatabaseInfoサーバー上の各データベースの オブジェクトを含むトラバース可能な 。

エラーと例外

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

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

MongoDB\Driver\Exception\RuntimeException 拡張レベルのその他のエラー（例:）。

例

次の例では、 サーバー上の すべてのデータベースを一覧表示します。

<?php
$client = new MongoDB\Client;
foreach ($client->listDatabases() as $databaseInfo) {
    var_dump($databaseInfo);
}

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

object(MongoDB\Model\DatabaseInfo)#4 (3) {
  ["name"]=>
  string(5) "local"
  ["sizeOnDisk"]=>
  float(65536)
  ["empty"]=>
  bool(false)
}
object(MongoDB\Model\DatabaseInfo)#7 (3) {
  ["name"]=>
  string(4) "test"
  ["sizeOnDisk"]=>
  float(32768)
  ["empty"]=>
  bool(false)
}

その他の参照

• MongoDB\Client::listDatabaseNames()

• MongoDB マニュアルのlistDatabasesコマンドに関する参考資料

• データベースの列挙 仕様