mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
54cf5f9e3f
These methods now take an options array in 1.6+. Additionally, this fixes the description of getCollectionInfo(). https://jira.mongodb.org/browse/PHP-1318 git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335744 c90b9560-bf6c-de11-be94-00142212c4b1
160 lines
4 KiB
XML
160 lines
4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="mongodb.listcollections" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>MongoDB::listCollections</refname>
|
|
<refpurpose>Gets an array of MongoCollection objects for all collections in this database</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>array</type><methodname>MongoDB::listCollections</methodname>
|
|
<methodparam choice="opt"><type>array</type><parameter>options</parameter><initializer>array()</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Gets a list of all collections in the database and returns them as an array
|
|
of <classname>MongoCollection</classname> objects.
|
|
</para>
|
|
&mongo.listcollections.note;
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>
|
|
<parameter>options</parameter>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
An array of options for listing the collections. Currently available
|
|
options include:
|
|
<itemizedlist>
|
|
&mongo.listcollections.parameters.filter;
|
|
&mongo.listcollections.parameters.includesystemcollections;
|
|
</itemizedlist>
|
|
</para>
|
|
<para>
|
|
The following option may be used with MongoDB 2.8+:
|
|
<itemizedlist>
|
|
&mongo.command.parameters.maxtimems;
|
|
</itemizedlist>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns an array of MongoCollection objects.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="errors">
|
|
&reftitle.errors;
|
|
<para>
|
|
For MongoDB 2.6 and earlier, <classname>MongoException</classname> will be
|
|
thrown if a non-string value was specified for the
|
|
<literal>"filter"</literal> option's <literal>"name"</literal> criteria.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>1.6.0</entry>
|
|
<entry>
|
|
Changed first parameter to be an array of options. Pre-1.6.0, the
|
|
first parameter was a boolean indicating the
|
|
<literal>"includeSystemCollections"</literal> option.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>1.3.0</entry>
|
|
<entry>
|
|
Added the <parameter>includeSystemCollections</parameter> parameter.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title><function>MongoDB::listCollections</function> example</title>
|
|
<para>
|
|
The following example demonstrates running count on each collection in a database.
|
|
</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
$m = new MongoClient();
|
|
$db = $m->selectDB("demo");
|
|
$collections = $db->listCollections();
|
|
|
|
foreach ($collections as $collection) {
|
|
echo "amount of documents in $collection: ";
|
|
echo $collection->count(), "\n";
|
|
}
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
...
|
|
amount of documents in demo.pubs: 4
|
|
amount of documents in demo.elephpants: 3
|
|
amount of documents in demo.cities: 22840
|
|
...
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>MongoDB::getCollectionNames</function></member>
|
|
<member><function>MongoDB::getCollectionInfo</function></member>
|
|
</simplelist>
|
|
</para>
|
|
</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
|
|
-->
|