Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TransactionOptions

Configuration options for a transaction.

Hierarchy

Index

Properties

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 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 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 omitReadPreference

omitReadPreference?: boolean

Optional readConcern

readConcern?: ReadConcernLike

A default read concern for commands in this transaction

Optional writeConcern

writeConcern?: WriteConcern

A default writeConcern for commands in this transaction

Optional readPreference

readPreference?: ReadPreferenceLike

A default read preference for commands in this transaction

Optional maxCommitTimeMS

maxCommitTimeMS?: number

Specifies the maximum amount of time to allow a commit action on a transaction to run in milliseconds

Generated using TypeDoc