Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.
/cache/stores/mongodb/MongoDB/Operation/ -> CreateIndexes.php (source)

[Source view]

Differences Between: [Versions 310 and 311] [Versions 311 and 401] [Versions 39 and 311]

(no description)

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

Defines 1 class

CreateIndexes:: (4 methods):
  __construct()
  execute()
  createOptions()
  executeCommand()


Class: CreateIndexes  - X-Ref

Operation for the createIndexes command.

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

Supported options:

* commitQuorum (integer|string): Specifies how many data-bearing members
of a replica set, including the primary, must complete the index
builds successfully before the primary marks the indexes as ready.

* 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.

* 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[] $indexes        List of index specifications
param: array   $options        Command options

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

param: Server $server
return: string[] The names of the created indexes

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

return: array

executeCommand(Server $server)   X-Ref
Create one or more indexes for the collection using the createIndexes
command.

param: Server $server