MongoDB\Operation\RenameCollection Class Reference

Inheritance diagram for MongoDB\Operation\RenameCollection:

Public Member Functions
	__construct (string $fromDatabaseName, string $fromCollectionName, string $toDatabaseName, string $toCollectionName, array $options=[])
	Constructs a renameCollection command.
	execute (Server $server)
	Execute the operation.

Constructor & Destructor Documentation

__construct()

MongoDB\Operation\RenameCollection::__construct	(	string	$fromDatabaseName,
		string	$fromCollectionName,
		string	$toDatabaseName,
		string	$toCollectionName,
		array	$options = [] )

Constructs a renameCollection 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 be used for the returned command result document.
• writeConcern (MongoDB\Driver\WriteConcern): Write concern.
• dropTarget (boolean): If true, MongoDB will drop the target before renaming the collection.

Parameters

string	$fromDatabaseName	Database name
string	$fromCollectionName	Collection name
string	$toDatabaseName	New database name
string	$toCollectionName	New collection name
array	$options	Command options

Exceptions

InvalidArgumentException

for parameter/option parsing errors

Member Function Documentation

execute()

MongoDB\Operation\RenameCollection::execute

(

Server

$server

)

Execute the operation.

See also

Executable\execute()

Return values

array|object

Command result document

Exceptions

UnsupportedException	if write concern is used and unsupported
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/RenameCollection.php