Interface IndexOptions

Creates the index in the background, yielding whenever possible.

return BSON regular expressions as BSONRegExp instances.

Default Value

false

the serializer will check if keys are valid.

Default Value

false

Collation

Comment to apply to the operation.

In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.

In server versions 4.4 and above, 'comment' can be any valid BSON type.

(MongoDB 4.4. or higher) 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. This option accepts the same values for the "w" field in a write concern plus "votingMembers", which indicates all voting data-bearing nodes.

Enable utf8 validation when deserializing BSON documents. Defaults to true.

Allows you to expire data on indexes applied to a data (MongoDB 2.2 or higher)

Specifies the verbosity mode for the explain output.

allow to specify if there what fields we wish to return as unserialized raw buffer.

Default Value

null

Specifies that the index should exist on the target collection but should not be used by the query planner when executing operations. (MongoDB 4.4 or higher)

serialize will not emit undefined fields note that the driver sets this to false

Default Value

true

For geospatial indexes set the high bound for the co-ordinates.

For geospatial indexes set the lower bound for the co-ordinates.

Override the autogenerated index name (useful if the resulting name is larger than 128 bytes)

Creates a partial index based on the given filter object (MongoDB 3.2 or higher)

when deserializing a Binary will return it as a node.js Buffer instance.

Default Value

false

when deserializing a Long will fit it into a Number if it's smaller than 53 bits.

Default Value

true

when deserializing will promote BSON values to their Node.js closest equivalent types.

Default Value

true

Enabling the raw option will return a Node.js Buffer which is allocated using allocUnsafe API. See this section from the Node.js Docs here for more detail about what "unsafe" refers to in this context. If you need to maintain your own editable clone of the bytes returned for an extended life time of the process, it is recommended you allocate your own buffer and clone the contents:

Example

const raw = await collection.findOne({}, { raw: true });
const myBuffer = Buffer.alloc(raw.byteLength);
myBuffer.set(raw, 0);
// Only save and use `myBuffer` beyond this point
Copy

Remarks

Please note there is a known limitation where this option cannot be used at the MongoClient level (see NODE-3946). It does correctly work at Db, Collection, and per operation the same as other BSON options work.

Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)

The preferred read preference (ReadPreference.primary, ReadPreference.primary_preferred, ReadPreference.secondary, ReadPreference.secondary_preferred, ReadPreference.nearest).

Should retry failed writes

serialize the javascript functions

Default Value

false

Specify ClientSession for this command

Creates a sparse index.

Allows users to configure the storage engine on a per-index basis when creating an index. (MongoDB 3.0 or higher)

Creates an unique index.

when deserializing a Long return as a BigInt.

Default Value

false

Specifies the index version number, either 0 or 1.