<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Lists all of the databases available.</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongoclient.killcursor.html">MongoClient::killCursor</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongoclient.selectcollection.html">MongoClient::selectCollection</a></div>
<div class="up"><a href="class.mongoclient.html">MongoClient</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mongoclient.listdbs" class="refentry">
<div class="refnamediv">
<h1 class="refname">MongoClient::listDBs</h1>
<p class="verinfo">(PECL mongoclient >=1.0.4)</p><p class="refpurpose"><span class="refname">MongoClient::listDBs</span> — <span class="dc-title">Lists all of the databases available.</span></p>
</div>
<div class="refsect1 description" id="refsect1-mongoclient.listdbs-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><strong>MongoClient::listDBs</strong></span>
( <span class="methodparam">void</span>
)</div>
</div>
<div class="refsect1 parameters" id="refsect1-mongoclient.listdbs-parameters">
<h3 class="title">Parameters</h3>
<p class="para">This function has no parameters.</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-mongoclient.listdbs-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an associative array containing three fields. The first field is
<em>databases</em>, 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
<em>totalSize</em> (in bytes) and <em>ok</em>, which is 1
if this method ran successfully.
</p>
</div>
<div class="refsect1 examples" id="refsect1-mongoclient.listdbs-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-1406">
<p><strong>Example #1 <span class="methodname"><strong>MongoClient::listDBs()</strong></span> example</strong></p>
<div class="example-contents"><p>
Example demonstrating how to use listDBs and the returned data structure.
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$mongo </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoClient</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$dbs </span><span style="color: #007700">= </span><span style="color: #0000BB">$mongo</span><span style="color: #007700">-></span><span style="color: #0000BB">listDBs</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$dbs</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
Array
(
[databases] => Array
(
[0] => Array
(
[name] => doctrine
[sizeOnDisk] => 218103808
[empty] =>
)
)
[totalSize] => 218103808
[ok] => 1
)
</pre></div>
</div>
</div>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongoclient.killcursor.html">MongoClient::killCursor</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongoclient.selectcollection.html">MongoClient::selectCollection</a></div>
<div class="up"><a href="class.mongoclient.html">MongoClient</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
