/ /

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 ドライバーがアプリケーションの認証に使用するメカニズムを設定します。有効なオプションは、クラス ConnectionString API ドキュメントに記述されています。データ型: `String` デフォルト: MongoDB v4.0 に接続する場合は `"SCRAM-SHA-256"`以降。 MongoDB v3.0 に接続する場合は `"SCRAM-SHA-1"`v.3 13まで。接続 URI の例: `authMechanism=MONGODB-X509`
authMechanismProperties	認証メカニズムに固有のオプションを設定します。データ型: `String` デフォルト: `""` 接続 URI 例: `authMechanismProperties=AWS_SESSION_TOKEN:12435`
authSource	認証資格情報のソースを設定します。ソースは通常データベースです。このオプションは、`authMechanism` が`MONGO-CR` に設定されている場合にのみ有効です。データ型:`String` デフォルト: 接続 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) 操作が失敗した場合に、ドライバーが再試行するかどうかを設定します。データ型: `boolean` デフォルト: `True` 接続 URI 例: `retryWrites=true`
retryReads	ネットワークエラーによりサポートされている読み取り操作が失敗した場合、ドライバーが再試行するかどうかを設定します。データ型: `boolean` デフォルト: `True` 接続 URI 例: `retryReads=true`
uuidRepresentation	Java Reactive Streams ドライバーが UUID のインスタンスのエンコードに使用するメカニズムを設定します。すべての有効なオプションのリストについては、 Uuid Representation API ドキュメントを参照してください。データ型: `String` デフォルト: `unspecified` 接続 URI の例: `uuidRepresentation=unspecified`

プロキシ構成

接続オプション	説明
proxyHost	SOCKS5 プロキシホストを設定して接続を確立します。 `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`の詳細については、クラス ConnectionString API ドキュメントを参照してください。データ型: `String` デフォルト: `null` 接続 URI の例: `readPreferenceTags=dc:ny`
maxStalenessSeconds	最大スタレールを秒単位で設定します。スタレールの詳細については、「クラス ConnectionString」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 時間のしきい値を設定します。この値が設定されている場合、ドライバーは、ping 時間が最も速いサーバーとローカルしきい値以下のサーバーにのみリクエストを送信します。データ型: `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サーバーによってすべての書き込み (write) が認識されることを保証するか、または例外をスローするかを設定します。 `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`

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

戻る

接続ターゲットの選択

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