FindOptions Structure Reference


                    
                    
                    allowDiskUse

Enables the server to write to temporary files. When set to true, the find operation can write data to the _tmp subdirectory in the dbPath directory. This helps prevent out-of-memory failures server side when working with large result sets.

Note

This option is only supported in MongoDB 4.4+. Specifying it against earlier versions of the server will result in an error.

Declaration

Swift

public var allowDiskUse: Bool?

Show on GitHub


                    
                    
                    allowPartialResults

Get partial results from a mongos if some shards are down (instead of throwing an error).

Declaration

Swift

public var allowPartialResults: Bool?

Show on GitHub


                    
                    
                    batchSize

The number of documents to return per batch.

Declaration

Swift

public var batchSize: Int?

Show on GitHub


                    
                    
                    collation

Specifies a collation.

Declaration

Swift

public var collation: BSONDocument?

Show on GitHub


                    
                    
                    comment

Attaches a comment to the query.

Declaration

Swift

public var comment: String?

Show on GitHub


                    
                    
                    cursorType

Indicates the type of cursor to use. This value includes both the tailable and awaitData options.

Declaration

Swift

public var cursorType: MongoCursorType? { get set }

Show on GitHub


                    
                    
                    hint

A hint for the index to use.

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


                    
                    
                    limit

The maximum number of documents to return.

Declaration

Swift

public var limit: Int?

Show on GitHub

max

The exclusive upper bound for a specific index.

Declaration

Swift

public var max: BSONDocument?

Show on GitHub


                    
                    
                    maxAwaitTimeMS

The maximum amount of time, in milliseconds, for the server to wait on new documents to satisfy a tailable cursor query. This only applies when used with MongoCursorType.tailableAwait. Otherwise, this option is ignored.

Declaration

Swift

public var maxAwaitTimeMS: Int?

Show on GitHub


                    
                    
                    maxTimeMS

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

Declaration

Swift

public var maxTimeMS: Int?

Show on GitHub

min

The inclusive lower bound for a specific index.

Declaration

Swift

public var min: BSONDocument?

Show on GitHub


                    
                    
                    noCursorTimeout

The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. Set this option to prevent that.

Declaration

Swift

public var noCursorTimeout: Bool?

Show on GitHub


                    
                    
                    projection

Limits the fields to return for all matching documents.

Declaration

Swift

public var projection: BSONDocument?

Show on GitHub


                    
                    
                    readConcern

A ReadConcern to use for this operation.

Declaration

Swift

public var readConcern: ReadConcern?

Show on GitHub


                    
                    
                    readPreference

A ReadPreference to use for this operation.

Declaration

Swift

public var readPreference: ReadPreference?

Show on GitHub


                    
                    
                    returnKey

If true, returns only the index keys in the resulting documents.

Declaration

Swift

public var returnKey: Bool?

Show on GitHub


                    
                    
                    showRecordID

Determines whether to return the record identifier for each document. If true, adds a field $recordId to the returned documents.

Declaration

Swift

public var showRecordID: Bool?

Show on GitHub


                    
                    
                    skip

The number of documents to skip before returning.

Declaration

Swift

public var skip: Int?

Show on GitHub


                    
                    
                    sort

The order in which to return matching documents.

Declaration

Swift

public var sort: BSONDocument?

Show on GitHub


                    
                    
                    init(allowDiskUse:allowPartialResults:batchSize:collation:comment:cursorType:hint:let:limit:max:maxAwaitTimeMS:maxTimeMS:min:noCursorTimeout:projection:readConcern:readPreference:returnKey:showRecordID:skip:sort:)

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

Declaration

Swift

public init(
    allowDiskUse: Bool? = nil,
    allowPartialResults: Bool? = nil,
    batchSize: Int? = nil,
    collation: BSONDocument? = nil,
    comment: String? = nil,
    cursorType: MongoCursorType? = nil,
    hint: IndexHint? = nil,
    `let`: BSONDocument? = nil,
    limit: Int? = nil,
    max: BSONDocument? = nil,
    maxAwaitTimeMS: Int? = nil,
    maxTimeMS: Int? = nil,
    min: BSONDocument? = nil,
    noCursorTimeout: Bool? = nil,
    projection: BSONDocument? = nil,
    readConcern: ReadConcern? = nil,
    readPreference: ReadPreference? = nil,
    returnKey: Bool? = nil,
    showRecordID: Bool? = nil,
    skip: Int? = nil,
    sort: BSONDocument? = nil
)

Show on GitHub