mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 06:18:56 +00:00
a3fe103a4d
https://jira.mongodb.org/browse/PHP-544 git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@328426 c90b9560-bf6c-de11-be94-00142212c4b1
95 lines
2.3 KiB
XML
95 lines
2.3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="mongoclient.listdbs" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>MongoClient::listDBs</refname>
|
|
<refpurpose>Lists all of the databases available.</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>array</type><methodname>MongoClient::listDBs</methodname>
|
|
<void/>
|
|
</methodsynopsis>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
&no.function.parameters;
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns an associative array containing three fields. The first field is
|
|
<literal>databases</literal>, 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
|
|
<literal>totalSize</literal> (in bytes) and <literal>ok</literal>, which is 1
|
|
if this method ran successfully.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title><methodname>MongoClient::listDBs</methodname> example</title>
|
|
<para>
|
|
Example demonstrating how to use listDBs and the returned data structure.
|
|
</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
$mongo = new MongoClient();
|
|
$dbs = $mongo->listDBs();
|
|
print_r($dbs);
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
Array
|
|
(
|
|
[databases] => Array
|
|
(
|
|
[0] => Array
|
|
(
|
|
[name] => doctrine
|
|
[sizeOnDisk] => 218103808
|
|
[empty] =>
|
|
)
|
|
)
|
|
|
|
[totalSize] => 218103808
|
|
[ok] => 1
|
|
)
|
|
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</refsect1>
|
|
</refentry>
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|