Public Member Functions
	__construct (Manager $manager, string $databaseName, string $collectionName, array $options=[])
	Constructs new Collection instance.

	__debugInfo ()
	Return internal properties for debugging purposes.

	__toString ()
	Return the collection namespace (e.g.

	aggregate (array $pipeline, array $options=[])
	Executes an aggregation framework pipeline on the collection.

	bulkWrite (array $operations, array $options=[])
	Executes multiple write operations.

	count ($filter=[], array $options=[])
	Gets the number of documents matching the filter.

	countDocuments ($filter=[], array $options=[])
	Gets the number of documents matching the filter.

	createIndex ($key, array $options=[])
	Create a single index for the collection.

	createIndexes (array $indexes, array $options=[])
	Create one or more indexes for the collection.

	deleteMany ($filter, array $options=[])
	Deletes all documents matching the filter.

	deleteOne ($filter, array $options=[])
	Deletes at most one document matching the filter.

	distinct (string $fieldName, $filter=[], array $options=[])
	Finds the distinct values for a specified field across the collection.

	drop (array $options=[])
	Drop this collection.

	dropIndex ($indexName, array $options=[])
	Drop a single index in the collection.

	dropIndexes (array $options=[])
	Drop all indexes in the collection.

	estimatedDocumentCount (array $options=[])
	Gets an estimated number of documents in the collection using the collection metadata.

	explain (Explainable $explainable, array $options=[])
	Explains explainable commands.

	find ($filter=[], array $options=[])
	Finds documents matching the query.

	findOne ($filter=[], array $options=[])
	Finds a single document matching the query.

	findOneAndDelete ($filter, array $options=[])
	Finds a single document and deletes it, returning the original.

	findOneAndReplace ($filter, $replacement, array $options=[])
	Finds a single document and replaces it, returning either the original or the replaced document.

	findOneAndUpdate ($filter, $update, array $options=[])
	Finds a single document and updates it, returning either the original or the updated document.

	getCollectionName ()
	Return the collection name.

	getDatabaseName ()
	Return the database name.

	getManager ()
	Return the Manager.

	getNamespace ()
	Return the collection namespace.

	getReadConcern ()
	Return the read concern for this collection.

	getReadPreference ()
	Return the read preference for this collection.

	getTypeMap ()
	Return the type map for this collection.

	getWriteConcern ()
	Return the write concern for this collection.

	insertMany (array $documents, array $options=[])
	Inserts multiple documents.

	insertOne ($document, array $options=[])
	Inserts one document.

	listIndexes (array $options=[])
	Returns information for all indexes for the collection.

	mapReduce (JavascriptInterface $map, JavascriptInterface $reduce, $out, array $options=[])
	Executes a map-reduce aggregation on the collection.

	rename (string $toCollectionName, ?string $toDatabaseName=null, array $options=[])
	Renames the collection.

	replaceOne ($filter, $replacement, array $options=[])
	Replaces at most one document matching the filter.

	updateMany ($filter, $update, array $options=[])
	Updates all documents matching the filter.

	updateOne ($filter, $update, array $options=[])
	Updates at most one document matching the filter.

	watch (array $pipeline=[], array $options=[])
	Create a change stream for watching changes to the collection.

	withOptions (array $options=[])
	Get a clone of this collection with different options.

Constructor & Destructor Documentation

◆ __construct()

MongoDB\Collection::__construct	(	Manager	$manager,
		string	$databaseName,
		string	$collectionName,
		array	$options = [] )

Constructs new Collection instance.

This class provides methods for collection-specific operations, such as CRUD (i.e. create, read, update, and delete) and index management.

Supported options:

readConcern (MongoDB\Driver\ReadConcern): The default read concern to use for collection operations. Defaults to the Manager's read concern.
readPreference (MongoDB\Driver\ReadPreference): The default read preference to use for collection operations. Defaults to the Manager's read preference.
typeMap (array): Default type map for cursors and BSON documents.
writeConcern (MongoDB\Driver\WriteConcern): The default write concern to use for collection operations. Defaults to the Manager's write concern.

Parameters

Manager	$manager	Manager instance from the driver
string	$databaseName	Database name
string	$collectionName	Collection name
array	$options	Collection options

Exceptions

InvalidArgumentException for parameter/option parsing errors

Member Function Documentation

◆ __debugInfo()

MongoDB\Collection::__debugInfo ( )

Return internal properties for debugging purposes.

See also: https://php.net/manual/en/language.oop5.magic.php#language.oop5.magic.debuginfo

Return values

array

◆ __toString()

MongoDB\Collection::__toString ( )

Return the collection namespace (e.g.

"db.collection").

See also: https://mongodb.com/docs/manual/core/databases-and-collections/

Return values

string

◆ aggregate()

MongoDB\Collection::aggregate	(	array	$pipeline,
		array	$options = [] )

Executes an aggregation framework pipeline on the collection.

Note: this method's return value depends on the MongoDB server version and the "useCursor" option. If "useCursor" is true, a Cursor will be returned; otherwise, an ArrayIterator is returned, which wraps the "result" array from the command response document.

See also: Aggregate\__construct() for supported options

Parameters

array	$pipeline	List of pipeline operations
array	$options	Command options

Return values

Traversable

Exceptions

UnexpectedValueException	if the command response was malformed
UnsupportedException	if options are not supported by the selected server
InvalidArgumentException	for parameter/option parsing errors
DriverRuntimeException	for other driver errors (e.g. connection errors)

◆ bulkWrite()

MongoDB\Collection::bulkWrite	(	array	$operations,
		array	$options = [] )

Executes multiple write operations.

See also: BulkWrite\__construct() for supported options

Parameters

array[]	$operations	List of write operations
array	$options	Command options

Return values

BulkWriteResult

Exceptions

UnsupportedException	if options are not supported by the selected server
InvalidArgumentException	for parameter/option parsing errors
DriverRuntimeException	for other driver errors (e.g. connection errors)

◆ count()

MongoDB\Collection::count	(		$filter = [],
		array	$options = [] )

Gets the number of documents matching the filter.

See also: Count\__construct() for supported options

Parameters

array \| object	$filter	Query by which to filter documents
array	$options	Command options

Return values

integer

Exceptions

UnexpectedValueException	if the command response was malformed
UnsupportedException	if options are not supported by the selected server
InvalidArgumentException	for parameter/option parsing errors
DriverRuntimeException	for other driver errors (e.g. connection errors)

Deprecated: 1.4

◆ countDocuments()

MongoDB\Collection::countDocuments	(		$filter = [],
		array	$options = [] )

Gets the number of documents matching the filter.

See also: CountDocuments\__construct() for supported options

Parameters

array \| object	$filter	Query by which to filter documents
array	$options	Command options

Return values

integer

Exceptions

UnexpectedValueException	if the command response was malformed
UnsupportedException	if options are not supported by the selected server
InvalidArgumentException	for parameter/option parsing errors
DriverRuntimeException	for other driver errors (e.g. connection errors)

◆ createIndex()

MongoDB\Collection::createIndex	(		$key,
		array	$options = [] )

Create a single index for the collection.

See also: Collection\createIndexes(); CreateIndexes\__construct() for supported command options

Parameters

array \| object	$key	Document containing fields mapped to values, which denote order or an index type
array	$options	Index and command options

Return values

string The name of the created index

Exceptions

UnsupportedException	if options are not supported by the selected server
InvalidArgumentException	for parameter/option parsing errors
DriverRuntimeException	for other driver errors (e.g. connection errors)

◆ createIndexes()

MongoDB\Collection::createIndexes	(	array	$indexes,
		array	$options = [] )

Create one or more indexes for the collection.

Each element in the $indexes array must have a "key" document, which contains fields mapped to an order or type. Other options may follow. For example:

$indexes = [
    // Create a unique index on the "username" field
    [ 'key' => [ 'username' => 1 ], 'unique' => true ],
    // Create a 2dsphere index on the "loc" field with a custom name
    [ 'key' => [ 'loc' => '2dsphere' ], 'name' => 'geo' ],
];

If the "name" option is unspecified, a name will be generated from the "key" document.

See also: https://mongodb.com/docs/manual/reference/command/createIndexes/; https://mongodb.com/docs/manual/reference/method/db.collection.createIndex/; CreateIndexes\__construct() for supported command options

Parameters

array[]	$indexes	List of index specifications
array	$options	Command options

Return values

string[] The names of the created indexes

Exceptions

UnsupportedException	if options are not supported by the selected server
InvalidArgumentException	for parameter/option parsing errors
DriverRuntimeException	for other driver errors (e.g. connection errors)

◆ deleteMany()

MongoDB\Collection::deleteMany	(		$filter,
		array	$options = [] )

Deletes all documents matching the filter.

See also: DeleteMany\__construct() for supported options; https://mongodb.com/docs/manual/reference/command/delete/

Parameters

array \| object	$filter	Query by which to delete documents
array	$options	Command options

Return values

DeleteResult

Exceptions

UnsupportedException	if options are not supported by the selected server
InvalidArgumentException	for parameter/option parsing errors
DriverRuntimeException	for other driver errors (e.g. connection errors)

◆ deleteOne()

MongoDB\Collection::deleteOne	(		$filter,
		array	$options = [] )

Deletes at most one document matching the filter.

See also: DeleteOne\__construct() for supported options; https://mongodb.com/docs/manual/reference/command/delete/

Parameters

array \| object	$filter	Query by which to delete documents
array	$options	Command options

Return values

DeleteResult

Exceptions

UnsupportedException	if options are not supported by the selected server
InvalidArgumentException	for parameter/option parsing errors
DriverRuntimeException	for other driver errors (e.g. connection errors)

◆ distinct()

MongoDB\Collection::distinct	(	string	$fieldName,
			$filter = [],
		array	$options = [] )

Finds the distinct values for a specified field across the collection.

See also: Distinct\__construct() for supported options

Parameters

string	$fieldName	Field for which to return distinct values
array \| object	$filter	Query by which to filter documents
array	$options	Command options

Return values

array

Exceptions

UnexpectedValueException	if the command response was malformed
UnsupportedException	if options are not supported by the selected server
InvalidArgumentException	for parameter/option parsing errors
DriverRuntimeException	for other driver errors (e.g. connection errors)

◆ drop()

MongoDB\Collection::drop ( array $options = [] )

Drop this collection.

See also: DropCollection\__construct() for supported options

Parameters

array $options Additional options

Return values

array|object Command result document

Exceptions

UnsupportedException	if options are not supported by the selected server
InvalidArgumentException	for parameter/option parsing errors
DriverRuntimeException	for other driver errors (e.g. connection errors)

◆ dropIndex()

MongoDB\Collection::dropIndex	(		$indexName,
		array	$options = [] )

Drop a single index in the collection.

See also: DropIndexes\__construct() for supported options

Parameters

string \| IndexInfo	$indexName	Index name or model object
array	$options	Additional options

Return values

array|object Command result document

Exceptions

UnsupportedException	if options are not supported by the selected server
InvalidArgumentException	for parameter/option parsing errors
DriverRuntimeException	for other driver errors (e.g. connection errors)

◆ dropIndexes()

MongoDB\Collection::dropIndexes ( array $options = [] )

Drop all indexes in the collection.

See also: DropIndexes\__construct() for supported options

Parameters

array $options Additional options

Return values

array|object Command result document

Exceptions

UnsupportedException	if options are not supported by the selected server
InvalidArgumentException	for parameter/option parsing errors
DriverRuntimeException	for other driver errors (e.g. connection errors)

◆ estimatedDocumentCount()

MongoDB\Collection::estimatedDocumentCount ( array $options = [] )

Gets an estimated number of documents in the collection using the collection metadata.

See also: EstimatedDocumentCount\__construct() for supported options

Parameters

array $options Command options

Return values

integer

Exceptions

UnexpectedValueException	if the command response was malformed
UnsupportedException	if options are not supported by the selected server
InvalidArgumentException	for parameter/option parsing errors
DriverRuntimeException	for other driver errors (e.g. connection errors)

◆ explain()

MongoDB\Collection::explain	(	Explainable	$explainable,
		array	$options = [] )

Explains explainable commands.

See also: Explain\__construct() for supported options; https://mongodb.com/docs/manual/reference/command/explain/

Parameters

Explainable	$explainable	Command on which to run explain
array	$options	Additional options

Return values

array|object

Exceptions

UnsupportedException	if explainable or options are not supported by the selected server
InvalidArgumentException	for parameter/option parsing errors
DriverRuntimeException	for other driver errors (e.g. connection errors)

◆ find()

MongoDB\Collection::find	(		$filter = [],
		array	$options = [] )

Finds documents matching the query.

See also: Find\__construct() for supported options; https://mongodb.com/docs/manual/crud/#read-operations

Parameters

array \| object	$filter	Query by which to filter documents
array	$options	Additional options

Return values

Cursor

Exceptions

UnsupportedException	if options are not supported by the selected server
InvalidArgumentException	for parameter/option parsing errors
DriverRuntimeException	for other driver errors (e.g. connection errors)

◆ findOne()

MongoDB\Collection::findOne	(		$filter = [],
		array	$options = [] )

Finds a single document matching the query.

See also: FindOne\__construct() for supported options; https://mongodb.com/docs/manual/crud/#read-operations

Parameters

array \| object	$filter	Query by which to filter documents
array	$options	Additional options

Return values

array|object|null

Exceptions

UnsupportedException	if options are not supported by the selected server
InvalidArgumentException	for parameter/option parsing errors
DriverRuntimeException	for other driver errors (e.g. connection errors)

◆ findOneAndDelete()

MongoDB\Collection::findOneAndDelete	(		$filter,
		array	$options = [] )

Finds a single document and deletes it, returning the original.

The document to return may be null if no document matched the filter.

See also: FindOneAndDelete\__construct() for supported options; https://mongodb.com/docs/manual/reference/command/findAndModify/

Parameters

array \| object	$filter	Query by which to filter documents
array	$options	Command options

Return values

array|object|null

Exceptions

UnexpectedValueException	if the command response was malformed
UnsupportedException	if options are not supported by the selected server
InvalidArgumentException	for parameter/option parsing errors
DriverRuntimeException	for other driver errors (e.g. connection errors)

◆ findOneAndReplace()

MongoDB\Collection::findOneAndReplace	(		$filter,
			$replacement,
		array	$options = [] )

Finds a single document and replaces it, returning either the original or the replaced document.

The document to return may be null if no document matched the filter. By default, the original document is returned. Specify FindOneAndReplace\RETURN_DOCUMENT_AFTER for the "returnDocument" option to return the updated document.

See also: FindOneAndReplace\__construct() for supported options; https://mongodb.com/docs/manual/reference/command/findAndModify/

Parameters

array \| object	$filter	Query by which to filter documents
array \| object	$replacement	Replacement document
array	$options	Command options

Return values

array|object|null

Exceptions

UnexpectedValueException	if the command response was malformed
UnsupportedException	if options are not supported by the selected server
InvalidArgumentException	for parameter/option parsing errors
DriverRuntimeException	for other driver errors (e.g. connection errors)

◆ findOneAndUpdate()

MongoDB\Collection::findOneAndUpdate	(		$filter,
			$update,
		array	$options = [] )

Finds a single document and updates it, returning either the original or the updated document.

The document to return may be null if no document matched the filter. By default, the original document is returned. Specify FindOneAndUpdate\RETURN_DOCUMENT_AFTER for the "returnDocument" option to return the updated document.

See also: FindOneAndReplace\__construct() for supported options; https://mongodb.com/docs/manual/reference/command/findAndModify/

Parameters

array \| object	$filter	Query by which to filter documents
array \| object	$update	Update to apply to the matched document
array	$options	Command options

Return values

array|object|null

Exceptions

UnexpectedValueException	if the command response was malformed
UnsupportedException	if options are not supported by the selected server
InvalidArgumentException	for parameter/option parsing errors
DriverRuntimeException	for other driver errors (e.g. connection errors)

◆ getCollectionName()

MongoDB\Collection::getCollectionName ( )

Return the collection name.

Return values

string

◆ getDatabaseName()

MongoDB\Collection::getDatabaseName ( )

Return the database name.

Return values

string

◆ getManager()

MongoDB\Collection::getManager ( )

Return the Manager.

Return values

Manager

◆ getNamespace()

MongoDB\Collection::getNamespace ( )

Return the collection namespace.

See also: https://mongodb.com/docs/manual/reference/glossary/#term-namespace

Return values

string

◆ getReadConcern()

MongoDB\Collection::getReadConcern ( )

Return the read concern for this collection.

See also: https://php.net/manual/en/mongodb-driver-readconcern.isdefault.php

Return values

ReadConcern

◆ getReadPreference()

MongoDB\Collection::getReadPreference ( )

Return the read preference for this collection.

Return values

ReadPreference

◆ getTypeMap()

MongoDB\Collection::getTypeMap ( )

Return the type map for this collection.

Return values

array

◆ getWriteConcern()

MongoDB\Collection::getWriteConcern ( )

Return the write concern for this collection.

See also: https://php.net/manual/en/mongodb-driver-writeconcern.isdefault.php

Return values

WriteConcern

◆ insertMany()

MongoDB\Collection::insertMany	(	array	$documents,
		array	$options = [] )

Inserts multiple documents.

See also: InsertMany\__construct() for supported options; https://mongodb.com/docs/manual/reference/command/insert/

Parameters

array[] \| object[]	$documents	The documents to insert
array	$options	Command options

Return values

InsertManyResult

Exceptions

InvalidArgumentException	for parameter/option parsing errors
DriverRuntimeException	for other driver errors (e.g. connection errors)

◆ insertOne()

MongoDB\Collection::insertOne	(		$document,
		array	$options = [] )

Inserts one document.

See also: InsertOne\__construct() for supported options; https://mongodb.com/docs/manual/reference/command/insert/

Parameters

array \| object	$document	The document to insert
array	$options	Command options

Return values

InsertOneResult

Exceptions

InvalidArgumentException	for parameter/option parsing errors
DriverRuntimeException	for other driver errors (e.g. connection errors)

◆ listIndexes()

MongoDB\Collection::listIndexes ( array $options = [] )

Returns information for all indexes for the collection.

See also: ListIndexes\__construct() for supported options

Return values

IndexInfoIterator

Exceptions

InvalidArgumentException	for parameter/option parsing errors
DriverRuntimeException	for other driver errors (e.g. connection errors)

◆ mapReduce()

MongoDB\Collection::mapReduce	(	JavascriptInterface	$map,
		JavascriptInterface	$reduce,
			$out,
		array	$options = [] )

Executes a map-reduce aggregation on the collection.

See also: MapReduce\__construct() for supported options; https://mongodb.com/docs/manual/reference/command/mapReduce/

Parameters

JavascriptInterface	$map	Map function
JavascriptInterface	$reduce	Reduce function
string \| array \| object	$out	Output specification
array	$options	Command options

Return values

MapReduceResult

Exceptions

UnsupportedException	if options are not supported by the selected server
InvalidArgumentException	for parameter/option parsing errors
DriverRuntimeException	for other driver errors (e.g. connection errors)
UnexpectedValueException	if the command response was malformed

◆ rename()

MongoDB\Collection::rename	(	string	$toCollectionName,
		?string	$toDatabaseName = null,
		array	$options = [] )

Renames the collection.

See also: RenameCollection\__construct() for supported options

Parameters

string	$toCollectionName	New name of the collection
string \| null	$toDatabaseName	New database name of the collection. Defaults to the original database.
array	$options	Additional options

Return values

array|object Command result document

Exceptions

UnsupportedException	if options are not supported by the selected server
InvalidArgumentException	for parameter/option parsing errors
DriverRuntimeException	for other driver errors (e.g. connection errors)

◆ replaceOne()

MongoDB\Collection::replaceOne	(		$filter,
			$replacement,
		array	$options = [] )

Replaces at most one document matching the filter.

See also: ReplaceOne\__construct() for supported options; https://mongodb.com/docs/manual/reference/command/update/

Parameters

array \| object	$filter	Query by which to filter documents
array \| object	$replacement	Replacement document
array	$options	Command options

Return values

UpdateResult

Exceptions

UnsupportedException	if options are not supported by the selected server
InvalidArgumentException	for parameter/option parsing errors
DriverRuntimeException	for other driver errors (e.g. connection errors)

◆ updateMany()

MongoDB\Collection::updateMany	(		$filter,
			$update,
		array	$options = [] )

Updates all documents matching the filter.

See also: UpdateMany\__construct() for supported options; https://mongodb.com/docs/manual/reference/command/update/

Parameters

array \| object	$filter	Query by which to filter documents
array \| object	$update	Update to apply to the matched documents
array	$options	Command options

Return values

UpdateResult

Exceptions

UnsupportedException	if options are not supported by the selected server
InvalidArgumentException	for parameter/option parsing errors
DriverRuntimeException	for other driver errors (e.g. connection errors)

◆ updateOne()

MongoDB\Collection::updateOne	(		$filter,
			$update,
		array	$options = [] )

Updates at most one document matching the filter.

See also: UpdateOne\__construct() for supported options; https://mongodb.com/docs/manual/reference/command/update/

Parameters

array \| object	$filter	Query by which to filter documents
array \| object	$update	Update to apply to the matched document
array	$options	Command options

Return values

UpdateResult

Exceptions

UnsupportedException	if options are not supported by the selected server
InvalidArgumentException	for parameter/option parsing errors
DriverRuntimeException	for other driver errors (e.g. connection errors)

◆ watch()

MongoDB\Collection::watch	(	array	$pipeline = [],
		array	$options = [] )

Create a change stream for watching changes to the collection.

See also: Watch\__construct() for supported options

Parameters

array	$pipeline	List of pipeline operations
array	$options	Command options

Return values

ChangeStream

Exceptions

InvalidArgumentException for parameter/option parsing errors

◆ withOptions()

MongoDB\Collection::withOptions ( array $options = [] )

Get a clone of this collection with different options.

See also: Collection\__construct() for supported options

Parameters

array $options Collection constructor options

Return values

Collection

Exceptions

InvalidArgumentException for parameter/option parsing errors

The documentation for this class was generated from the following file:

cache/stores/mongodb/MongoDB/Collection.php

Public Member Functions

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __debugInfo()

◆ __toString()

◆ aggregate()

◆ bulkWrite()

◆ count()

◆ countDocuments()

◆ createIndex()

◆ createIndexes()

◆ deleteMany()

◆ deleteOne()

◆ distinct()

◆ drop()

◆ dropIndex()

◆ dropIndexes()

◆ estimatedDocumentCount()

◆ explain()

◆ find()

◆ findOne()

◆ findOneAndDelete()

◆ findOneAndReplace()

◆ findOneAndUpdate()

◆ getCollectionName()

◆ getDatabaseName()

◆ getManager()

◆ getNamespace()

◆ getReadConcern()

◆ getReadPreference()

◆ getTypeMap()

◆ getWriteConcern()

◆ insertMany()

◆ insertOne()

◆ listIndexes()

◆ mapReduce()

◆ rename()

◆ replaceOne()

◆ updateMany()

◆ updateOne()

◆ watch()

◆ withOptions()