Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TransactionOptions

Configuration options for a transaction.

Hierarchy

Index

Properties

authdb?: string
bsonRegExp?: boolean

return BSON regular expressions as BSONRegExp instances.

checkKeys?: boolean

the serializer will check if keys are valid.

collation?: CollationOptions

Collation

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.

dbName?: string
enableUtf8Validation?: boolean

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

Specifies the verbosity mode for the explain output.

fieldsAsRaw?: Document

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

fullResponse?: boolean
deprecated

This option does nothing

ignoreUndefined?: boolean

serialize will not emit undefined fields (default:true)

maxCommitTimeMS?: number

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

maxTimeMS?: number
noResponse?: boolean
omitReadPreference?: boolean
promoteBuffers?: boolean

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

promoteLongs?: boolean

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

promoteValues?: boolean

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

raw?: boolean

Return BSON filled buffers from operations

readConcern?: ReadConcernLike

A default read concern for commands in this transaction

readPreference?: ReadPreference

A default read preference for commands in this transaction

retryWrites?: boolean

Should retry failed writes

serializeFunctions?: boolean

serialize the javascript functions (default:false).

session?: ClientSession

Specify ClientSession for this command

willRetryWrite?: boolean
writeConcern?: WriteConcern

A default writeConcern for commands in this transaction

Generated using TypeDoc