连接选项
本节介绍 .NET/C# 驱动程序支持的 MongoDB 连接和身份验证选项。您可以使用连接 URI 或 MongoClientSettings
对象配置连接。
使用连接 URI
如果将连接 URI 传递给 MongoClient
构造函数,则可以将连接选项作为 <name>=<value>
对包含在字符串中。在以下示例中,连接 URI 包含值为 60000
的 connectTimeoutMS
选项和值为 true
的 tls
选项:
using MongoDB.Driver; // Sets the connection URI const string connectionUri = "mongodb+srv://sample.host:27017/?connectTimeoutMS=60000&tls=true"; // Creates a new client and connects to the server var client = new MongoClient(connectionUri);
运用 MongoClientSettings
您可以使用 MongoClientSettings
对象在代码中(而不是在连接 URI 中)配置连接设置。以这种方式配置连接可以更轻松地在运行时更改设置,帮助您在编译期间捕获错误,并提供比连接 URI 更多的配置选项。
要使 用 MongoClientSettings
对象,请创建该类的实例,设置其属性,并将其作为参数传递给 MongoClient
构造函数:
//const string connectionUri = "mongodb+srv://sample.host:27017/?connectTimeoutMS=60000&tls=true"; // Creates a MongoClientSettings object var settings = new MongoClientSettings() { Scheme = ConnectionStringScheme.MongoDBPlusSrv, Server = new MongoServerAddress("sample.host", 27017), ConnectTimeout = new TimeSpan(0, 0, 60), UseTls = true }; // Creates a new client and connects to the server var client = new MongoClient(settings);
连接选项
下表列出了 MongoClientSettings
类中可用的每个连接选项,以及如何在连接字符串中实现相同的结果(如可能)。如果 MongoClientSettings
属性映射到连接字符串中的多个选项,则连接 URI 示例将显示所有相关选项。
注意
如果将查询参数用于时间段,其值必须以毫秒为单位。例如,要指定 60 秒,请使用值 60000
。如果将 MongoClientSettings
对象用于时间段,请使用相应的 TimeSpan
值。
MongoClientSettings 属性 | 说明 | |||
---|---|---|---|---|
AllowInsecureTls | Specifies whether to relax TLS constraints as much as possible. This can include allowing invalid certificates or hostname mismatches. If this property is set to true and SslSettings.CheckCertificateRevocation is set to false , the .NET/C# Driver will throw an exception.Data Type: boolean Default: false Connection URI Example: tlsInsecure=true | |||
ApplicationName | The app name the driver passes to the server in the client metadata as part of the connection handshake. The server prints this value to the MongoDB logs once the connection is established. The value is also recorded in the slow query logs and profile collections. Data Type: string Default: null Connection URI Example: appName=yourApp | |||
AutoEncryptionOptions | Settings for automatic client-side encryption. Data Type: AutoEncryptionOptions Default: null Connection URI Example: N/A | |||
ClusterConfigurator | Low-level configuration options for sockets, TLS, cluster, and others. Data Type: Action<ClusterBuilder> Default: null Connection URI Example: N/A | |||
compressors | The preferred compression types, in order, for wire-protocol messages sent to or received from the server. The driver uses the first of these compression types that the server supports. Data Type: CompressorConfiguration Default: null Connection URI Example: compressors=snappy,zstd | |||
ConnectTimeout | The length of time the driver tries to establish a single TCP socket connection to the server before timing out. DataType: TimeSpan Default: 30 seconds Connection URI Example: connectTimeoutMS=0 | |||
凭证 | Settings for how the driver authenticates to the server. This includes authentication credentials, mechanism, source, and other settings. If you don't specify an authentication mechanism, the driver uses either SCRAM-SHA-1 or SCRAM-SHA-256 , depending on the server version. Seeauthentication mechanisms for available authentication mechanisms. Data Type: MongoCredential Default: null Connection URI Example:
| |||
DirectConnection | Specifies whether to force dispatch all operations to the host. If you specify this option, the driver doesn't accept the You must use the standard connection URI format instead. This property must be set to false if you specify more than onehost name. Data Type: boolean Default: false Connection URI Example: directConnection=true | |||
HeartbeatInterval | The interval between regular server-monitoring checks. Must be greater than or equal to 500 milliseconds. Data Type: TimeSpan Default: 10 seconds Connection URI Example: heartbeatFrequencyMS=5000 | |||
HeartbeatTimeout | The length of time a monitoring socket can be idle before timing out. Data Type: TimeSpan Default: Same value as ConnectTimeout Connection URI Example: heartbeatTimeoutMS=5000 | |||
IPv6 | Specifies whether the host address is in IPv6 format. Data Type: boolean Default: false Connection URI Example: ipv6=true | |||
IsFrozen | Indicates whether the settings have been frozen. Frozen settings can't be changed. This option is read-only. Data Type: boolean Default: false Connection URI Example: N/A | |||
LinqProvider | ||||
LoadBalanced | Specifies whether the driver is connecting to a load balancer. You can set this property to true only if:
Data Type: boolean Default: false Connection URI Example: loadBalanced=true | |||
LocalThreshold | The latency window for server eligibility. If a server's round trip takes longer than the fastest server's round-trip time plus this value, the server isn't eligible for selection. Data Type: TimeSpan Default: 15 milliseconds Connection URI Example: localThresholdMS=0 | |||
LoggingSettings | ||||
MaxConnecting | The greatest number of connections a driver's connection pool may be establishing concurrently. Data Type: integer Default: 2 Connection URI Example: maxConnecting=3 | |||
MaxConnectionIdleTime | The length of time a connection can be idle before the driver closes it. Data Type: TimeSpan Default: 10 minutes Connection URI Example: maxIdleTimeMS=300000 | |||
MaxConnectionLifeTime | The length of time a connection can be pooled before expiring. Data Type: TimeSpan Default: 30 minutes Connection URI Example: maxLifetimeMS=50000 | |||
MaxConnectionPoolSize | The greatest number of clients or connections the driver can create in its connection pool. This count includes connections in use. Data Type: integer Default: 100 Connection URI Example: maxPoolSize=150 | |||
MinConnectionPoolSize | The number of connections the driver should create and keep in the connection pool even when no operations are occurring. This count includes connections in use. Data Type: integer Default: 0 Connection URI Example: minPoolSize=1 | |||
readConcern | The client's default read concern. See read concern for more information. Data Type: ReadConcern Default: ReadConcern.Default Connection URI Example: readConcernLevel=local | |||
ReadEncoding | The UTF-8 encoding to use for string deserialization. Strict encoding will throw an exception when an invalid UTF-8 byte sequence is encountered. Data Type: UTF8Encoding Default: Strict encoding Connection URI Example: N/A | |||
读取偏好 | The client's default read-preference settings. MaxStaleness represents thelongest replication lag, in wall-clock time, that a secondary can experience and still be eligible for server selection. Specifying -1 means no maximum.See read preference for more information. Data Type: ReadPreference Default: ReadPreference.Primary Connection URI Example:
You can include the readPreferenceTags parameter in the connection URI more
than once. If you do, the client treats each instance as a separate tag set.
The order of the tags in the URI determines the order for read preference. You can
use this parameter only if the read-preference mode is not primary . | |||
ReplicaSetName | The name of the replica set to connect to. Data Type: string Default: null Connection URI Example: replicaSet=yourReplicaSet | |||
retryReads | Enables retryable reads. Data Type: boolean Default: true Connection URI Example: retryReads=false | |||
retryWrites | Enables retryable writes. Data Type: boolean Default: true Connection URI Example: retryWrites=false | |||
有关 | Specifies whether to use the standard connection string format ( MongoDB )or the DNS seed list format ( MongoDBPlusSrv ).See the MongoDB Manual for more information about connection string formats. If the DirectConnection property is set to true and youtry to use the DNS seed list format, the .NET/C# Driver will throw an exception. Data Type: ConnectionStringScheme Default: ConnectionStringScheme.MongoDB Connection URI Example: mongodb+srv:// | |||
服务器 | The host and port number where MongoDB is running. Data Type: MongoServerAddress Default: localhost:27017 Connection URI Example: mongodb://sample.host:27017 | |||
ServerApi | Allows opting into Stable API versioning. See the MongoDB Manual for more information about Stable API versioning. Data Type: ServerApi Default: null Connection URI Example: N/A | |||
serverMonitoringMode | Specifies the server monitoring protocol to use. When this option is set to Auto , the monitoring mode is determinedby the environment in which the driver is running. The driver uses polling mode in function-as-a-service (FaaS) environments, such as AWS Lambda, and the streaming mode in other environments. Data Type: ServerMonitoringMode Default: Auto Connection URI Example: serverMonitoringMode=poll | |||
服务器 | The cluster members where MongoDB is running. Data Type: IEnumerable<MongoServerAddress> Default: localhost:27017 Connection URI Example: mongodb://sample.host1:27017,sample.host2:27017 | |||
ServerSelectionTimeout | The length of time the driver tries to select a server before timing out. Data Type: TimeSpan Default: 30 seconds Connection URI Example: serverSelectionTimeoutMS=15000 | |||
SocketTimeout | The length of time the driver tries to send or receive on a socket before timing out. Data Type: TimeSpan Default: OS default Connection URI Example: socketTimeoutMS=0 | |||
SrvMaxHosts | The greatest number of SRV results to randomly select when initially populating the seedlist or, during SRV polling, adding new hosts to the topology. You can use this property only if the connection-string scheme is set to ConnectionStringScheme.MongoDBPlusSrv . You cannot use it when connectingto a replica set. Data Type: integer Default: 0 Connection URI Example: srvMaxHosts=3 | |||
SslSettings | TLS/SSL options, including client certificates, revocation handling, and enabled and disabled TLS/SSL protocols. If SslSettings.CheckCertificateRevocation is set to false andAllowInsecureTls is set to true , the .NET/C# Driver will throwan exception. Data Type: SslSettings Default: null Connection URI Example: tlsDisableCertificateRevocationCheck=false | |||
UseTls | Specifies whether to require TLS for connections to the server. If you use a scheme of "mongodb+srv" or specify other TLS options,this option defaults to true .Data Type: boolean Default: false Connection URI Example: tls=true | |||
WaitQueueTimeout | The length of time the driver tries to check out a connection from a server's connection pool before timing out. Data Type: TimeSpan Default: 2 minutes Connection URI Example: waitQueueTimeoutMS=0 | |||
writeConcern | The default write-concern settings, including write timeout and journaling, for the client. See write concern for more information. Data Type: WriteConcern Default: WriteConcern.Acknowledged Connection URI Example: w=majority&wTimeoutMS=0&journal=true | |||
WriteEncoding | Specifies whether UTF-8 string serialization is strict or lenient. With strict encoding, the driver will throw an exception when it encounters an invalid UTF-8 byte sequence. Data Type: UTF8Encoding Default: Strict encoding Connection URI Example: N/A |