接続オプション
Overview
このガイドでは、MongoDB の接続および認証オプションについて学習できます。 接続string Clientのパラメーターとして接続オプションを設定して、サーバーに接続するときに {0 インスタンスの動作を指定できます。
オプション名 | 許容値 | デフォルト値 | 説明 |
|---|---|---|---|
appName | 文字列 | なし | Specifies the application name that the Client instance sends
to the server as part of the handshake.Specifying an appName can help you use the server logs to
determine which Client instance is connected to the server. |
authMechanism | 文字列 | なし | 使用する認証メカニズムを指定します。 このオプションを指定しない場合、ドライバーはデフォルトの認証メカニズムを使用します。 Rust ドライバーでの認証の詳細については、「 認証メカニズム に関するガイドを参照してください。 |
authMechanismProperties | 文字列 | なし |
|
authSource | 文字列 | 説明を参照してください | Specifies the database used to authenticate. This option defaults to admin for SCRAM-based authentication mechanisms,
$external for the MONGODB-X509 mechanism, and the database name or
$external for the PLAIN mechanism. |
compressors | 文字列のコンマ区切りリスト | なし |
|
connectTimeoutMS | Non-negative integer |
| サーバーに接続するときに、基礎の各 TCP ストリームに渡される接続タイムアウトをミリ秒単位で指定します。 |
directConnection | ブール値 |
|
|
heartbeatFrequencyMS | 500 以上の整数 |
| 各監視スレッドがサーバー チェックの実行間で待機する時間をミリ秒単位で指定します。 |
journal | ブール値 |
| 操作がディスク上のジャーナルに伝達されたことの確認を要求します。 |
localThresholdMS | Non-negative integer | 15 | Specifies the amount of time in milliseconds that the average
round-trip time between the driver and server can last
compared to the shortest round-trip time of all the suitable servers. A value of 0 indicates that there is no latency window, so
only the server with the lowest average round-trip time is
eligible. |
maxIdleTimeMS | Non-negative integer | 0 | Specifies the amount of time in milliseconds that a connection
can remain idle in a connection pool the server closes it. A value of 0 indicates that the client does not close idle
connections. |
maxStalenessSeconds |
|
| Specifies the maximum lag, in seconds, behind the primary node
that a secondary node can be to be considered for the given operation. The value of this option must be at least 90, or the
operation raises an error. A value of -1 means there is no
maximum lag. |
maxPoolSize | Non-negative integer |
| Specifies the maximum number of connections that the Client
instance can create in a connection pool for a given server.If you attempt an operation while the value of maxPoolSize
connections are checked out, the operation waits until an
in-progress operation finishes and the connection returns to the pool. |
minPoolSize | Non-negative integer |
| Specifies the minimum number of connections that are available in
a server's connection pool at a given time. If fewer than minPoolSize connections are in the pool,
the server adds connections in the background up to the value of minPoolSize. |
readConcernLevel | 文字列 | なし |
|
readPreference | 文字列 |
| ドライバーが読み取り操作をレプリカセットのノードにルーティングする方法を指定します。 詳細については、サーバー マニュアルの「読み込み設定」を参照してください。 |
readPreferenceTags | キーと値のペアをコンマで区切ったリスト | なし | どのレプリカセット ノードを操作の対象にするかを指定します。 このキーの各インスタンスは、個別のタグ セットです。 ドライバーは、セット内の各タグを持つ 1 つまたは複数のサーバーを見つけるまで、各タグセットをチェックします。 |
replicaSet | 文字列 | なし |
|
retryReads | ブール値 |
| 操作が失敗した場合にクライアントが読み取り操作を再試行するかどうかを指定します。 |
serverSelectionTimeoutMS | Non-negative integer |
|
|
tls | ブール値 |
| サーバーとの接続で使用する |
tlsAllowInvalidCertificates | ブール値 |
| Specifies whether the Client instance returns an error if the
server presents an invalid certificate.We recommend that you set this option to true only in
testing environments to avoid creating vulnerabilities in your
application. |
tlsCAFile | 文字列 | 説明を参照してください | Specifies the path to the certificate authority (CA) file that
the Client instance uses for TLS.If you do not specify this option, the driver uses the Mozilla
root certificates from the webpki-roots crate. |
tlsCertificateKeyFile | 文字列 | なし | Specifies the path to the certificate file that the Client
instance presents to the server to verify its identify.If you do not set this option, the Client instance does not
attempt to verify its identity to the server. |
tlsInsecure | ブール値 |
| Specifies whether the Client instance returns an error if the
server presents an invalid certificate.We recommend that you set this option to true only in
testing environments to avoid creating vulnerabilities in your
application. |
w | 負でない整数または文字列 | なし | Requests acknowledgment that the operation has propagated to a
specific number or variety of servers. To learn more, see Write Concern in the Server manual. |
wTimeoutMS | Non-negative integer | タイムアウトなし | 書込み保証 (write concern) の時間制限をミリ秒単位で指定します。 制限時間内に操作が要求されたレベルに伝達されなかった場合、ドライバーはエラーを発生させます。 |
zlibCompressionLevel | -1 から 9 までの整数 |
| Specifies the level field of the zlib compression if you use that compressor.Setting a value of -1 selects the default compression level (6).Setting a value of 0 specifies no compression, and setting
a value of 9 specifies maximum compression.To learn more about network compression, see the Network Compression guide. |
接続オプションの完全なリストを表示するには、サーバー マニュアル エントリの「接続stringオプション 」セクションにアクセスしてください。