createIndexes

Optional. The minimum number of data-bearing replica set members (i.e. commit quorum), including the primary, that must report a successful index build before the primary marks the indexes as ready.

Starting in MongoDB v5.0, you can resume some interrupted index builds when the commit quorum is set to "votingMembers".

Replica set nodes in a commit quorum must have members[n].buildIndexes set to true. If any voting nodes have members[n].buildIndexes set to false, you can't use the default "votingMembers" commit quorum. Either configure all nodes with members[n].buildIndexes set to true, or select a different commit quorum.

Supports the following values:

• "votingMembers" - all data-bearing voting replica set members (Default). A "voting" member is any replica set member where members[n].votes is greater than 0.

• "majority" - a simple majority of data-bearing replica set members.

• <int> - a specific number of data-bearing replica set members.

• 0 - Disables quorum-voting behavior. Members start the index build simultaneously but do not vote or wait for quorum before completing the index build. If you start an index build with a commit quorum of 0, you cannot later modify the commit quorum using setIndexCommitQuorum.

• A replica set tag name.

Optional.

A user-provided comment to attach to this command. Once set, this comment appears alongside records of this command in the following locations:

• mongod log messages, in the attr.command.cursor.comment field.

• Database profiler output, in the command.comment field.

• currentOp output, in the command.comment field.

A comment can be any valid BSON type (string, integer, object, array, etc).

Specifies the index's fields. For each field, specify a key-value pair in which the key is the name of the field to index and the value is either the index direction or index type. If specifying direction, specify 1 for ascending or -1 for descending.

MongoDB supports several different index types including text, geospatial, and hashed indexes. See index types for more information.

Wildcard indexes support workloads where users query against custom fields or a large variety of fields in a collection:

• To create a wildcard index on all fields and subfields in a document, specify { "$**" : 1 } as the index key. You cannot specify a descending index key when creating a wildcard index.

  You can also either include or exclude specific fields and their subfields from the index using the optional wildcardProjection parameter.

  Wildcard indexes omit the _id field by default. To include the _id field in the wildcard index, you must explicitly include it in the wildcardProjection document:

  {
    "wildcardProjection" : {
      "_id" : 1,
      "<field>" : 0|1
    }
  }

  With the exception of explicitly including _id field, you cannot combine inclusion and exclusion statements in the wildcardProjection document.

• You can create a wildcard index on a specific field and its subpaths by specifying the full path to that field as the index key and append "$**" to the path:

  { "path.to.field.$**" : 1 }

  You cannot specify a descending index key when creating a wildcard index.

  The path-specific wildcard index syntax is incompatible with the wildcardProjection option. You cannot specify additional inclusions or exclusions on the specified path.

The wildcard index key must use one of the syntaxes listed above. For example, you cannot specify a compound index key. For more complete documentation on wildcard indexes, including restrictions on their creation, see Wildcard Index Restrictions.

The mongod featureCompatibilityVersion must be 4.2 to create wildcard indexes. For instructions on setting the fCV, see Set Feature Compatibility Version on MongoDB 6.0 Deployments.

For examples of wildcard index creation, see Create a Wildcard Index.

Optional. Creates a unique index so that the collection will not accept insertion or update of documents where the index key value matches an existing value in the index.

Specify true to create a unique index. The default value is false.

The option is unavailable for hashed indexes.

Optional. If specified, the index only references documents that match the filter expression. See Partial Indexes for more information.

A filter expression can include:

• equality expressions (i.e. field: value or using the $eq operator),

• $exists: true expression,

• $gt, $gte, $lt, $lte expressions,

• $type expressions,

• $and operator,

• $or operator,

• $in operator

You can specify a partialFilterExpression option for all MongoDB index types.

Optional. If true, the index only references documents with the specified field. These indexes use less space but behave differently in some situations (particularly sorts). The default value is false. See Sparse Indexes for more information.

The following index types are sparse by default and ignore this option:

• 2dsphere

• 2d

• geoHaystack

• text

For a compound index that includes 2dsphere index key(s) along with keys of other types, only the 2dsphere index fields determine whether the index references a document.

MongoDB provides the option to create partial indexes. These offer a superset of the functionality of sparse indexes and are preferred instead.

Optional. Specifies a value, in seconds, as a time to live (TTL) to control how long MongoDB retains documents in this collection. This option only applies to TTL indexes. See Expire Data from Collections by Setting TTL for more information.

If you use TTL indexes created before MongoDB 5.0, or if you want to sync data created in MongDB 5.0 with a pre-5.0 installation, see Indexes Configured Using NaN to avoid misconfiguration issues.

The TTL index expireAfterSeconds value must be within 0 and 2147483647 inclusive.

Optional. A flag that determines whether the index is hidden from the query planner. A hidden index is not evaluated as part of query plan selection.

Default is false.

Optional. Allows users to configure the storage engine on a per-index basis when creating an index.

The storageEngine option should take the following form:

storageEngine: { <storage-engine-name>: <options> }

Storage engine configuration options specified when creating indexes are validated and logged to the oplog during replication to support replica sets with members that use different storage engines.

Optional. The text index version number. Users can use this option to override the default version number.

For available versions, see Versions.

Optional. The 2dsphere index version number. Users can use this option to override the default version number.

For the available versions, see Versions.

Optional. For 2d indexes, the number of precision of the stored geohash value of the location data.

The bits value ranges from 1 to 32 inclusive. The default value is 26.

For geoHaystack indexes, specify the number of units within which to group the location values; i.e. group in the same bucket those location values that are within the specified number of units to each other.

The value must be greater than 0.

Optional. Specifies the collation for the index.

Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks.

If you have specified a collation at the collection level, then:

• If you do not specify a collation when creating the index, MongoDB creates the index with the collection's default collation.

• If you do specify a collation when creating the index, MongoDB creates the index with the specified collation.

The collation option has the following syntax:

collation: {
   locale: <string>,
   caseLevel: <boolean>,
   caseFirst: <string>,
   strength: <int>,
   numericOrdering: <boolean>,
   alternate: <string>,
   maxVariable: <string>,
   backwards: <boolean>
}

When specifying collation, the locale field is mandatory; all other collation fields are optional. For descriptions of the fields, see Collation Document.

Optional.

Allows users to include or exclude specific field paths from a wildcard index using the { "$**" : 1} key pattern. This option is only valid if creating a wildcard index on all document fields. You cannot specify this option if creating a wildcard index on a specific field path and its subfields, e.g. { "path.to.field.$**" : 1 }

The wildcardProjection option takes the following form:

wildcardProjection: {
  "path.to.field.a" : <value>,
  "path.to.field.b" : <value>
}

The <value> can be either of the following:

• 1 or true to include the field in the wildcard index.

• 0 or false to exclude the field from the wildcard index.

Wildcard indexes omit the _id field by default. To include the _id field in the wildcard index, you must explicitly include it in the wildcardProjection document:

{
  "wildcardProjection" : {
    "_id" : 1,
    "<field>" : 0|1
  }
}

With the exception of explicitly including _id field, you cannot combine inclusion and exclusion statements in the wildcardProjection document.