ReadPreference
public final class ReadPreference
A class to represent a MongoDB read preference.
-
An enumeration of possible ReadPreference modes.
See moreDeclaration
Swift
public enum Mode : String
-
The mode of this
ReadPreference
Declaration
Swift
public var mode: Mode { get }
-
The tags of this
ReadPreference
Declaration
Swift
public var tagSets: [Document] { get }
-
The maxStalenessSeconds of this
ReadPreference
Declaration
Swift
public var maxStalenessSeconds: Int64? { get }
-
Initializes a
ReadPreference
.Throws
Throws:
- A
UserError.invalidArgumentError
ifmode
is.primary
andtagSets
is non-empty - A
UserError.invalidArgumentError
ifmaxStalenessSeconds
non-nil and < 90
Declaration
Parameters
mode
a
Mode
tagSets
an optional
[Document]
maxStalenessSeconds
an optional
Int64
Return Value
a new
ReadPreference
- A
-
Initializes a new
ReadPreference
by copying an existingReadPreference
.Declaration
Swift
public init(from readPreference: ReadPreference)
-
Declaration
Swift
public static func == (lhs: ReadPreference, rhs: ReadPreference) -> Bool