/ /

Java Reactive Streams ドライバー

Java Reactive Streams ドライバー

接続

接続 URI オプションの指定

Overview

このセクションでは、 Java Reactive Streams ドライバーの接続 URI のパラメーターとして渡すことができるMongoDBの接続オプションと認証オプションについて説明します。

接続 URI の使用

MongoClient コンストラクターに接続 URI を渡す場合は、接続オプションを <name>=<value> ペアとして文字列に含めることができます。次の例では、接続 URI に、値が 60000 の connectTimeoutMS オプションと、値が true の tls オプションが含まれています。

public class MongoConnection {
public static void main(String[] args) {
    String uri = "mongodb://<hostname>:<port>/?connectTimeoutMS=60000&tls=true";
    try (MongoClient client = MongoClients.create(uri)) {
            // Use client here
        }
    }
}

接続オプション

次のセクションでは、 Java Reactive Streams ドライバーで使用できる接続オプションについて説明します。これらのオプションを接続 URI のパラメーターとしてに渡し、クライアントの動作を指定できます。

認証

接続オプション	説明
authMechanism	Java Reactive Streams ドライバーがアプリケーションを認証するために使用するメカニズムを設定します。有効なオプションは、クラスの接続文字列APIドキュメントで定義されています。データ型:`String` デフォルト:`"SCRAM-SHA-256"` MongoDB4 v.0 `"SCRAM-SHA-1"`以降に接続する場合は MongoDB v.3 0から v. に接続する場合の3 13 接続 URI の例:`authMechanism=MONGODB-X509`
authMechanismProperties	認証メカニズムに固有のオプションを設定します。データ型:`String` デフォルト:`""` 接続 URI の例:`authMechanismProperties=AWS_SESSION_TOKEN:12435`
authSource	認証資格情報のソースを設定します。ソースは通常、データベースです。このオプションは、`authMechanism` `MONGO-CR`がに設定されている場合にのみ尊重されます。データ型:`String` デフォルト: 接続 URI 内のデータベース、または接続 URI が指定されていない場合は`"admin"` 接続 URI の例:`authSource=admin`
username	認証のユーザー名を設定します。このオプションが接続 URI に含まれている場合は、パーセントエスケープする必要があります。データ型:`String` デフォルト:`""` 接続 URI の例:`username=my+user`
パスワード	認証用のパスワードを設定します。このオプションが接続 URI に含まれている場合は、パーセントエスケープする必要があります。データ型:`String` デフォルト:`""` 接続 URI の例:`password=strong+password`

接続構成

接続オプション	説明
connectTimeoutMS	接続のタイムアウトまでにかかる時間をミリ秒単位で設定します。指定された時間内に操作が終了しない場合、 Java Reactive Streams ドライバーはタイムアウトの例外を発生させます。データ型:`Integer` デフォルト:`null` 接続 URI の例:`connectTimeoutMS=6000`
maxIdleTimeMS	接続が削除されて閉じられるまで、プール内でアイドル状態を維持できる最大ミリ秒数を設定します。この値は、アプリケーションの予想されるアイドル期間よりも高く、ファイアウォールまたはプロキシの接続タイムアウトよりは低く設定して、予期しない切断を防ぐために、データ型:`Integer` デフォルト:`null` 接続 URI の例:`maxIdleTimeMS=6000`
maxLifeTimeMS	プールされた接続の最大有効期間をミリ秒単位で設定します。指定された時間内に操作が完了しない場合、 Java Reactive Streams ドライバーは接続を閉じます。データ型:`Integer` デフォルト:`null` 接続 URI の例:`maxLifeTimeMS=6000`
socketTimeoutMS （非推奨）	このオプションは非推奨です。このタイムアウトは、代わりにクライアントレベルのタイムアウトを設定することで構成できます。ソケットでの受信にはタイムアウトするまでにかかる時間（ミリ秒）が含まれます。指定された時間内に操作が終了しない場合、 Java Reactive Streams `Integer` ドライバーはタイムアウトの例外を発生させます。データ型:`null` デフォルト: 接続 URI の例:`socketTimeoutMS=6000`
ssl	TLS/SSL を使用して接続するかどうかを設定します。データ型:`boolean` デフォルト:`null` 接続 URI の例:`ssl=true`
sslInvalidHostNameAllowed	TLS/SSL 接続の無効なホスト名を許可します。データ型:`boolean` デフォルト:`null` 接続 URI の例:`sslInvalidHostNameAllowed=true`
tls	TLS`ssl` を使用して接続するかどうかを設定します。オプションを置き換えます。データ型:`boolean` デフォルト:`null` 接続 URI の例:`tls=true`
tlsAllowInvalidHostnames	TLS `sslInvalidHostNameAllowed` 接続の無効なホスト名を許可します。オプションを置き換えます。データ型:`boolean` デフォルト:`null` 接続 URI の例:`tlsAllowInvalidHostnames=true`
tlsInsecure	TLS を使用して接続するときに、安全でない TLS 接続を有効にします。データ型:`boolean` デフォルト:`null` 接続 URI の例:`tlsInsecure=true`

接続プールの構成

接続オプション	説明
maxConnecting	プールが同時に確立できる接続の最大数を設定します。データ型:`Integer` デフォルト:`null` 接続 URI の例:`maxConnecting=5`
maxPoolSize	接続プール内の最大接続数を設定します。接続プールで`maxPoolSize` の接続が開いているときに操作に新しい接続が必要な場合、新しい操作は新しい接続が開くことを待機します。この待機時間を制限するには、単一のタイムアウト設定を使用します。詳細については、「サーバー実行時間の制限」のガイドを参照してください。データ型:`Integer` デフォルト:`null` 接続 URI の例:`maxPoolSize=5`
minPoolSize	接続プール内の接続の最小数を設定します。データ型:`Integer` デフォルト:`null` 接続 URI の例:`minPoolSize=3`
waitQueueTimeoutMS （非推奨）	このオプションは非推奨です。このタイムアウトは、代わりにクライアントレベルのタイムアウトを設定することで構成できます。使用中の接続が利用可能になるか、接続が作成されて確立が開始されるまでに待機する最大時間（ミリ秒）。データ型:`Integer` デフォルト:`null` 接続 URI の例:`waitQueueTimeoutMS=6000`

CompressorConfiguration

接続オプション	説明
compressors	サーバーとの間で送受信されるワイヤプロトコルメッセージの優先圧縮タイプを、順番に設定します。圧縮タイプは、カンマ区切りのリストとして渡す必要があります。ドライバーは、サーバーがサポートする最初の圧縮タイプを使用します。データ型:`String` デフォルト:`null` 接続 URI の例:`compressors=snappy,zstd,zlib`
zlibCompressionLevel	zlib が使用する圧縮レベルを設定します。このオプションは、 `-19`から: - -:（デフォルト）までの整数値を受け入れます。1 zlib はデフォルトの圧縮レベル（通常は`6` ）を使用します。 -:0 圧縮なし。 -:1 速度は最も速くなりますが、圧縮は最小です。 -:9 圧縮には最適ですが、速度は最も遅くなります。データ型:`Integer` デフォルト:`-1` 接続 URI の例:`zLibCompressionLevel=3`

接続オプション

説明

compressors

サーバーとの間で送受信されるワイヤプロトコル

メッセージの優先圧縮タイプを、順番に設定します。圧縮タイプは、カンマ区切りのリストとして渡す必要があります。ドライバーは、サーバーがサポートする最初の圧縮タイプを使用します。データ型:String
デフォルト:null
接続 URI の例:compressors=snappy,zstd,zlib

zlibCompressionLevel

zlib が使用する圧縮レベルを設定します。このオプションは、
-19から:

- -:（デフォルト）までの整数値を受け入れます。1 zlib はデフォルトの圧縮レベル（通常は6 ）を使用します。
-:0 圧縮なし。
-:1 速度は最も速くなりますが、圧縮は最小です。
-:9

圧縮には最適ですが、速度は最も遅くなります。データ型:Integer
デフォルト:-1
接続 URI の例:zLibCompressionLevel=3

一般的な構成

接続オプション	説明
directConnection	ドライバーがホストに直接接続するかどうかを設定します。データ型:`boolean` デフォルト:`null` 接続 URI の例:`directConnection=true`
loadBalanced	ドライバーがロードバランサーを使用してMongoDBに接続するかどうかを設定します。 `true`の場合、ドライバーはロードバランサーを介して接続していると想定します。データ型:`boolean` デフォルト:`null` 接続 URI の例:`directConnection=true`
retryWrites	ネットワークエラーが原因でサポートされている書込み (write) 操作が失敗した場合、ドライバーがサポートされている書込み (write) 操作を再試行するかどうかを設定します。データ型:`boolean` デフォルト:`True` 接続 URI の例:`retryWrites=true`
retryReads	ネットワークエラーが発生して失敗した場合に、ドライバーがサポートされている読み取り操作を再試行するかどうかを設定します。データ型:`boolean` デフォルト:`True` 接続 URI の例:`retryReads=true`
uuidRepresentation	Java Reactive Streams ドライバーが UUID のインスタンスをエンコードするために使用するメカニズムを設定します。有効なすべてのオプションのリストについては、 UUID 表現APIドキュメントを参照してください。データ型:`String` デフォルト:`unspecified` 接続 URI の例:`uuidRepresentation=unspecified`

プロキシ構成

接続オプション	説明
proxyHost	接続を確立するための SOCKS プロキシホストを確立します。5 の値は、有効な`proxyHost` IPv4 アドレス、IPv6 アドレス、またはドメイン名にすることができます。 `proxyPassword`、`proxyUsername` 、または`proxyPort` のいずれかが指定されている場合は必須です。データ型:`String` デフォルト:`null` 接続 URI の例:`proxyHost=example.com`
proxyPort	SOCKS5 プロキシサーバーのポート番号を設定します。負でない整数である必要があります。データ型:`Integer` デフォルト:`null` 接続 URI の例:`proxyPort=27`
proxyUsername	`proxyPassword`プロキシサーバーで認証するためのユーザー名を設定します。が指定されている場合は必須です。データ型:`String` デフォルト:`null` 接続 URI の例:`proxyUsername=example`
proxyPassword	`proxyPassword`プロキシサーバーで認証するためのパスワードを設定します。が指定されている場合は必須です。データ型:`String` デフォルト:`null` 接続 URI の例:`proxyPassword=password`

読み込み設定（read preference）構成

接続オプション	説明
readPreference	この接続の読み込み設定 (read preference)を設定します。列挙値は、 `primary` `primaryPreferred`、`secondary` 、`secondaryPreferred` 、`nearest` 、です。データ型:`Enum` デフォルト:`primary` 接続 URI の例:`readPreference.primary`
readPreferenceTags	`dc:ny,rack:1` タグセットを、キーと値のペアをコロンで区切った、コンマ区切りリストとして指定します（例: ）。スペースは、すべてのキーと値の先頭と末尾から削除されます。タグセットのリストを指定するには、セミコロンで区切った複数の `readPreferenceTags` を使用します。`readPreferenceTags` の詳細については、 Class ConnectionString APIドキュメントを参照してください。データ型:`String` デフォルト:`null` 接続 URI の例:`readPreferenceTags=dc:ny`
maxStalenessSeconds	最大古さを秒単位で設定します。古さの詳細については、クラスの接続文字列APIドキュメントを参照してください。データ型:`Integer` デフォルト:`null` 接続 URI の例:`maxStalenessSeconds=60`

レプリカセットの構成

接続オプション	説明
replicaSet	接続先のレプリカセットの名前を指定します。データ型:`String` デフォルト:`null` 接続 URI の例:`replicaSet=replicaSet`

サーバー構成

接続オプション	説明
appName	アプリケーションの論理名を設定します。アプリケーション名は、サーバーログ、スロークエリログ、プロファイルコレクションで使用される、アプリケーションをサーバーに識別するためにクライアントが使用する場合があります。データ型:`String` デフォルト:`null` 接続 URI の例:`appName=name`
heartbeatFrequencyMS	クラスター内の各サーバーの現在の状態を決定するドライバーの頻度（ミリ秒単位）。データ型:`Integer` デフォルト:`null` 接続 URI の例:`heartbeatFrequencyMS=6000`
localThresholdMS	リクエストを送信する複数のMongoDBサーバーから選択するためのping時間のしきい値を設定します。この値が設定されている場合、ドライバーは、pingpingが最も短いサーバーにローカルしきい値を加えたサーバー以下のサーバーにのみそのリクエストを送信します。データ型: `Integer` デフォルト:`null` 接続 URI の例:`localThresholdMS=6000`
serverMonitoringMode	サーバーモニタリングモードを設定し、使用するモニタリングプロトコルを定義します。列挙値は、`stream` 、、`poll` `auto` です。データ型:`Enum` デフォルト:`auto` 接続 URI の例:`serverMonitoringMode.auto`
serverSelectionTimeoutMS	ドライバーが例外をスローする前に、サーバー選択が成功するまで待機する時間を設定します。データ型:`Integer` デフォルト:`null` 接続 URI の例:`serverSelectionTimeoutMS=6000`

SRV 構成

接続オプション	説明
srvServiceName	SRV サービス名を設定します。詳しくは、 ClusterSettings.getSrvServiceName() APIドキュメントを参照してください。データ型:`String` デフォルト:`"mongodb"` 接続 URI の例:`srvServiceName=mongodb`
srvMaxHosts	SRVレコードから接続するホストの最大数を設定します。データ型: `Integer` デフォルト:`null` 接続 URI の例:`srvMaxHosts=5`

書込み保証 (write concern) の構成

接続オプション	説明
安全	ドライバーがすべての書き込みをMongoDBサーバーによって確認されるようにするか、そうでない場合は例外をスローするかを設定します。`false` の場合、ドライバーはすべての書き込みがMongoDBサーバーによって確認されることを保証しません。データ型: `boolean` デフォルト:`null` 接続 URI の例:`safe=true`
journal	サーバーがディスク上のジャーナルファイルにグループコミットするのを待機するかどうかを設定します。データ型:`boolean` デフォルト:`null` 接続 URI の例:`journal=true`
w	設定されている場合、ドライバーはすべての書き込みコマンドに`{ w : wValue }` を追加します。設定されている場合、 `safe=True`はを意味します。データ型:`Integer` または`String` デフォルト:`null` 接続 URI の例:`w=60`
wTimeoutMS （非推奨）	このオプションは非推奨です。このタイムアウトは、代わりにクライアントレベルのタイムアウトを設定することで構成できます。これを設定すると、ドライバーはすべての書込みコマンドに `{ wtimeout : ms }`を追加します。設定されている場合、は`safe=true` を意味します。このオプションは`w` と組み合わせて使用します。データ型:`Integer` デフォルト:`null` 接続 URI の例:`wtimeoutMS=6000`

このセクションの接続オプションの詳細については、「データベースとコレクションのガイド」を参照してください。

戻る

接続ターゲットの選択

データベースとコレクション