MongoConnectionString

public struct MongoConnectionString : Codable, LosslessStringConvertible

Represents a MongoDB connection string.

See also

https://docs.mongodb.com/manual/reference/connection-string/
Show on GitHub

  • Represents a connection string scheme.

    See more

    Declaration

    Swift

    public struct Scheme : LosslessStringConvertible, Equatable
    Show on GitHub

  • A struct representing a host identifier, consisting of a host and an optional port. In standard connection strings, this describes the address of a mongod or mongos to connect to. In mongodb+srv connection strings, this describes a DNS name to be queried for SRV and TXT records.

    See more

    Declaration

    Swift

    public struct HostIdentifier : Equatable, CustomStringConvertible
    Show on GitHub

  • Parses a new MongoConnectionString instance from the provided string.

    Throws

    Declaration

    Swift

    public init(string input: String) throws
    Show on GitHub

  • Updates this MongoConnectionString to incorporate options specified in the provided MongoClientOptions. If the same option is specified in both, the option in the MongoClientOptions takes precedence.

    Throws

    Declaration

    Swift

    public mutating func applyOptions(_ options: MongoClientOptions) throws
    Show on GitHub

  • Codable conformance

    Declaration

    Swift

    public func encode(to encoder: Encoder) throws
    Show on GitHub

  • Declaration

    Swift

    public init(from decoder: Decoder) throws
    Show on GitHub

  • LosslessStringConvertible protocol requirements

    Declaration

    Swift

    public init?(_ description: String)
    Show on GitHub

  • Declaration

    Swift

    public var description: String { get }
    Show on GitHub

  • Specifies the format this connection string is in.

    Declaration

    Swift

    public var scheme: Scheme
    Show on GitHub

  • Specifies one or more host/ports to connect to.

    Declaration

    Swift

    public var hosts: [HostIdentifier]
    Show on GitHub

  • The default database to use for authentication if an authSource is unspecified in the connection string. Defaults to “admin” if unspecified.

    Declaration

    Swift

    public var defaultAuthDB: String?
    Show on GitHub

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

    See also

    https://docs.mongodb.com/manual/reference/connection-string/#urioption.appName

    Declaration

    Swift

    public var appName: String?
    Show on GitHub

  • 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.

    See also

    https://docs.mongodb.com/manual/reference/connection-string/#urioption.compressors

    Declaration

    Swift

    public var compressors: [Compressor]?
    Show on GitHub

  • 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

  • Specifies the authentication credentials.

    Declaration

    Swift

    public var credential: MongoCredential?
    Show on GitHub

  • Specifies whether the client should 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

  • Specifies 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

  • Specifies whether the driver is connecting to a load balancer.

    Declaration

    Swift

    public var loadBalanced: Bool?
    Show on GitHub

  • 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

  • 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

  • Specifies a ReadConcern to use for the client.

    Declaration

    Swift

    public var readConcern: ReadConcern?
    Show on GitHub

  • Specifies a ReadPreference to use for the client.

    Declaration

    Swift

    public var readPreference: ReadPreference?
    Show on GitHub

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

    Declaration

    Swift

    public var replicaSet: String?
    Show on GitHub

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

    Declaration

    Swift

    public var retryReads: Bool?
    Show on GitHub

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

    Declaration

    Swift

    public var retryWrites: Bool?
    Show on GitHub

  • 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

  • Specifies how long the driver to attempt to send or receive on a socket before timing out.

    Note

    This option only applies to application operations, not server monitoring checks.

    Declaration

    Swift

    public var socketTimeoutMS: Int?
    Show on GitHub

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

    Declaration

    Swift

    public var srvMaxHosts: Int?
    Show on GitHub

  • Specifies the service name to use for SRV lookup during initial DNS seedlist discovery and SRV polling.

    Declaration

    Swift

    public var srvServiceName: String?
    Show on GitHub
  • tls

    Specifies 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

  • Specifies 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

  • Specifies 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

  • 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

  • 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

  • Specifies the password to de-crypt the tlsCertificateKeyFile.

    Declaration

    Swift

    public var tlsCertificateKeyFilePassword: String?
    Show on GitHub

  • Specifies whether 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.

    Declaration

    Swift

    public var tlsDisableCertificateRevocationCheck: Bool?
    Show on GitHub

  • Specifies whether 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

  • Specifies whether 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.

    Declaration

    Swift

    public var tlsInsecure: Bool?
    Show on GitHub

  • Specifies a WriteConcern to use for the client.

    Declaration

    Swift

    public var writeConcern: WriteConcern?
    Show on GitHub