MongoDB\Collection::createIndex()
Definition
Parameters
$key
: array|objectSpecifies the field or fields to index and the index order.
For example, the following specifies a descending index on the
username
field:[ 'username' => -1 ] $options
: arrayAn array specifying the desired options.
The
$options
parameter accepts both index and command options. A non-exhaustive list of index options follows. For a complete list of index options, refer to the createIndexes command reference in the MongoDB manual.Index Options (non-exhaustive)
collationarray|objectCollation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks. When specifying collation, the
locale
field is mandatory; all other collation fields are optional. For descriptions of the fields, see Collation Document.If the collation is unspecified but the collection has a default collation, the operation uses the collation specified for the collection. If no collation is specified for the collection or for the operation, MongoDB uses the simple binary comparison used in prior versions for string comparisons.
expireAfterSecondsintegerCreates a TTL index.namestringA name that uniquely identifies the index. By default, MongoDB creates index names based on the key.partialFilterExpressionarray|objectCreates a partial index.sparsebooleanCreates a sparse index.uniquebooleanCreates a unique index.Command Options
NameTypeDescriptioncommentmixedEnables users to specify an arbitrary comment to help trace the operation through the database profiler, currentOp output, and logs.
This option is available since MongoDB 4.4 and will result in an exception at execution time if specified for an older server version.
New in version 1.13.
commitQuorumstring|integerSpecifies 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.
This option accepts the same values for the
w
field in a write concern plus"votingMembers"
, which indicates all voting data-bearing nodes.This is not supported for server versions prior to 4.4 and will result in an exception at execution time if used.
New in version 1.7.
maxTimeMSintegerThe cumulative time limit in milliseconds for processing operations on the cursor. MongoDB aborts the operation at the earliest following interrupt point.
New in version 1.3.
sessionClient session to associate with the operation.
New in version 1.3.
writeConcernWrite concern to use for the operation. Defaults to the collection's write concern.
It is not possible to specify a write concern for individual operations as part of a transaction. Instead, set the
writeConcern
option when starting the transaction.
Return Values
The name of the created index as a string.
Errors/Exceptions
MongoDB\Exception\UnsupportedException
if options are used and
not supported by the selected server (e.g. collation
, readConcern
,
writeConcern
).
MongoDB\Exception\InvalidArgumentException
for errors related to
the parsing of parameters or options.
MongoDB\Driver\Exception\RuntimeException for other errors at the extension level (e.g. connection errors).
Examples
Create a Compound Index
The following example creates a compound index
on the borough
and cuisine
fields in the restaurants
collection in
the test
database.
$collection = (new MongoDB\Client)->selectCollection('test', 'restaurants'); $indexName = $collection->createIndex(['borough' => 1, 'cuisine' => 1]); var_dump($indexName);
The output would then resemble:
string(19) "borough_1_cuisine_1"
Create a Partial Index
The following example adds a partial index on
the borough
field in the restaurants
collection in the test
database. The partial index indexes only documents where the borough
field
exists.
$collection = (new MongoDB\Client)->selectCollection('test', 'restaurants'); $indexName = $collection->createIndex( ['borough' => 1], [ 'partialFilterExpression' => [ 'borough' => ['$exists' => true], ], ] ); var_dump($indexName);
The output would then resemble:
string(9) "borough_1"
See Also
createIndexes command reference in the MongoDB manual
Index documentation in the MongoDB Manual