ListIndexesOptions

Hierarchy

Omit<CommandOperationOptions, "writeConcern">
- ListIndexesOptions

Properties

Optional authdb

authdb?: string

Optional batchSize

batchSize?: number

The batchSize for the returned command cursor or if pre 2.8 the systems batch collection

Optional bsonRegExp

bsonRegExp?: boolean

return BSON regular expressions as BSONRegExp instances.

defaultvalue: false

Optional checkKeys

checkKeys?: boolean

the serializer will check if keys are valid.

defaultvalue: false

Optional collation

collation?: CollationOptions

Collation

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 dbName

dbName?: string

Optional enableUtf8Validation

enableUtf8Validation?: boolean

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

Optional explain

explain?: ExplainVerbosityLike

Specifies the verbosity mode for the explain output.

Optional fieldsAsRaw

fieldsAsRaw?: Document

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

defaultvalue: null

Optional ignoreUndefined

ignoreUndefined?: boolean

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

defaultvalue: true

Optional maxTimeMS

maxTimeMS?: number

Optional noResponse

noResponse?: boolean

Optional omitReadPreference

omitReadPreference?: boolean

Optional promoteBuffers

promoteBuffers?: boolean

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

defaultvalue: false

Optional promoteLongs

promoteLongs?: boolean

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

defaultvalue: true

Optional promoteValues

promoteValues?: boolean

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

defaultvalue: 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 readConcern

readConcern?: ReadConcernLike

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

Optional readPreference

readPreference?: ReadPreferenceLike

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

Optional retryWrites

retryWrites?: boolean

Should retry failed writes

Optional serializeFunctions

serializeFunctions?: boolean

serialize the javascript functions

defaultvalue: false

Optional session

session?: ClientSession

Specify ClientSession for this command

Optional useBigInt64

useBigInt64?: boolean

when deserializing a Long return as a BigInt.

defaultvalue: false

Optional willRetryWrite

willRetryWrite?: boolean