接続オプション

minPoolSize

integer

1 つの接続プールにいつでも存在する必要がある接続の最小数を指定します。

デフォルト：0

maxPoolSize

integer

特定の時点で接続プールが持つことができる接続の最大数を指定します。

デフォルト：100

waitQueueTimeoutMS （非推奨）

integer

このオプションは非推奨です。このタイムアウトは、代わりにクライアントレベルのタイムアウトを設定することで構成できます。

接続が利用可能になるまで操作が待機できる最大待機時間（ミリ秒）。値が 0 の場合、制限がないことを意味します。

デフォルト: 120000 （120 秒）

serverSelectionTimeoutMS

integer

ドライバーが例外をスローする前に、サーバー選択が成功するまで待機する最大時間をミリ秒単位で指定します。

デフォルト: 30000 （30 秒）

localThresholdMS

integer

レプリカセット内の MongoDB の複数のインスタンスと通信する場合、ドライバーは、応答時間が最も短いサーバーとローカルしきい値（ミリ秒単位）以下のサーバーにのみリクエストを送信します。

デフォルト：15

heartbeatFrequencyMS

integer

ドライバーがクラスター内の各サーバーの現在の状態を決定するために待機する頻度をミリ秒単位で指定します。

デフォルト: 10000 （10 秒）

replicaSet

string

提供された接続stringに複数のホストを含めることを指定します。 指定すると、ドライバーはそのセットのすべてのメンバーを検索しようとします。

デフォルト：null

ssl

ブール値

MongoDB インスタンスとのすべての通信で TLS/SSL を使用することを指定します。 tlsオプションによって置き換えられます。

デフォルト：false

tls

ブール値

MongoDB インスタンスとのすべての通信で TLS を使用することを指定します。 sslオプションを置き換えます。

デフォルト：false

tlsInsecure

ブール値

ドライバーが TLS 接続の無効なホスト名を許可することを指定します。 tlsAllowInvalidHostnamesをtrueに設定するのと同じ効果があります。 TLS セキュリティ制約を他の方法で構成するには、カスタム SSLContext を使用します。

デフォルト：false

tlsAllowInvalidHostnames

ブール値

ドライバーが TLS 接続の証明書で無効なホスト名を許可することを指定します。 sslInvalidHostNameAllowed をスーパー優先します。

デフォルト：false

connectTimeoutMS

integer

Kotlin ドライバーがタイムアウトする前に接続が開くまで待機する最大時間をミリ秒単位で指定します。 値が0の場合、接続が開かれるまで待機している間はタイムアウトしないようにドライバーに指示します。

デフォルト: 10000 （10 秒）

socketTimeoutMS （非推奨）

integer

このオプションは非推奨です。このタイムアウトは、代わりにクライアントレベルのタイムアウトを設定することで構成できます。

Kotlinドライバーがタイムアウトする前にリクエストの送信または受信を待機する最大時間（ミリ秒単位）。値が 0 の場合、リクエストの送信または受信を待機している間にタイムアウトしないようにドライバーに指示します。

デフォルト：0

maxIdleTimeMS

integer

ドライバーが接続を閉じる前にプールされた接続がアイドル状態になることを許可する最大時間をミリ秒単位で指定します。値が 0 の場合、ドライバーがプールされた接続をアイドル状態にできる時間に上限がないことを示します。

この値は、アプリケーションの予想されるアイドル期間よりも高く、ファイアウォールまたはプロキシの接続タイムアウトよりは低く設定して、予期しない切断を防ぐために、

デフォルト：0

maxLifeTimeMS

integer

Kotlin ドライバーが接続を閉じる前にプールされた接続を引き続き使用する最大時間をミリ秒単位で指定します。 値が0の場合、ドライバーがプールされた接続を開いたままにできる時間に上限がないことを示します。

デフォルト：0

journal

ブール値

接続された MongoDB インスタンスがすべての書き込みに対してディスク上のジャーナル ファイルにグループ コミットするまで、ドライバーが待機する必要があることを指定します。

デフォルト：false

w

string or integer

書込み保証 (write concern) を指定します。 値の詳細については、 w オプション のサーバー ドキュメントを参照してください。

デフォルト：1

wTimeoutMS （非推奨）

integer

このオプションは非推奨です。このタイムアウトは、代わりにクライアントレベルのタイムアウトを設定することで構成できます。

Time limit, in milliseconds, for the write concern. For more information, see the server documentation for the wtimeoutMS option. A value of 0 instructs the driver to never time out write operations.

デフォルト：0

readPreference

string

Specifies the read preference. For more information on values, see the server documentation for the readPreference option.

デフォルト：primary

readPreferenceTags

string

読み込み設定（read preference）タグを指定します。 値の詳細については、 readPreferenceTags オプションのサーバー ドキュメントを参照してください。

デフォルト：null

maxStalenessSeconds

integer

Specifies, in seconds, how stale a secondary can be before the driver stops communicating with that secondary. The minimum value is either 90 seconds or the heartbeat frequency plus 10 seconds, whichever is greater. For more information, see the server documentation for the maxStalenessSeconds option. Not providing a parameter or explicitly specifying -1 indicates that there should be no staleness check for secondaries.

デフォルト：-1

authMechanism

string

認証情報が提供された場合にドライバーが使用する認証メカニズムを指定します。

Default: By default, the client picks the most secure mechanism available based on the server version. For possible values, see the server documentation for the authMechanism option.

authSource

string

提供された認証情報を検証するデータベースを指定します。

デフォルト：admin

authMechanismProperties

string

指定された認証メカニズムの認証プロパティを、プロパティと値をコロンで区切ったリストとして指定します。 詳細については、 authMechanismProperties オプション のサーバードキュメントを参照してください。

デフォルト：null

appName

string

接続ハンドシェイク中に MongoDB インスタンスに提供されるアプリケーションの名前を指定します。 サーバー ログとプロファイリングに使用できます。

デフォルト：null

compressors

string

接続された MongoDB インスタンスに送信されたリクエストを圧縮するためにドライバーが使用する 1 つ以上の圧縮アルゴリズムを指定します。 指定できる値は、 zlib 、 snappy 、 zstdです。

デフォルト：null

zlibCompressionLevel

integer

接続されたMongoDBインスタンスへのリクエストのサイズを減らすために、zlib が使用する圧縮の度合いを指定します。レベルの範囲は -1 から 9 で、値が低いほど圧縮が速く（ただし、リクエストが大きくなる）、値が大きい場合は圧縮が遅くなります（ただし、リクエストが少なくなります）。

デフォルト：null

retryWrites

ブール値

ネットワーク エラーが原因でサポートされている書込み (write) 操作が失敗した場合、ドライバーがサポートされている書込み (write) 操作を再試行する必要があることを指定します。

デフォルト：true

retryReads

ブール値

ネットワーク エラーが原因でサポートされている読み取り操作が失敗した場合、ドライバーがサポートされている読み取り操作を再試行する必要があることを指定します。

デフォルト：true

maxAdvancedRetrys

integer

再試行可能な過負荷エラー（つまり、SystemOverloadedError と RetryableError ラベルの両方を含むエラー）で失敗したコマンドをドライバーが再試行する最大回数を設定します。

このオプションは、retryWrites が true に設定されている場合にのみ適用され、retryReads が true に設定されている場合にのみ適用されます。値を 0 に設定すると、再試行可能な過負荷エラーの再試行が無効になります。

デフォルト:null 。このオプションが設定されていない場合、ドライバーは通常、値2 を適用します。

enableオーバーロードリターゲティング

ブール値

ドライバーが以前に過負荷エラーを返した場合、サーバー選択中にサーバーの優先順位を下げて、後続の再試行でサーバーの優先順位を下げる可能性があるかどうかを設定します。

このオプションは、retryReads が true に設定されている場合は読み取りに適用され、retryWrites が true に設定されている場合は書込みに適用されます。このオプションは、シャーディングされたクラスターには適用されません。

デフォルト：false

serverMonitoringMode

string

ドライバーが使用するサーバー監視プロトコルを指定します。 autoに設定した場合、モニタリング モードはドライバーが実行されている環境によって決まります。 ドライバーは、FaaS（function-as-a-service）環境ではpollモードを使用し、他の環境ではstreamモードを使用します。

デフォルト：auto

uuidRepresentation

string

読み取り操作と書込み (write) 操作に使用する UUID 表現を指定します。詳しくは、MongoClientSettings.getUuidRepresentation() メソッド の ドライバー ドキュメントを参照してください。

デフォルト：unspecified

directConnection

ブール値

ドライバーがホストに直接接続する必要があることを指定します。

デフォルト：false

maxConnecting

integer

プールを同時に確立できる最大接続数を指定します。

デフォルト：2

srvServiceName

string

シードリストを構築するためにドライバーが取得する SRVリソースレコードのサービス名を指定します。このオプションを使用するには、接続 URI で DNS シード リスト接続形式 を使用する必要があります。

デフォルト：mongodb

srvAllowedHostsSupfix

string

SRVレコード検索によって返されたホスト名を検証するためにドライバーが使用するドメイン サフィックスを指定します。このオプションを設定すると、ドライバーは SRV ホスト名から推測されたドメインではなく、指定されたサフィックスに対してホスト名を検証します。値がピリオド（.）で始まっていない場合、ドライバーはピリオドを追加します。このオプションは、 mongodb+srv接続文字列形式でのみ使用できます。

デフォルト:null 。ドライバーは、SRV ホスト名から推測されたドメインに対してホスト名を検証します。