The MongoCollection class

Introduction

Representations a database collection.

Collection names can use any character in the ASCII set. Some valid collection names are "", "...", "my collection", and "*&#@".

User-defined collection names cannot contain the $ symbol. There are certain system collections which use a $ in their names (e.g., local.oplog.$main), but it is a reserved character. If you attempt to create and use a collection with a $ in the name, MongoDB will assert.

Class synopsis

MongoCollection {

/* Constants */

const int MongoCollection::ASCENDING = 1 ;

const int MongoCollection::DESCENDING = -1 ;

/* Fields */

public MongoDB $db = NULL ;

public integer $w ;

public integer $wtimeout ;

/* Methods */

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

public __construct ( MongoDB $db , string $name )

public int count ([ array $query = array() [, int $limit = 0 [, int $skip = 0 ]]] )

public array createDBRef ( array $a )

public array deleteIndex ( string|array $keys )

public array deleteIndexes ( void )

public array drop ( void )

public boolean ensureIndex ( array $keys , array $options )

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

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

public MongoCollection __get ( string $name )

public array getDBRef ( array $ref )

public array getIndexInfo ( void )

public string getName ( void )

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

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

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

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

public string __toString ( void )

public boolean update ( array $criteria , array $newobj [, array $options = array() ] )

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

}

Predefined Constants

MongoCollection::ASCENDING
1

Ascending direction for sorts and index creation.

MongoCollection::DESCENDING
-1

Descending direction for sorts and index creation.

Fields

db

The "parent" database for this collection.

w

The number of servers to replicate a change to before returning success. Value is inherited from the parent database. The MongoDB class has a more detailed description of how w works.

wtimeout

The number of milliseconds to wait for $this->w replications to take place. Value is inherited from the parent database. The MongoDB class has a more detailed description of how wtimeout works.

See Also

MongoDB core docs on » collections.