AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。
Docs Menu

接続オプション

このガイドでは、MongoDB の接続および認証オプションについて学習できます。 接続stringのパラメーターとして接続オプションを設定して、サーバーに接続するときに Client インスタンスの動作を指定できます。

オプション名
許容値
デフォルト値
説明

appName

文字列

なし

Client インスタンスがハンドシェイクの一部としてサーバーに送信するアプリケーション名を指定します。
appName を指定すると、サーバーログを使用して、どの Client インスタンスがサーバーに接続されているかを判定するのに役立ちます。

authMechanism

文字列

なし

使用する認証メカニズムを指定します。 このオプションを指定しない場合、ドライバーはデフォルトの認証メカニズムを使用します。 Rust ドライバーでの認証の詳細については、「認証メカニズム 」に関するガイドを参照してください。

authMechanismProperties

文字列

なし

authMechanismオプションで設定された認証メカニズムの詳細なプロパティを指定します。

authSource

文字列

説明を参照してください

認証に使用されるデータベースを指定します。
このオプションは、SCRAM ベースの認証メカニズムの場合はadminMONGODB-X509 メカニズムの場合は$externalPLAIN メカニズムの場合はデータベース名または$externalにデフォルト設定されます。

compressors

文字列のコンマ区切りリスト

なし

Clientインスタンスが指定された順序で使用するコンプレッサーを指定します。 ネットワーク圧縮の詳細については、「ネットワーク圧縮 」のガイドを参照してください。

connectTimeoutMS

Non-negative integer

10000 (10 秒)

サーバーに接続するときに、基礎の各 TCP ストリームに渡される接続タイムアウトをミリ秒単位で指定します。

directConnection

ブール値

false

Clientインスタンスがクラスター内のすべてのサーバーを検出して接続するのではなく、単一のホストに直接接続するかどうかを指定します。

heartbeatFrequencyMS

500 以上の整数

10000 (10 秒)

各監視スレッドがサーバー チェックの実行間で待機する時間をミリ秒単位で指定します。

journal

ブール値

false

操作がディスク上のジャーナルに伝達されたことの確認を要求します。

localThresholdMS

Non-negative integer

15

ドライバーとサーバー間の平均ラウンドトリップ時間が、すべての適切なサーバーの最短ラウンドトリップ時間と比較して持続できる時間の長さをミリ秒単位で指定します。
0 の値は、レイテンシ ウィンドウがないことを示しているため、平均ラウンドトリップ時間が最も短いサーバーのみが適格となります。

maxIdleTimeMS

Non-negative integer

0 (no limit)

接続がサーバーによって閉じられる前に、接続プール内でアイドル状態を維持できる時間をミリ秒単位で指定します。
0 は、クライアントがアイドル接続を閉じないことを示します。この値は、アプリケーションの予想されるアイドル期間よりも高く、ファイアウォールまたはプロキシの接続タイムアウトよりも低く設定して、予期せぬ切断を防止します。

maxStalenessSeconds

-1、または 以上の任意の整数 90

-1

セカンダリノードが所定の操作の対象となるために、プライマリノードに対する最大の遅延時間(秒)を指定します。
このオプションの値は少なくとも 90 でなければならず、そうでない場合は操作でエラーが発生します。-1 の値は、最大遅延時間がないことを意味します。

maxPoolSize

Non-negative integer

10

Client インスタンスが特定のサーバーの接続プールで作成できる接続の最大数を指定します。
maxPoolSize 接続の値がチェックアウトされている間に操作を試行すると、操作は進行中の操作が終了して接続がプールに戻るまで待機します。

minPoolSize

Non-negative integer

0

特定の時点でサーバーの接続プールで使用できる接続の最小数を指定します。
プール内の接続数が minPoolSize 未満の場合、サーバーは背景で minPoolSize の値まで接続を追加します。

readConcernLevel

文字列

なし

Specifies the default read concern for operations performed on the Client instance. 詳細については、サーバー マニュアルの「読み取り保証」を参照してください。

readPreference

文字列

primary

ドライバーが読み取り操作をレプリカセットのノードにルーティングする方法を指定します。 詳細については、サーバー マニュアルの「読み込み設定」を参照してください。

readPreferenceTags

キーと値のペアをコンマで区切ったリスト

なし

どのレプリカセット ノードを操作の対象にするかを指定します。 このキーの各インスタンスは、個別のタグ セットです。 ドライバーは、セット内の各タグを持つ 1 つまたは複数のサーバーを見つけるまで、各タグセットをチェックします。

replicaSet

文字列

なし

Clientインスタンスが接続するレプリカセットの名前を指定します。

retryReads

ブール値

true

操作が失敗した場合にクライアントが読み取り操作を再試行するかどうかを指定します。

serverSelectionTimeoutMS

Non-negative integer

30000 (30 秒)

Clientインスタンスがタイムアウトする前に操作のサーバーを選択しようとする際に待機する時間をミリ秒単位で指定します。

tls

ブール値

false

サーバーとの接続で使用するClientインスタンスの TLS 構成を指定します。 デフォルトでは、TLS はオフになっています。

tlsAllowInvalidCertificates

ブール値

false

サーバーが無効な証明書を提示した場合、Client インスタンスがエラーを返すかどうかを指定します。
アプリケーションに脆弱性を作成しないよう、このオプションはテスト環境のみ true に設定することをお勧めします。

tlsCAFile

文字列

説明を参照してください

Client インスタンスが TLS に使用する認証機関 (CA) ファイルへのパスを指定します。
このオプションを指定しない場合、ドライバーは webpki-roots crate の Mozilla ルート証明書を使用します。

tlsCertificateKeyFile

文字列

なし

Client インスタンスがサーバーに提示して自身を認証するための証明書ファイルへのパスを指定します。
このオプションを設定しない場合、Client インスタンスはサーバーに対して自身を認証しようとしません。

tlsInsecure

ブール値

false

サーバーが無効な証明書を提示した場合、Client インスタンスがエラーを返すかどうかを指定します。
アプリケーションに脆弱性を作成しないよう、このオプションはテスト環境のみ true に設定することをお勧めします。

w

負でない整数または文字列

なし

操作が特定の数または種類のサーバーに伝播されたことの確認応答をリクエストします。
詳細については、サーバー マニュアルの「書込み保証 (write concern)」を参照してください。

wTimeoutMS

Non-negative integer

タイムアウトなし

書込み保証 (write concern) の時間制限をミリ秒単位で指定します。 制限時間内に操作が要求されたレベルに伝達されなかった場合、ドライバーはエラーを発生させます。

zlibCompressionLevel

-1 から 9 までの整数

-1

この圧縮を使用する場合、zlib 圧縮のレベルフィールドを指定します。
-1 の値を設定すると、デフォルトの圧縮レベル (6) が選択されます。
0 の値を設定すると圧縮なしが指定され、9 の値を設定すると最大圧縮が指定されます。
ネットワーク圧縮の詳細については、「ネットワーク圧縮」ガイドを参照してください。

接続オプションの完全なリストを表示するには、サーバー マニュアル エントリの「接続stringオプション 」セクションにアクセスしてください。