Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TransactionOptions

Configuration options for a transaction.

Hierarchy

Index

Properties

Optional authdb

authdb?: string

Optional bsonRegExp

bsonRegExp?: boolean

return BSON regular expressions as BSONRegExp instances.

Optional bypassPinningCheck

bypassPinningCheck?: boolean

Optional checkKeys

checkKeys?: boolean

the serializer will check if keys are valid.

Optional collation

collation?: CollationOptions

Collation

Optional comment

comment?: string | Document

A user-provided comment to attach to this command

Optional dbName

dbName?: string

Optional explain

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.

Optional fullResponse

fullResponse?: boolean
deprecated

This option does nothing

Optional ignoreUndefined

ignoreUndefined?: boolean

serialize will not emit undefined fields (default:true)

Optional maxCommitTimeMS

maxCommitTimeMS?: number

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.

Optional promoteLongs

promoteLongs?: boolean

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

Optional promoteValues

promoteValues?: boolean

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

Optional raw

raw?: boolean

Return BSON filled buffers from operations

Optional readConcern

readConcern?: ReadConcernLike

A default read concern for commands in this transaction

Optional readPreference

readPreference?: ReadPreference

A default read preference for commands in this transaction

Optional retryWrites

retryWrites?: boolean

Should retry failed writes

Optional serializeFunctions

serializeFunctions?: boolean

serialize the javascript functions (default:false).

Optional session

session?: ClientSession

Specify ClientSession for this command

Optional willRetryWrites

willRetryWrites?: boolean

Optional writeConcern

writeConcern?: WriteConcern

A default writeConcern for commands in this transaction

Generated using TypeDoc