MongoClientOptions Structure Reference


                    
                    
                    appName

Specifies a custom app name. This value is used in MongoDB logs and profiling data.

Declaration

Swift

public var appName: String?

Show on GitHub


                    
                    
                    compressors

Specifies one or more compressors to use for network compression for communication between this client and mongod/mongos instances. Currently, the driver only supports compression via zlib.

Declaration

Swift

public var compressors: [Compressor]?

Show on GitHub


                    
                    
                    connectTimeoutMS

Specifies the maximum time, in milliseconds, for an individual connection to establish a TCP connection to a MongoDB server before timing out.

Declaration

Swift

public var connectTimeoutMS: Int?

Show on GitHub


                    
                    
                    credential

Specifies authentication options for use with the client.

Declaration

Swift

public var credential: MongoCredential?

Show on GitHub


                    
                    
                    dataCodingStrategy

Specifies the DataCodingStrategy to use for BSON encoding/decoding operations performed by this client and any databases or collections that derive from it.

Declaration

Swift

public var dataCodingStrategy: DataCodingStrategy?

Show on GitHub


                    
                    
                    dateCodingStrategy

Specifies the DateCodingStrategy to use for BSON encoding/decoding operations performed by this client and any databases or collections that derive from it.

Declaration

Swift

public var dateCodingStrategy: DateCodingStrategy?

Show on GitHub


                    
                    
                    directConnection

When true, the client will connect directly to a single host. When false, the client will attempt to automatically discover all replica set members if a replica set name is provided. Defaults to false. It is an error to set this option to true when used with a mongodb+srv connection string or when multiple hosts are specified in the connection string.

Declaration

Swift

public var directConnection: Bool?

Show on GitHub


                    
                    
                    heartbeatFrequencyMS

Controls how often the driver checks the state of the MongoDB deployment. Specifies the interval (in milliseconds) between checks, counted from the end of the previous check until the beginning of the next one. Defaults to 10 seconds (10,000 ms). Must be at least 500ms.

Declaration

Swift

public var heartbeatFrequencyMS: Int?

Show on GitHub


                    
                    
                    loadBalanced

Indicates whether the driver is connecting to a load balancer.

Declaration

Swift

public var loadBalanced: Bool?

Show on GitHub


                    
                    
                    localThresholdMS

The size (in milliseconds) of the permitted latency window beyond the fastest round-trip time amongst all servers. By default, only servers within 15ms of the fastest round-trip time receive queries.

Declaration

Swift

public var localThresholdMS: Int?

Show on GitHub


                    
                    
                    maxPoolSize

The maximum number of connections that may be associated with a connection pool created by this client at a given time. This includes in-use and available connections. Defaults to 100.

Declaration

Swift

public var maxPoolSize: Int?

Show on GitHub


                    
                    
                    readConcern

Specifies a ReadConcern to use for the client.

Declaration

Swift

public var readConcern: ReadConcern?

Show on GitHub


                    
                    
                    readPreference

Specifies a ReadPreference to use for the client.

Declaration

Swift

public var readPreference: ReadPreference?

Show on GitHub


                    
                    
                    replicaSet

Specifies the name of the replica set the driver should connect to.

Declaration

Swift

public var replicaSet: String?

Show on GitHub


                    
                    
                    retryReads

Determines whether the client should retry supported read operations (on by default).

Declaration

Swift

public var retryReads: Bool?

Show on GitHub


                    
                    
                    retryWrites

Determines whether the client should retry supported write operations (on by default).

Declaration

Swift

public var retryWrites: Bool?

Show on GitHub


                    
                    
                    serverAPI

Specifies a MongoDB server API version and related options.

Declaration

Swift

public var serverAPI: MongoServerAPI?

Show on GitHub


                    
                    
                    serverSelectionTimeoutMS

Specifies how long the driver should attempt to select a server for before throwing an error. Defaults to 30 seconds (30000 ms).

Declaration

Swift

public var serverSelectionTimeoutMS: Int?

Show on GitHub


                    
                    
                    srvMaxHosts

The maximum number of SRV results to randomly select when initially populating the seedlist or, during SRV polling, adding new hosts to the topology.

Declaration

Swift

public var srvMaxHosts: Int?

Show on GitHub


                    
                    
                    srvServiceName

The service name to use for SRV lookup. Must be a valid SRV service name according to RFC 6335. -SeeAlso: https://datatracker.ietf.org/doc/html/rfc6335#section-5.1

Declaration

Swift

public var srvServiceName: String?

Show on GitHub


                    
                    
                    threadPoolSize

MongoSwift.MongoClient provides an asynchronous API by running all blocking operations off of their originating threads in a thread pool. MongoSwiftSync.MongoClient is implemented as a wrapper of the async client which waits for each corresponding asynchronous operation to complete and then returns the result. This option specifies the size of the thread pool used by the asynchronous client, and determines the max number of concurrent operations that may be performed using a single client. Defaults to 5.

Declaration

Swift

public var threadPoolSize: Int?

Show on GitHub

tls

Whether or not to require TLS for connections to the server. By default this is set to false.

Note

Specifying any other “tls”-prefixed option will require TLS for connections to the server.

Declaration

Swift

public var tls: Bool?

Show on GitHub


                    
                    
                    tlsAllowInvalidCertificates

Indicates whether to bypass validation of the certificate presented by the mongod/mongos instance. By default this is set to false.

Declaration

Swift

public var tlsAllowInvalidCertificates: Bool?

Show on GitHub


                    
                    
                    tlsAllowInvalidHostnames

Indicates whether to disable hostname validation for the certificate presented by the mongod/mongos instance. By default this is set to false.

Declaration

Swift

public var tlsAllowInvalidHostnames: Bool?

Show on GitHub


                    
                    
                    tlsCAFile

Specifies the location of a local .pem file that contains the root certificate chain from the Certificate Authority. This file is used to validate the certificate presented by the mongod/mongos instance.

Declaration

Swift

public var tlsCAFile: URL?

Show on GitHub


                    
                    
                    tlsCertificateKeyFile

Specifies the location of a local .pem file that contains either the client’s TLS certificate or the client’s TLS certificate and key. The client presents this file to the mongod/mongos instance.

Declaration

Swift

public var tlsCertificateKeyFile: URL?

Show on GitHub


                    
                    
                    tlsCertificateKeyFilePassword

Specifies the password to de-crypt the tlsCertificateKeyFile.

Declaration

Swift

public var tlsCertificateKeyFilePassword: String?

Show on GitHub


                    
                    
                    tlsDisableCertificateRevocationCheck

Indicates if revocation checking (CRL / OCSP) should be disabled. On macOS, this setting has no effect. By default this is set to false. It is an error to specify both this option and tlsDisableOCSPEndpointCheck, either via this options struct, connection string, or a combination of both.

Declaration

Swift

public var tlsDisableCertificateRevocationCheck: Bool?

Show on GitHub


                    
                    
                    tlsDisableOCSPEndpointCheck

Indicates if OCSP responder endpoints should not be requested when an OCSP response is not stapled. On macOS, this setting has no effect. By default this is set to false.

Declaration

Swift

public var tlsDisableOCSPEndpointCheck: Bool?

Show on GitHub


                    
                    
                    tlsInsecure

When specified, TLS constraints will be relaxed as much as possible. Currently, setting this option to true is equivalent to setting tlsAllowInvalidCertificates, tlsAllowInvalidHostnames, and tlsDisableCertificateRevocationCheck to true. It is an error to specify both this option and any of the options enabled by it, either via this options struct, connection string, or a combination of both.

Declaration

Swift

public var tlsInsecure: Bool?

Show on GitHub


                    
                    
                    uuidCodingStrategy

Specifies the UUIDCodingStrategy to use for BSON encoding/decoding operations performed by this client and any databases or collections that derive from it.

Declaration

Swift

public var uuidCodingStrategy: UUIDCodingStrategy?

Show on GitHub


                    
                    
                    writeConcern

Specifies a WriteConcern to use for the client.

Declaration

Swift

public var writeConcern: WriteConcern?

Show on GitHub


                    
                    
                    init(appName:compressors:connectTimeoutMS:credential:dataCodingStrategy:dateCodingStrategy:directConnection:heartbeatFrequencyMS:loadBalanced:localThresholdMS:maxPoolSize:readConcern:readPreference:replicaSet:retryReads:retryWrites:serverAPI:serverSelectionTimeoutMS:srvMaxHosts:srvServiceName:threadPoolSize:tls:tlsAllowInvalidCertificates:tlsAllowInvalidHostnames:tlsCAFile:tlsCertificateKeyFile:tlsCertificateKeyFilePassword:tlsInsecure:uuidCodingStrategy:writeConcern:)

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

Declaration

Swift

public init(
    appName: String? = nil,
    compressors: [Compressor]? = nil,
    connectTimeoutMS: Int? = nil,
    credential: MongoCredential? = nil,
    dataCodingStrategy: DataCodingStrategy? = nil,
    dateCodingStrategy: DateCodingStrategy? = nil,
    directConnection: Bool? = nil,
    heartbeatFrequencyMS: Int? = nil,
    loadBalanced: Bool? = nil,
    localThresholdMS: Int? = nil,
    maxPoolSize: Int? = nil,
    readConcern: ReadConcern? = nil,
    readPreference: ReadPreference? = nil,
    replicaSet: String? = nil,
    retryReads: Bool? = nil,
    retryWrites: Bool? = nil,
    serverAPI: MongoServerAPI? = nil,
    serverSelectionTimeoutMS: Int? = nil,
    srvMaxHosts: Int? = nil,
    srvServiceName: String? = nil,
    threadPoolSize: Int? = nil,
    tls: Bool? = nil,
    tlsAllowInvalidCertificates: Bool? = nil,
    tlsAllowInvalidHostnames: Bool? = nil,
    tlsCAFile: URL? = nil,
    tlsCertificateKeyFile: URL? = nil,
    tlsCertificateKeyFilePassword: String? = nil,
    tlsInsecure: Bool? = nil,
    uuidCodingStrategy: UUIDCodingStrategy? = nil,
    writeConcern: WriteConcern? = nil
)

Show on GitHub