The MongoCollection class
(PECL mongo >=0.9.0)
Introduction
Represents a MongoDB 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
$query
[, array $update
[, array $fields
[, array $options
]]] ) : array$query = array()
[, array $fields = array()
[, array $options = array()
]]] ) : arrayPredefined Constants
MongoCollection::ASCENDING- Ascending direction for sorts and index creation.
MongoCollection::DESCENDING- 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.
Table of Contents
- MongoCollection::aggregate — Perform an aggregation using the aggregation framework
- MongoCollection::aggregateCursor — Execute an aggregation pipeline command and retrieve results through a cursor
- MongoCollection::batchInsert — Inserts multiple documents into this collection
- MongoCollection::__construct — Creates a new collection
- MongoCollection::count — Counts the number of documents in this collection
- MongoCollection::createDBRef — Creates a database reference
- MongoCollection::createIndex — Creates an index on the specified field(s) if it does not already exist
- MongoCollection::deleteIndex — Deletes an index from this collection
- MongoCollection::deleteIndexes — Delete all indices for this collection
- MongoCollection::distinct — Retrieve a list of distinct values for the given key across a collection
- MongoCollection::drop — Drops this collection
- MongoCollection::ensureIndex — Creates an index on the specified field(s) if it does not already exist
- MongoCollection::find — Queries this collection, returning a MongoCursor for the result set
- MongoCollection::findAndModify — Update a document and return it
- MongoCollection::findOne — Queries this collection, returning a single element
- MongoCollection::__get — Gets a collection
- MongoCollection::getDBRef — Fetches the document pointed to by a database reference
- MongoCollection::getIndexInfo — Returns information about indexes on this collection
- MongoCollection::getName — Returns this collection's name
- MongoCollection::getReadPreference — Get the read preference for this collection
- MongoCollection::getSlaveOkay — Get slaveOkay setting for this collection
- MongoCollection::getWriteConcern — Get the write concern for this collection
- MongoCollection::group — Performs an operation similar to SQL's GROUP BY command
- MongoCollection::insert — Inserts a document into the collection
- MongoCollection::parallelCollectionScan — Returns an array of cursors to iterator over a full collection in parallel
- MongoCollection::remove — Remove records from this collection
- MongoCollection::save — Saves a document to this collection
- MongoCollection::setReadPreference — Set the read preference for this collection
- MongoCollection::setSlaveOkay — Change slaveOkay setting for this collection
- MongoCollection::setWriteConcern — Set the write concern for this database
- MongoCollection::toIndexString — Converts keys specifying an index to its identifying string
- MongoCollection::__toString — String representation of this collection
- MongoCollection::update — Update records based on a given criteria
- MongoCollection::validate — Validates this collection
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-class.mongocollection.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.
