La classe MongoCollection

(PECL mongo >=0.9.0)

Introduction

Représente une collection MongoDB.

Les noms de collections peuvent contenir n'importe quel caractère ASCII. Il est possible d'utiliser les noms de collections suivants : "", "...", "ma collection" et "*&#@".

Les noms de collections définies par l'utilisateur ne peuvent contenir le caractère $. Il y a certaines collections systèmes qui utilisent le caractère $ dans leurs noms (i.e., local.oplog.$main), mais c'est un caractère réservé. Si vous tentez de créer et d'utiliser une collection dont le nom contient un $, MongoDB échouera.

Synopsis de la classe

MongoCollection {

/* Constantes */

const int ASCENDING = 1 ;

const int DESCENDING = -1 ;

/* Champs */

public MongoDB $db = NULL ;

public integer $w ;

public integer $wtimeout ;

/* Méthodes */

public array aggregate ( array $pipeline [, array $options ] )

public MongoCommandCursor aggregateCursor ( array $command [, array $options ] )

public mixed batchInsert ( array $a [, array $options = array() ] )

public __construct ( MongoDB $db , string $name )

public int count ([ array $query = array() [, array $options = array() ]] )

public array createDBRef ( mixed $document_or_id )

public bool createIndex ( array $keys [, array $options = array() ] )

public array deleteIndex ( string|array $keys )

public array deleteIndexes ( void )

public array distinct ( string $key [, array $query ] )

public array drop ( void )

public bool ensureIndex ( string|array $key|keys [, array $options = array() ] )

public MongoCursor find ([ array $query = array() [, array $fields = array() ]] )

public array findAndModify ( array $query [, array $update [, array $fields [, array $options ]]] )

public array findOne ([ array $query = array() [, array $fields = array() [, array $options = array() ]]] )

public MongoCollection __get ( string $name )

public array getDBRef ( array $ref )

public array getIndexInfo ( void )

public string getName ( void )

public array getReadPreference ( void )

public bool getSlaveOkay ( void )

public array getWriteConcern ( void )

public array group ( mixed $keys , array $initial , MongoCode $reduce [, array $options = array() ] )

public bool|array insert ( array|object $document [, array $options = array() ] )

public array[MongoCommandCursor] parallelCollectionScan ( int $num_cursors )

public bool|array remove ([ array $criteria = array() [, array $options = array() ]] )

public mixed save ( array|object $document [, array $options = array() ] )

public bool setReadPreference ( string $read_preference [, array $tags ] )

public bool setSlaveOkay ([ bool $ok = TRUE ] )

public bool setWriteConcern ( mixed $w [, int $wtimeout ] )

static protected string toIndexString ( mixed $keys )

public string __toString ( void )

public bool|array update ( array $criteria , array $new_object [, array $options = array() ] )

public array validate ([ bool $scan_data = FALSE ] )

}

Constantes pré-définies

MongoCollection::ASCENDING
1: Classements et créations d'index dans l'ordre croissant.
MongoCollection::DESCENDING
-1: Classements et créations d'index dans l'ordre décroissant.

Champs

db: La base de données "parente" pour cette collection.
w: Le nombre de serveurs vers lesquels répliquer un changement avant de retourner un succès.La valeur est héritée de la base de données parente. La classe MongoDB possède plus de détails sur le fonctionnement de w.
wtimeout: Le nombre de millisecondes à attendre que les réplications $this->w se fassent. La valeur est héritée de la base de données parente. La classe MongoDB possède plus de détails sur le fonctionnement de wtimeout.

Voir aussi

Documentation de MongoDB » concernant les collections.

Sommaire

MongoCollection::aggregate — Effectue une agrégation en utilisant le framework dédié
MongoCollection::aggregateCursor — Exécute une commande d'agrégation, et récupère les résultats via un curseur
MongoCollection::batchInsert — Insère plusieurs documents dans la collection
MongoCollection::__construct — Crée une nouvelle collection
MongoCollection::count — Compte le nombre de documents de cette collection
MongoCollection::createDBRef — Crée une référence de base de données
MongoCollection::createIndex — Crée un index sur le ou les champs spécifiés s'il n'existe pas déjà
MongoCollection::deleteIndex — Supprime un index de la collection
MongoCollection::deleteIndexes — Supprime tous les index de cette collection
MongoCollection::distinct — Retourne une liste de valeurs distinctes d'une collection pour la clé donnée
MongoCollection::drop — Supprime cette collection
MongoCollection::ensureIndex — Crée un index sur le ou les champs spécifiés s'il n'existe pas déjà
MongoCollection::find — Interroge une collection, et retourne comme jeu de résultats un objet MongoCursor
MongoCollection::findAndModify — Met à jour un document et le retourne
MongoCollection::findOne — Interroge cette collection, retourne un seul élément
MongoCollection::__get — Récupère une collection
MongoCollection::getDBRef — Lit une référence de base de données
MongoCollection::getIndexInfo — Retourne des informations sur les indexes de cette collection
MongoCollection::getName — Retourne le nom de cette collection
MongoCollection::getReadPreference — Récupère les préférences de lecture pour cette collection
MongoCollection::getSlaveOkay — Récupère la configuration slaveOkay pour cette collection
MongoCollection::getWriteConcern — Récupère la préoccupation d'écriture de cette collection
MongoCollection::group — Effecture une opération de regroupement
MongoCollection::insert — Insère un document dans la collection
MongoCollection::parallelCollectionScan — Retourne un tableau de curseurs pour parcourir une collection complète en parallèle
MongoCollection::remove — Supprime un enregistrement d'une collection
MongoCollection::save — Sauvegarde un document dans une collection
MongoCollection::setReadPreference — Définit les préférences de lecture pour cette collection
MongoCollection::setSlaveOkay — Modifie la configuration de slaveOkay pour cette collection
MongoCollection::setWriteConcern — Défini la préoccupation d'écriture pour cette base de données
MongoCollection::toIndexString — Convertit les clés spécifiant un index en une chaîne de caractères
MongoCollection::__toString — Retourne la répresentation en chaîne de cette collection
MongoCollection::update — Modifie les enregistrements
MongoCollection::validate — Valide la collection