Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
  • Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
  • PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
/cache/stores/mongodb/MongoDB/Operation/ -> CreateCollection.php (source)

[Source view]

Differences Between: [Versions 400 and 401]

(no description)

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

Defines 1 class

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


Class: CreateCollection  - X-Ref

Operation for the create command.

__construct($databaseName, $collectionName, array $options = [])   X-Ref
Constructs a create command.

Supported options:

* autoIndexId (boolean): Specify false to disable the automatic creation
of an index on the _id field. For replica sets, this option cannot be
false. The default is true.

This option has been deprecated since MongoDB 3.2. As of MongoDB 4.0,
this option cannot be false when creating a replicated collection
(i.e. a collection outside of the local database in any mongod mode).

* capped (boolean): Specify true to create a capped collection. If set,
the size option must also be specified. The default is false.

* collation (document): Collation specification.

This is not supported for server versions < 3.4 and will result in an
exception at execution time if used.

* flags (integer): Options for the MMAPv1 storage engine only. Must be a
bitwise combination CreateCollection::USE_POWER_OF_2_SIZES and
CreateCollection::NO_PADDING. The default is
CreateCollection::USE_POWER_OF_2_SIZES.

* indexOptionDefaults (document): Default configuration for indexes when
creating the collection.

* max (integer): The maximum number of documents allowed in the capped
collection. The size option takes precedence over this limit.

* maxTimeMS (integer): The maximum amount of time to allow the query to
run.

* session (MongoDB\Driver\Session): Client session.

Sessions are not supported for server versions < 3.6.

* size (integer): The maximum number of bytes for a capped collection.

* storageEngine (document): Storage engine options.

* typeMap (array): Type map for BSON deserialization. This will only be
used for the returned command result document.

* validationAction (string): Validation action.

* validationLevel (string): Validation level.

* validator (document): Validation rules or expressions.

* writeConcern (MongoDB\Driver\WriteConcern): Write concern.

This is not supported for server versions < 3.4 and will result in an
exception at execution time if used.

param: string $databaseName   Database name
param: string $collectionName Collection name
param: array  $options        Command options

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

return: array|object Command result document
param: Server $server

createCommand()   X-Ref
Create the create command.

return: Command

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

return: array