MongoDB
PHP Manual

MongoDB::getCollectionInfo

(PECL mongo >=1.6.0)

MongoDB::getCollectionInfoReturns information about collections in this database

Description

public array MongoDB::getCollectionInfo ([ array $options = array() ] )

Gets a list of all collections in the database and returns them as an array of documents, which contain their names and options.

Note: Cette méthode va utiliser la commande de base de données » listCollections lors des communications avec MongoDB 2.8+. Pour les versions précédentes, la méthode va interroger la collection spéciale system.namespaces.

Liste de paramètres

options

An array of options for listing the collections. Currently available options include:

  • "filter"

    Critère de requête optionnel. Si fourni, ce critère sera utilisé pour filtrer les collections inclues dans le résultat.

    Les champs pertinents qui peuvent être requêtés inclus "name" (nom de la collection comme chaine de caractères, sans préfixer par le nom de la base de données) et "options" (objet contenant les options utilisées pour créér la collection)..

    Note: MongoDB 2.6 et les versions antérieures requierent que le critère "name", si spécifié, soit une chaine de caractère (i.e. correspondance exacte). Ceci, car le driver doit préfixer la valeur avec le nom de la base de données afin de requêter la collection system.namespaces. Les versions suivantes de MongoDB n'ont pas cette limitation, comme le driver va utiliser la commande listCollections.

  • "includeSystemCollections"

    Booléen, par défaut FALSE. Détermine si les collections systèmes doivent être incluses dans le résultat.

The following option may be used with MongoDB 2.8+:

  • "maxTimeMS"

    Spécifie une limite cumulative de temps, en millisecondes, pour procéder à l'opération (n'inclut pas le temps d'inactivité). Si l'opération n'est pas terminée durant cette période, une exception MongoExecutionTimeoutException sera émise.

Valeurs de retour

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.

Erreurs / Exceptions

For MongoDB 2.6 and earlier, MongoException will be thrown if a non-string value was specified for the "filter" option's "name" criteria.

Exemples

Exemple #1 MongoDB::getCollectionInfo() example

<?php
$m 
= new MongoClient();
$db $m->selectDB("demo");
var_dump($db->getCollectionInfo());
?>

L'exemple ci-dessus va afficher quelque chose de similaire à :

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)
    }
  }
}

Voir aussi


MongoDB
PHP Manual