MongoDB::getCollectionInfo
(PECL mongo >=1.6.0)
MongoDB::getCollectionInfo — Devuelve información sobre las colecciones de esta base de datos
Descripción
$options = array()
] ) : arrayObtiene una lista de todas las colecciones de la base de datos y las devuelve como un array de documentos, los cuales contienen sus nombres y opcioines.
Nota: Este método empleará el comando de bases de datos » listCollections al comunicarse con MongoDB 2.8+. Para versiones de bases de datos anteriores, el método consultará la colección especial system.namespaces.
Parámetros
-
options -
Un array de opciones para enumerar las colecciones. Las opciones actualmente disponibles son:
"filter"
Criterios de consulta opcionales. Si se proporcionan, estos criterios se emplearán para filtrar las colecciones incluidas en el resultado.
Los campoa relevantes que podrían ser requeridos incluyen "name" (el nombre de la colección como string, sin el prefijo del nombre de la base de datos) y "options" (un objeto que contiene opciones empleadas para crear la colección)..
Nota: MongoDB 2.6 y anteriores requieren que los criterios "name", si se especifican, sean un valor de tipo string (esto es, coincidencia de igualdad). Esto es así debido a que el controlador debe prefijar el valor con el nombre de la base de datos para poder consultar la colección system.namespaces. Las versiones posteriores de MongoDB no tienen esta limitación, ya que el controlador emplea el comando listCollections.
"includeSystemCollections"
Booleano, predeterminado a
FALSE. Determina si las colecciones del sistema deberían ser incluidas en el resultado.
La siguiente opción se puede utilizar con MongoDB 2.8+:
"maxTimeMS"
Especifica un tiempo límite acumulativo en milisegundos para procesar la operación en el servdiro (no incluye el tiempo improductivo). Si la operación no la completa el servidor dentro del período de tiempo límite, se lanzará una MongoExecutionTimeoutException.
Valores devueltos
Esta función devuelve un array donde cada elemento es un array que describe una colección. Los elementos contendrán una clave name denotando el nombre de la colección, y opcionalmente una clave options denotando un array de objetos los empleados para crear la colección. Por ejemplo, las colecciones limitadas incluirán las opciones capped y size.
Errores/Excepciones
En MongoDB 2.6 y anteriores, se lanzará una MongoException si se especifica un valor distinto de un string para el criterio "name" de la opción "filter".
Ejemplos
Ejemplo #1 Ejemplo de MongoDB::getCollectionInfo()
<?php
$m = new MongoClient();
$db = $m->selectDB("demo");
var_dump($db->getCollectionInfo());
?>
El resultado del ejemplo sería algo similar a:
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)
}
}
}
Ver también
- MongoDB::getCollectionNames() - Obtiene un array con los nombres de todas las colecciones de esta base de datos
- MongoDB::listCollections() - Obtiene un array de objetos MongoCollection para todas las colecciones de esta base de datos
add a note
