Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.

(no description)

File Size: 166 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

RenameCollection:: (4 methods):
  __construct()
  execute()
  createCommand()
  createOptions()


Class: RenameCollection  - X-Ref

Operation for the renameCollection command.

__construct(string $fromDatabaseName, string $fromCollectionName, string $toDatabaseName, string $toCollectionName, array $options = [])   X-Ref
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.

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

execute(Server $server)   X-Ref
Execute the operation.

return: array|object Command result document

createCommand()   X-Ref
Create the renameCollection command.


createOptions()   X-Ref
Create options for executing the command.