MongoClient::listDBs

(PECL mongo >=1.3.0)

MongoClient::listDBs — Lists all of the databases available

このメソッドを定義している拡張モジュールは非推奨です。かわりに MongoDB 拡張モジュールを使うべきです。このメソッドの代替は、新しい拡張モジュールには存在しません。しかし、かわりに使える PHP ライブラリがあります。

» MongoDB\Client::listDatabases()

説明

public MongoClient::listDBs ( void ) : array

パラメータ

この関数にはパラメータはありません。

返り値

Returns an associative array containing three fields. The first field is databases, which in turn contains an array. Each element of the array is an associative array corresponding to a database, giving th database's name, size, and if it's empty. The other two fields are totalSize (in bytes) and ok, which is 1 if this method ran successfully.

例

例1 MongoClient::listDBs() example

Example demonstrating how to use listDBs and the returned data structure.


<?php

$mongo = new MongoClient();
$dbs = $mongo->listDBs();
print_r($dbs);

?>

上の例の出力は、たとえば以下のようになります。

Array
(
    [databases] => Array
        (
            [0] => Array
                (
                    [name] => doctrine
                    [sizeOnDisk] => 218103808
                    [empty] =>
                )
        )

    [totalSize] => 218103808
    [ok] => 1
)