Docs Menu
Docs Home
/ / /
Kotlin コルーチン
/ /

接続オプション

このセクションでは、ドライバーでサポートされている MongoDB 接続および認証オプションについて説明します。 接続 URI のパラメーターとして接続オプションを渡し、クライアントの動作を指定できます。

オプション名
タイプ
説明
minPoolSize
integer

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

Default: 0
maxPoolSize
integer

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

Default: 100
waitQueueTimeoutMS
integer

接続可能になるまでスレッドが待機できる最大時間をミリ秒単位で指定します。

Default: 120000 (120 seconds)
serverSelectionTimeoutMS
integer

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

Default: 30000 (30 seconds)
localThresholdMS
integer

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

Default: 15
heartbeatFrequencyMS
integer

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

Default: 10000 (10 seconds)
replicaSet
string

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

Default: null
ssl
ブール値

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

Default: false
tls
ブール値

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

Default: false
tlsInsecure
ブール値

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

Default: false
tlsAllowInvalidHostnames
ブール値

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

Default: false
connectTimeoutMS
integer

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

Default: 10000 (10 seconds)
socketTimeoutMS
integer

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

Default: 0
maxIdleTimeMS
integer

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

Default: 0
maxLifeTimeMS
integer

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

Default: 0
journal
ブール値

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

Default: false
w
string or integer

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

Default: 1
wTimeoutMS
integer

書込み保証 (write concern) の時間制限をミリ秒単位で指定します。 詳細については、 wtimeoutMS オプションのサーバーのドキュメントを参照してください。 値が0の場合は、書込み操作がタイムアウトしないようにドライバーに指示します。

Default: 0
readPreference
string

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

Default: primary
readPreferenceTags
string

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

Default: null
maxStalenessSeconds
integer

Specifies, in seconds, how stale a secondary can be before the driver stops communicating with that secondary. の最小値は、 90秒またはハートビート頻度に10秒を加えた値のうち大きい方です。 詳細については、 maxStalenessSeconds オプションのサーバー ドキュメントを参照してください。 Not providing a parameter or explicitly specifying -1 indicates that there should be no staleness check for secondaries.

Default: -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

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

Default: admin
authMechanismProperties
string

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

Default: null
appName
string

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

Default: null
compressors
string

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

Default: null
zlibCompressionLevel
integer

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

Default: null
retryWrites
ブール値

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

Default: true
retryReads
ブール値

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

Default: true
serverMonitoringMode
string

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

Default: auto
uuidRepresentation
string

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

Default: unspecified
directConnection
ブール値

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

Default: false
maxConnecting
integer

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

Default: 2
srvServiceName
string

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

Default: mongodb

オプションを網羅したリストについては、次を参照して ください 。 API リファレンス ページ。

戻る

MongoDB に接続する