FindOneAndUpdateOptions Structure Reference


                    
                    
                    arrayFilters

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

Declaration

Swift

public var arrayFilters: [BSONDocument]?

Show on GitHub


                    
                    
                    bypassDocumentValidation

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

Declaration

Swift

public var bypassDocumentValidation: Bool?

Show on GitHub


                    
                    
                    collation

Specifies a collation to use.

Declaration

Swift

public var collation: BSONDocument?

Show on GitHub


                    
                    
                    hint

A document or string that specifies the index to use to support the query. Only supported in server 4.4+.

Declaration

Swift

public var hint: IndexHint?

Show on GitHub

let

Variables that can be accessed within the operation using the double dollar sign prefix in the form $$<variable_name>. This option is only available on MongoDB 5.0+.

Declaration

Swift

public var `let`: BSONDocument?

Show on GitHub


                    
                    
                    maxTimeMS

The maximum amount of time to allow the query to run.

Declaration

Swift

public var maxTimeMS: Int?

Show on GitHub


                    
                    
                    projection

Limits the fields to return for the matching document.

Declaration

Swift

public var projection: BSONDocument?

Show on GitHub


                    
                    
                    returnDocument

WhenReturnDocument.After, returns the updated or inserted document rather than the original.

Declaration

Swift

public var returnDocument: ReturnDocument?

Show on GitHub


                    
                    
                    sort

Determines which document the operation modifies if the query selects multiple documents.

Declaration

Swift

public var sort: BSONDocument?

Show on GitHub


                    
                    
                    upsert

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

Declaration

Swift

public var upsert: Bool?

Show on GitHub


                    
                    
                    writeConcern

An optional WriteConcern to use for the command.

Declaration

Swift

public var writeConcern: WriteConcern?

Show on GitHub


                    
                    
                    init(arrayFilters:bypassDocumentValidation:collation:hint:let:maxTimeMS:projection:returnDocument:sort:upsert:writeConcern:)

Convenience initializer allowing any/all parameters to be omitted/optional.

Declaration

Swift

public init(
    arrayFilters: [BSONDocument]? = nil,
    bypassDocumentValidation: Bool? = nil,
    collation: BSONDocument? = nil,
    hint: IndexHint? = nil,
    `let`: BSONDocument? = nil,
    maxTimeMS: Int? = nil,
    projection: BSONDocument? = nil,
    returnDocument: ReturnDocument? = nil,
    sort: BSONDocument? = nil,
    upsert: Bool? = nil,
    writeConcern: WriteConcern? = nil
)

Show on GitHub