MongoDB\Operation\CreateIndexes Class Reference

Inheritance diagram for MongoDB\Operation\CreateIndexes:

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

Constructor & Destructor Documentation

__construct()

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

Constructs a createIndexes command.

Supported options:

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

  This is not supported for servers versions < 4.4.

• 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.
• writeConcern (MongoDB\Driver\WriteConcern): Write concern.

Parameters

string	$databaseName	Database name
string	$collectionName	Collection name
array[]	$indexes	List of index specifications
array	$options	Command options

Exceptions

InvalidArgumentException

for parameter/option parsing errors

Member Function Documentation

execute()

MongoDB\Operation\CreateIndexes::execute

(

Server

$server

)

Execute the operation.

See also

Executable\execute()

Return values

string[]

The names of the created indexes

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/CreateIndexes.php