Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UpdateOptions

Hierarchy

Index

Properties

arrayFilters?: Document[]

A set of filters specifying to which array elements an update should apply

authdb?: string
bsonRegExp?: boolean

return BSON regular expressions as BSONRegExp instances.

bypassDocumentValidation?: boolean

If true, allows the write to opt-out of document level validation

bypassPinningCheck?: boolean
checkKeys?: boolean

the serializer will check if keys are valid.

collation?: CollationOptions

Specifies a collation

comment?: string | Document

A user-provided comment to attach to this command

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

hint?: string | Document

Specify that the update query should only consider plans using the hinted index

ignoreUndefined?: boolean

serialize will not emit undefined fields (default:true)

let?: Document

Map of parameter names and values that can be accessed using $$var (requires MongoDB 5.0).

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

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

readPreference?: ReadPreferenceLike

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

retryWrites?: boolean

Should retry failed writes

serializeFunctions?: boolean

serialize the javascript functions (default:false).

session?: ClientSession

Specify ClientSession for this command

upsert?: boolean

When true, creates a new document if no document matches the query

willRetryWrites?: boolean

Write Concern as an object

Generated using TypeDoc