MongoDB\Operation\ModifyCollection Class Reference

Inheritance diagram for MongoDB\Operation\ModifyCollection:

Public Member Functions
	__construct (string $databaseName, string $collectionName, array $collectionOptions, array $options=[])
	Constructs a collMod command.
	execute (Server $server)
	Execute the operation.

Constructor & Destructor Documentation

__construct()

MongoDB\Operation\ModifyCollection::__construct	(	string	$databaseName,
		string	$collectionName,
		array	$collectionOptions,
		array	$options = [] )

Constructs a collMod command.

Supported options:

• comment (mixed): BSON value to attach as a comment to this command.

  This is not supported for servers versions < 4.4.

• session (MongoDB\Driver\Session): Client session.
• typeMap (array): Type map for BSON deserialization. This will only be used for the returned command result document.
• writeConcern (MongoDB\Driver\WriteConcern): Write concern.

Parameters

string	$databaseName	Database name
string	$collectionName	Collection or view to modify
array	$collectionOptions	Collection or view options to assign
array	$options	Command options

Exceptions

InvalidArgumentException

for parameter/option parsing errors

Member Function Documentation

execute()

MongoDB\Operation\ModifyCollection::execute

(

Server

$server

)

Execute the operation.

See also

Executable\execute()

Return values

array|object

Command result document

Exceptions

DriverRuntimeException

for other driver errors (e.g. connection errors)

Implements MongoDB\Operation\Executable.

---

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

• cache/stores/mongodb/MongoDB/Operation/ModifyCollection.php