ClientSessionOptions Structure Reference


                    
                    
                    causalConsistency

Whether to enable causal consistency for this session. By default, if snapshot is not set to true, then causal consistency is enabled. Note that setting this option to true is incompatible with setting snapshot to true.

Declaration

Swift

public var causalConsistency: Bool?

Show on GitHub


                    
                    
                    defaultTransactionOptions

The default TransactionOptions to use for transactions started on this session.

These may be overridden by options provided directly to ClientSession.startTransaction.

If this option is not specified, the options will be inherited from the client that started this session where applicable (e.g. write concern).

Declaration

Swift

public var defaultTransactionOptions: TransactionOptions?

Show on GitHub


                    
                    
                    snapshot

If true, then all reads performed using this session will read from the same snapshot. This option defaults to false.

Note that setting this option to true is incompatible with setting causalConsistency to true.

Declaration

Swift

public var snapshot: Bool?

Show on GitHub


                    
                    
                    init(causalConsistency:defaultTransactionOptions:snapshot:)

Convenience initializer allowing any/all parameters to be omitted.

Declaration

Swift

public init(
    causalConsistency: Bool? = nil,
    defaultTransactionOptions: TransactionOptions? = nil,
    snapshot: Bool? = nil
)

Show on GitHub