MongoDB::getCollectionInfo
(PECL mongo >=1.6.0)
MongoDB::getCollectionInfo — Returns information about collections in this database
Descrierea
$options = array()
) : arrayGets a list of all collections in the database and returns them as an array of documents, which contain their names and options.
Notă: Această metodă va utiliza comanda bazei de date » listCollections la comunicarea cu MongoDB 2.8+. Pentru versiunile anterioare ale bazei de date, metoda va interpela colecția specială
system.namespaces.
Parametri
-
options -
An array of options for listing the collections. Currently available options include:
-
"filter"Criteriu opțional pentru interpelare. Dacă este furnizat, acest criteriu va fi utilizat pentru a filtra colecțile incluse în rezultat.
Câmpurile relevante, ce pot fi interpelate, includ
"name"(colecția name ca șir de caractere, fără prefixul cu denumirea bazei de date) și"options" (obiect ce conține opțiuni utilizate la crearea colecției)..Notă: MongoDB 2.6 și versiunile anterioare necesită ca criteriul
"name", dacă este specificat, să fie o valoare string (de ex. potrivirea la egalitate). Aceasta este din cauza că driver-ul trebuie să adauge ca prefix la valoare denumirea bazei de date pentru a interpela colecțiasystem.namespaces. Versiunile ulterioare ale MongoDB nu au această limitare, deoarece driver-ul va utiliza comanda listCollections. -
"includeSystemCollections"Boolean, implicit este
false. Determină dacă colecțiile de sistem trebuie incluse în rezultat.
The following option may be used with MongoDB 2.8+:
-
"maxTimeMS"Specifică o limită de timp cumulativă în milisecunde pentru procesarea operațiunii pe server (nu include timpul de așteptare). Dacă operațiunea nu este terminată pe server în timpul rezervat, va fi emisă o MongoExecutionTimeoutException.
-
Valorile întoarse
This function returns an array where each element is an array describing a
collection. Elements will contain a name key denoting the
name of the collection, and optionally contain an options
key denoting an array of objects used to create the collection. For example,
capped collections will include capped and
size options.
Erori/Excepții
For MongoDB 2.6 and earlier, MongoException will be
thrown if a non-string value was specified for the
"filter" option's "name" criteria.
Exemple
Example #1 MongoDB::getCollectionInfo() example
<?php
$m = new MongoClient();
$db = $m->selectDB("demo");
var_dump($db->getCollectionInfo());
?>
Exemplul de mai sus va afișa ceva similar cu:
array(2) {
[0]=>
array(2) {
["name"]=>
string(4) "logs"
["options"]=>
array(2) {
["capped"]=>
bool(true)
["size"]=>
int(10240)
}
}
[1]=>
array(2) {
["name"]=>
string(5) "users"
["options"]=>
array(1) {
["flags"]=>
int(1)
}
}
}
A se vedea și
- MongoDB::getCollectionNames() - Gets an array of names for all collections in this database
- MongoDB::listCollections() - Gets an array of MongoCollection objects for all collections in this database
add a note
