IndexOptions | Documentation

Hierarchy

CreateIndexesOptions
- IndexOptions

Properties

Optional promoteLongs

promoteLongs?: boolean

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

Optional promoteBuffers

promoteBuffers?: boolean

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

Optional promoteValues

promoteValues?: boolean

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

Optional fieldsAsRaw

fieldsAsRaw?: <internal>.Document

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

Optional bsonRegExp

bsonRegExp?: boolean

return BSON regular expressions as BSONRegExp instances.

Optional checkKeys

checkKeys?: boolean

the serializer will check if keys are valid.

Optional serializeFunctions

serializeFunctions?: boolean

serialize the javascript functions (default:false).

Optional ignoreUndefined

ignoreUndefined?: boolean

serialize will not emit undefined fields (default:true)

Optional raw

raw?: boolean

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

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.

Optional enableUtf8Validation

enableUtf8Validation?: boolean

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

Optional fullResponse

fullResponse?: boolean

deprecated: This option does nothing

Optional readConcern

readConcern?: ReadConcernLike

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

Optional collation

collation?: CollationOptions

Collation

Optional maxTimeMS

maxTimeMS?: number

Optional comment

comment?: unknown

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.

Optional retryWrites

retryWrites?: boolean

Should retry failed writes

Optional dbName

dbName?: string

Optional authdb

authdb?: string

Optional noResponse

noResponse?: boolean

Optional background

background?: boolean

Creates the index in the background, yielding whenever possible.

Optional unique

unique?: boolean

Creates an unique index.

Optional name

name?: string

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

Optional partialFilterExpression

partialFilterExpression?: <internal>.Document

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

Optional sparse

sparse?: boolean

Creates a sparse index.

Optional expireAfterSeconds

expireAfterSeconds?: number

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

Optional storageEngine

storageEngine?: <internal>.Document

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

Optional commitQuorum

commitQuorum?: string | number

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

Optional version

version?: number

Specifies the index version number, either 0 or 1.

Optional default_language

default_language?: string

Optional language_override

language_override?: string

Optional textIndexVersion

textIndexVersion?: number

Optional 2dsphereIndexVersion

2dsphereIndexVersion?: number

Optional bits

bits?: number

Optional min

min?: number

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

Optional max

max?: number

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

Optional bucketSize

bucketSize?: number

Optional wildcardProjection

wildcardProjection?: <internal>.Document

Optional hidden

hidden?: boolean

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)

Optional explain

explain?: ExplainVerbosityLike

Specifies the verbosity mode for the explain output.

Optional session

session?: ClientSession

Specify ClientSession for this command

Optional willRetryWrite

willRetryWrite?: boolean

Optional readPreference

readPreference?: ReadPreferenceLike

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

Optional omitReadPreference

omitReadPreference?: boolean

Optional writeConcern

writeConcern?: WriteConcern | WriteConcernSettings

Write Concern as an object

Optional expires

expires?: string | number

expires utilizes the ms module from guille allowing us to use a friendlier syntax:

example

const schema = new Schema({ prop1: Date });

// expire in 24 hours
schema.index({ prop1: 1 }, { expires: 60*60*24 })

// expire in 24 hours
schema.index({ prop1: 1 }, { expires: '24h' })

// expire in 1.5 hours
schema.index({ prop1: 1 }, { expires: '1.5h' })

// expire in 7 days
schema.index({ prop1: 1 }, { expires: '7d' })

Optional weights

weights?: <internal>.Record<string, number>