La clase MongoCollection

(PECL mongo >=0.9.0)

Introducción

Representa una colección de MongoDB.

Los nombres de colecciones pueden usar cualquier carácter del código ASCII. Algunos ejemplos de nombres válidos de colecciones son "", "...", "mi coleccion", y "*&#@".

Los nombres de colecciones definidos por el usuario no pueden contener el símbolo $. Existen colecciones del sistema que utilizan $ en sus nombres (p.ej., local.oplog.$main), pero es un carácter reservado. Si se intentara crear y usar una colección que incluya $ en su nombre, MongoDB lo notificará.

Sinopsis de la Clase

MongoCollection {

/* Constantes */

const int ASCENDING = 1 ;

const int DESCENDING = -1 ;

/* Campos */

public MongoDB $db = NULL ;

public integer $w ;

public integer $wtimeout ;

/* Métodos */

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

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

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

public __construct ( MongoDB $db , string $name )

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

public createDBRef ( mixed $document_or_id ) : array

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

public deleteIndex ( string|array $keys ) : array

public deleteIndexes ( void ) : array

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

public drop ( void ) : array

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

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

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

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

public __get ( string $name ) : MongoCollection

public getDBRef ( array $ref ) : array

public getIndexInfo ( void ) : array

public getName ( void ) : string

public getReadPreference ( void ) : array

public getSlaveOkay ( void ) : bool

public getWriteConcern ( void ) : array

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

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

public parallelCollectionScan ( int $num_cursors ) : array[MongoCommandCursor]

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

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

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

public setSlaveOkay ([ bool $ok = true ] ) : bool

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

static protected toIndexString ( mixed $keys ) : string

public __toString ( void ) : string

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

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

}

Constantes predefinidas

MongoCollection::ASCENDING
1: Sentido ascendente para ordenaciones y creaciones de índices.
MongoCollection::DESCENDING
-1: Sentido descendente para ordenaciones y creaciones de índices.

Campos

db: La base de datos "madre" de esta colección.
w: Número de servidores a los que replicar un cambio antes de confirmar el éxito. Este valor se hereda de la base de datos madre. La clase MongoDB indica de forma más detallada cómo funciona w.
wtimeout: El número de milisegundos a esperar a que las operaciones se realicen en las réplicas de $this->w. Este valor se hereda de la base de datos madre. La clase MongoDB indica de forma más detallada cómo funciona wtimeout.

Ver también

Documentación de MongoDB sobre » collections.

Tabla de contenidos

MongoCollection::aggregate — Realiza una acumulación usando el framework de acumulación
MongoCollection::aggregateCursor — Ejecutar un comando de tubería acumulador y recuperar los resultados mediante un cursor
MongoCollection::batchInsert — Inserta múltiples documentos en esta colección
MongoCollection::__construct — Crea una nueva colección
MongoCollection::count — Cuenta el número de documentos de esta colección
MongoCollection::createDBRef — Crea una referencia a una base de datos
MongoCollection::createIndex — Crea un índice en el campo o campos especificados, si aún no existen
MongoCollection::deleteIndex — Elimina un índice de esta colección
MongoCollection::deleteIndexes — Elimina todos los índices de esta colección
MongoCollection::distinct — Recupera una lista de valores distintos para una clave dada a través de una colección
MongoCollection::drop — Borra esta colección
MongoCollection::ensureIndex — Crea un índice en el campo o campos especificados, si aún no existen
MongoCollection::find — Consulta esta colección, devolviendo un objeto MongoCursor para el conjunto de resultados
MongoCollection::findAndModify — Actualizar un documento y devolverlo
MongoCollection::findOne — Realiza una consulta a esta colección, devolviendo sólo un elemento
MongoCollection::__get — Obtiene una colección
MongoCollection::getDBRef — Captura el documento al que apunta una referencia de base de datos
MongoCollection::getIndexInfo — Devuelve información sobre los índices de esta colección
MongoCollection::getName — Devuelve el nombre de esta colección
MongoCollection::getReadPreference — Obtener la preferencia de lectura psrs esta colección
MongoCollection::getSlaveOkay — Consulta el valor de slaveOkay de esta colección
MongoCollection::getWriteConcern — Obtener el asunto de escritura para esta colección
MongoCollection::group — Lleva a cabo una operación similar al comando GROUP BY de SQL
MongoCollection::insert — Inserta un documento en la colección
MongoCollection::parallelCollectionScan — Devuelve un array con cursores para recorrer una colección completa en paralelo
MongoCollection::remove — Eliminar registros de esta colección
MongoCollection::save — Guarda un documento en esta colección
MongoCollection::setReadPreference — Establecer la preferencia de lectura para esta colección
MongoCollection::setSlaveOkay — Cambia el valor de slaveOkay de esta colección
MongoCollection::setWriteConcern — Establecer el asunto de escritura para esta base de datos
MongoCollection::toIndexString — Convierte claves especificando un índice para su string de identificación
MongoCollection::__toString — Representación en forma de string de esta colección
MongoCollection::update — Actualizar registros basándose en los criterios proporcionados
MongoCollection::validate — Valida esta colección

add a note

User Contributed Notes

There are no user contributed notes for this page.