Docs Menu
Docs Home
/
MongoDBマニュアル
/ /

接続文字列オプション

項目一覧

  • レプリカセット オプション
  • 接続オプション
  • TLS のオプション
  • タイムアウト オプション
  • 圧縮オプション
  • 接続プール オプション
  • 書込み保証(write concern)オプション
  • readConcern オプション
  • 設定オプションを読む
  • 認証オプション
  • サーバーの選択と検出オプション
  • その他の設定

このページでは、SRV 接続文字列と標準接続文字列の両方のすべての接続オプションを一覧表示します。

接続オプションは次の形式のペアです: name=value

  • オプション name では、ドライバーを使用する場合、大文字と小文字は区別されません。

  • オプションnameでは、 mongoshを使用する場合、大文字と小文字は区別されません。

  • value では常に大文字と小文字が区別されます。

オプションはアンパサンド(&)文字 name1=value1&name2=value2 で区切ります。次の例では、接続に replicaSet オプションと connectTimeoutMS オプションが含まれています。

mongodb://myDatabaseUser:D1fficultP%40ssw0rd@db1.example.net:27017,db2.example.net:2500/?replicaSet=test&connectTimeoutMS=300000

注意

接続文字列引数のセミコロン区切り記号

下位互換性を保つために、ドライバーは現在、オプションの区切り文字としてセミコロン(;)を受け入れます。

次の接続文字列は、指定されたホスト上で実行されているメンバーを含む myRepl という名前のレプリカセットに接続します。パスワード D1fficultP%40ssw0rd を使用してユーザー myDatabaseUser として認証します。

mongodb://myDatabaseUser:D1fficultP%40ssw0rd@db0.example.com:27017,db1.example.com:27017,db2.example.com:27017/?replicaSet=myRepl
接続オプション
説明
replicaSet

がレプリカセットのメンバーである場合、 レプリカセット mongodの名前を指定します。ドライバー間で一貫した動作を確保するには、 replicaSet接続オプションを設定します。

レプリカセットに接続するときは、URI のhost[:port]コンポーネントにレプリカセット ノードのシードリストを指定します。 詳しくは、「ドライバーのドキュメント 」を参照してください。

directConnection

クライアントが接続 URI で host[:port] に直接接続するかどうかを指定します。

  • true: クライアントは、指定ホストのみに操作指示を送信し、レプリカセットの他のノードの検出は試みません。

  • false: クライアントはレプリカセット内のすべてのサーバーを検出し、プライマリ ノードに操作を送信します。これはデフォルト値です。

レプリカセットへの次の接続文字列には tls=true オプションが含まれており、パスワード D1fficultP%40ssw0rd を使用してユーザー myDatabaseUserとして認証します。

mongodb://myDatabaseUser:D1fficultP%40ssw0rd@db0.example.com,db1.example.com,db2.example.com/?replicaSet=myRepl&tls=true

代わりに、同等の ssl=true オプションを使用することもできます。

mongodb://myDatabaseUser:D1fficultP%40ssw0rd@db0.example.com,db1.example.com,db2.example.com/?replicaSet=myRepl&ssl=true
接続オプション
説明
tls

接続の TLS/SSL を有効または無効にします。

tls オプションは ssl オプションと同等です。

mongosh Shell でコマンドラインから追加の tls/ssl オプションが指定される場合は、代わりに --tls コマンドライン オプションを使用します。

ssl

接続用 TLS または SSL を有効または無効にするブール値:

ssl オプションは tls オプションと同等です。

mongosh Shell でコマンドラインから追加の tls/ssl オプションが指定される場合は、代わりに --ssl コマンドライン オプションを使用します。

tlsCertificateKeyFile

クライアントの TLS/SSL X.509 証明書またはクライアントの TLS/SSL 証明書とキーのいずれかを含むローカル .pem ファイルの場所を指定します。

クライアントはこのファイルを mongod / mongos インスタンスに提示します。

が x を表示した場合、 mongod / mongosは接続時に警告を記録します。 509証明書はmongod/mongosホスト システム時間から30日以内に期限切れになります。

このオプションは一部のドライバーではサポートされません。詳細については、ドライバーのドキュメントを参照してください。

この接続文字列オプションは、mongo shell では使用できません。代わりに、コマンドライン オプションを使用してください。

tlsCertificateKeyFilePassword

tlsCertificateKeyFile を復号化するためのパスワードを指定します。

このオプションは一部のドライバーではサポートされません。詳細については、ドライバーのドキュメントを参照してください。

この接続文字列オプションは、mongo shell では使用できません。代わりに、コマンドライン オプションを使用してください。

tlsCAFile

証明機関からのルート証明書チェーンを含むローカル .pem ファイルの場所を指定します。このファイルは、mongod / mongos インスタンスによって提示された証明書を検証するために使用されます。

このオプションは一部のドライバーではサポートされません。詳細については、ドライバーのドキュメントを参照してください。

この接続文字列オプションは、mongo shell では使用できません。代わりに、コマンドライン オプションを使用してください。

tlsAllowInvalidCertificates

mongod / mongos インスタンスによって提示された証明書の検証をバイパスします

サーバーの現在の証明書が無効であっても MongoDB インスタンスに接続するには、true に設定します。

このオプションは一部のドライバーではサポートされません。詳細については、ドライバーのドキュメントを参照してください。

この接続文字列オプションは、mongo shell では使用できません。代わりに、コマンドライン オプションを使用してください。

警告: 証明書の検証を無効にすると脆弱性が生じます。

tlsAllowInvalidHostnames

mongod / mongos インスタンスによって提示された証明書のホスト名検証を無効にします。

サーバー証明書のホスト名がサーバーのホストと一致しない場合でも MongoDB インスタンスに接続するには、true に設定します。

このオプションは一部のドライバーではサポートされません。詳細については、ドライバーのドキュメントを参照してください。

この接続文字列オプションは、mongo shell では使用できません。代わりに、コマンドライン オプションを使用してください。

警告: 証明書の検証を無効にすると脆弱性が生じます。

tlsInsecure

さまざまな証明書の検証を無効にします。

証明書の検証を無効にするには、true に設定します。具体的にどの検証が無効になるかは、ドライバーによって異なります。詳細については、ドライバーのドキュメントを参照してください。

この接続文字列オプションは、mongo shell では使用できません。代わりに、コマンドライン オプションを使用してください。

警告: 証明書の検証を無効にすると脆弱性が生じます。

接続オプション
説明
connectTimeoutMS
タイムアウトするまで接続を試みる時間(ミリ秒単位)。デフォルト値は 10,000 ミリ秒ですが、ドライバーによってはデフォルト値が異なる場合があります。詳細については、ドライバーのドキュメントを参照してください。
socketTimeoutMS
試行がタイムアウトするまでにソケット上で送信または受信を試行する時間(ミリ秒単位)。 デフォルトではタイムアウトはありませんが、ドライバーによって異なる場合があります。 ドライバーのドキュメントを参照してください。
接続オプション
説明
compressors

このクライアントと mongod / mongos インスタンス間の通信でネットワーク圧縮を有効にするコンプレッサーのカンマ区切り文字列。

次の圧縮プログラムを指定できます。

複数のコンプレッサーを指定する場合、通信イニシエーターだけでなく、コンプレッサーをリストする順序も重要になります。たとえば、クライアントが次のネットワーク コンプレッサー "zlib,snappy" を指定し、mongod"snappy,zlib" を指定した場合、クライアントと mongod 間のメッセージは zlib を使用します。

両者がネットワーク圧縮を有効にしている場合、メッセージは圧縮されます。そうでなければ、この両者間のメッセージは非圧縮となります。

両者に共通のコンプレッサーが 1 つもなければ、両者間のメッセージは圧縮されません。

mongoshは URI 接続stringオプションcompressors をサポートしています。

zlibCompressionLevel

network compressionzlib を使用する場合の圧縮レベルを指定する整数です。

-1 から 9 までの範囲の整数値を指定できます。

ノート
-1
デフォルトの圧縮レベル。通常はレベル 6 の圧縮です。
0
圧縮なし
1 - 9

圧縮レベルは上がりますが、速度は低下します:

  • 1 最高の速度を提供しますが、圧縮は最小です。

  • 9 最高の圧縮を提供しますが、速度は最も遅くなります。

mongosh によってサポートされています。

ほとんどのドライバーには、何らかの接続プール処理が実装されています。一部のドライバーは接続プールをサポートしていません。接続プーリング実装の詳細については、お使いのドライバーのドキュメントを参照してください。これらのオプションを使用すると、MongoDB 配置への接続時にアプリケーションで接続プールを構成できるようになります。

接続オプション
説明
maxPoolSize
接続プール内の最大接続数。デフォルト値は 100 です。
minPoolSize

接続プール内の接続の最小数。デフォルト値は 0 です。

minPoolSizeオプションは一部のドライバーではサポートされません。 お使いのドライバーの詳細については、該当 ドライバーのドキュメントを参照してください。

maxConnecting

プールを同時に確立できる接続の最大数。デフォルト値は 2 です。

maxConnectingRust ドライバー除くすべてのドライバーでサポートされます。

maxConnecting の値を上げることで、クライアントはサーバーへの接続をより早く確立できますが、接続ストームのリスクが高くなります。maxConnecting の値が低すぎると、接続プールで過剰なスロットリングが発生し、クライアントが接続を取得する際の待機時間が増加する可能性があります。

maxIdleTimeMS

このオプションはすべてのドライバーでサポートされているわけではありません。

このオプションは一部のドライバーではサポートされません。

waitQueueMultiple

プールから接続が利用可能になるまで待機できるスレッドの最大数を提供するために、ドライバーがmaxPoolSize値を乗算する数値。 デフォルト値については、ドライバーのドキュメントを参照してください。

このオプションは一部のドライバーではサポートされません。

waitQueueTimeoutMS

接続可能になるまでスレッドが待機できる最大時間(ミリ秒単位)。デフォルト値については、ドライバーのドキュメントを参照してください。

このオプションは一部のドライバーではサポートされません。

書込み保証(write concern) は、MongoDB からリクエストされる確認応答のレベルを表します。書込み保証(write concern)オプションは以下によってサポートされます。

書込み保証(write concern)事項は、接続文字列内と、insertupdate などのメソッドへのパラメーターの両方で指定できます。書込み保証(write concern)事項が両方の場所で指定されている場合、メソッド パラメーターは接続文字列の設定をオーバーライドします。

MongoDB Atlas 配置接続文字列は、デフォルトで "majority" を使用します。MongoDB Atlas 配置に対して書込み保証(write concern)を指定しない場合、MongoDB Atlas は "majority" を適用します。

レプリカセットに対する次の接続stringでは、 wtimeoutMS書込み保証(write concern)パラメータを使用して、 "majority"書込み保証と 5 秒のタイムアウトを指定します。

mongodb://myDatabaseUser:D1fficultP%40ssw0rd@db0.example.com,db1.example.com,db2.example.com/?replicaSet=myRepl&w=majority&wtimeoutMS=5000
接続オプション
説明
w

書き込み保証 (write concern) w オプションに対応します。w オプションでは、書き込み (write) 操作が指定の数の mongod インスタンスか指定のタグを持つ mongod インスタンスに伝播したことの確認を要求します。

number、文字列 majority、または tag set. を指定できます。

詳細については、「w オプション」を参照してください。

wtimeoutMS

書き込み保証(write concern)wtimeout に対応します。wtimeoutMSは、書き込み保証(write concern)の時間制限をミリ秒単位で指定します。

wtimeoutMS0 の場合、書込み操作はタイムアウトになりません。詳しくは、 wtimeout を参照してください。

journal

書き込み保証(write concern)j オプションに対応します。journalオプションは、書き込み (write)操作がジャーナルに書き込まれたことを MongoDB に確認するよう要求します。詳細については「j オプション」を参照してください。

journaltrueに設定し、 wの値を1より小さく指定すると、 journalが優先されます。

詳細については、「書き込み保証(write concern)」を参照してください。

MongoDB では WiredTiger ストレージエンジン向けに、レプリカセットとレプリカセット シャードで readConcern オプションを導入します。

読み取り保証(read concern)を使用すると、クライアントはレプリカセットからの読み取りの分離レベルを選択できます。

レプリカセットに対する次の接続stringではreadConcernLevel=majorityを指定します。

mongodb://myDatabaseUser:D1fficultP%40ssw0rd@db0.example.com,db1.example.com,db2.example.com/?replicaSet=myRepl&readConcernLevel=majority
接続オプション
説明
readConcernLevel

分離レベル。次のいずれかの値を受け入れることができます。

この接続文字列 オプションはmongoshでは使用できません。特定の操作のオプションとして読み取り保証(read concern)を指定します。

詳細については、「読み取り保証(read concern)」を参照してください。

読み込み設定(read preference)は、レプリカセットに関する読み取り操作の動作を説明します。これらのパラメーターを使用すると、接続文字列で接続ごとに読み込み設定(read preference)を指定できます。

以下に例を挙げます。

  • レプリカセットに対する次の接続文字列では secondary 読み込み設定(read preference)モードと 120 秒の maxStalenessSeconds 値を指定します。

    mongodb://myDatabaseUser:D1fficultP%40ssw0rd@db0.example.com,db1.example.com,db2.example.com/?replicaSet=myRepl&readPreference=secondary&maxStalenessSeconds=120
  • シャーディングされたクラスターに対する次の接続文字列では、secondary 読み込み設定(read preference)と 120 秒の maxStalenessSeconds 値を指定します。

    mongodb://myDatabaseUser:D1fficultP%40ssw0rd@mongos1.example.com,mongos2.example.com/?readPreference=secondary&maxStalenessSeconds=120
  • シャーディングされたクラスターに対する次の接続文字列では、secondary 読み込み設定(read preference)モードと 3 つの readPreferenceTags を指定します。

    mongodb://myDatabaseUser:D1fficultP%40ssw0rd@mongos1.example.com,mongos2.example.com/?readPreference=secondary&readPreferenceTags=dc:ny,rack:r1&readPreferenceTags=dc:ny&readPreferenceTags=

複数の readPreferenceTags を使用する場合は、順序が重要です。一致が見つかるまで、 readPreferenceTags は順番に試行されます。一致が見つかると、その仕様を使用して一致するノードはすべて検索され、残りの readPreferenceTags は無視されます。詳細については、「タグの一致順序」を参照してください。

接続オプション
説明
readPreference

この接続の読み込み設定(read preference)を指定します。可能な値は次のとおりです。

読み取り操作を含む分散トランザクションでは、読み込み設定(read preference) primary を使用する必要があります。特定のトランザクション内のすべての操作は、同じノードにルーティングする必要があります。

この接続文字列オプションは、mongo shell では使用できません。代わりに cursor.readPref()Mongo.setReadPref() を参照してください。

maxStalenessSeconds

セカンダリの古さがどのぐらいになると、クライアントがセカンダリを使用した読み込み操作を停止するかを指定します(秒単位)。詳しくは、「読み込み設定(read preference)maxStalenessSeconds」を参照してください。

デフォルトでは、最大の古さはなく、クライアントは読み取り操作の送信先を選択するときにセカンダリの遅延を考慮しません。

maxStalenessSeconds の最小値は 90 秒です。0 秒から 90 秒の間の値を指定するとエラーが発生します。MongoDB ドライバーは、-1maxStalenessSeconds 値を "no max staleness" として扱います。これは maxStalenessSeconds を省略した場合と同じです。

readPreferenceTags

タグ ドキュメントを、キーと値のペアをコロンで区切った、カンマ区切りリストとして指定します。たとえば、

  • タグドキュメント { "dc": "ny", "rack": "r1" } を指定するには、接続文字列で readPreferenceTags=dc:ny,rack:r1 を使用します。

  • 空のタグ ドキュメント { } を指定するには、値を設定せずに readPreferenceTags= を使用します。

タグ ドキュメントのリストを指定するには、複数の readPreferenceTags を使用します。例: readPreferenceTags=dc:ny,rack:r1&readPreferenceTags=

複数の readPreferenceTags を使用する場合は、順序が重要です。一致が見つかるまで、 readPreferenceTags は順番に試行されます。詳細については、「タグの一致順序」を参照してください。

この接続文字列オプションは、mongo shell では使用できません。代わりに cursor.readPref()Mongo.setReadPref() を参照してください。

詳しくは、「読み込み設定(read preference)」を参照してください。

レプリカセットに対する次の接続文字列では、authSourceadmin データベースを指定します。つまり、ユーザー認証情報が admin データベースに対して認証されます。

mongodb://myDatabaseUser:D1fficultP%40ssw0rd@mongodb0.example.com:27017,mongodb1.example.com:27017,mongodb2.example.com:27017/?replicaSet=myRepl&authSource=admin

ユーザー名またはパスワードに次の文字が含まれている場合は、それらをパーセント エンコーディングを使用して変換する必要があります。

$ : / ? # [ ] @
接続オプション
説明
authSource

ユーザーの認証情報に関連付けられたデータベース名を指定します。authSource を指定しない場合、 authSourceには接続文字列で指定した defaultauthdb がデフォルトで設定されます。defaultauthdb を指定しない場合、authSource には admin がデフォルトで設定されます。

PLAIN(LDAP)、 GSSAPI(Kerberos)、および MONGODB-AWS(IAM)認証メカニズムでは、認証情報のストレージを外部サービスに委任するため、 authSource$external を設定する必要があります。

MongoDBauthSourceでは、接続string または パラメータでユーザー名が指定されていない場合、--username 値は無視されます。

authMechanism

デフォルト: SCRAM-SHA-256

MongoDB で接続を認証するために使用する認証メカニズムを指定します。authMechanism を指定せずにユーザーの認証情報を入力した場合、MongoDB ではまず SCRAM-SHA-256 が使用され、これが失敗した場合は SCRAM-SHA-1 にフォールバックします。

  • SCRAM-SHA-1

  • SCRAM-SHA-256

  • MONGODB-X509

  • MONGODB-AWS

  • GSSAPI(Kerberos)

  • PLAIN(LDAP SASL)

  • MONGODB-OIDC (OpenID Connect OIDC)。 MONGODB-OIDC を使用するには、次のいずれかを行う必要があります。

    • authMechanismPropertiesENVIRONMENT変数を設定します。

    • クライアントコンストラクターへの OIDCコールバックを提供します。

GSSAPI(Kerberos)と PLAIN(LDAP)メカニズムは、MongoDB Enterprise の mongodmongos インスタンスによってのみ提供されます。

MONGODB-X509 を使用するには、TLS/SSL を有効にする必要があります。

を使用するには、MONGODB-AWS MongoDB AtlasAmazon Web ServicesIAM Amazon Web Servicesの認証情報 経由での認証をサポートするように構成済みの クラスターに接続する必要があります ( アクセスキーID とシークレット アクセスキー、および任意でAmazon Web Services セッション トークン )。MONGODB-AWS認証メカニズムでは、 authSource$externalに設定する必要があります。

MONGODB-AWS を使用する場合は、ユーザー名としてAmazon Web ServicesのアクセスキーIDを指定し、パスワードとしてシークレット アクセスキーを指定します。 Amazon Web Servicesセッション トークン を使用する場合 また、AWS_SESSION_TOKENauthMechanismProperties 値も指定します。

Amazon Web Amazon Web ServicesServicesアクセスキーID 、シークレット アクセス キー、セッションID トークンのいずれかに次の文字が含まれている場合は、 パーセントエンコーディング を使用してそれらの文字を変換する必要があります。

$ : / ? # [ ] @

あるいは、AWS アクセスキーのID、シークレット アクセスキー、またはセッション トークンが、それぞれの AWS IAM 環境変数 mongosh を使用してプラットフォーム上で定義されている場合は、これらの環境変数値が認証に使用されるため、接続文字列では指定する必要がありません。

Atlas接続MONGODB-AWS stringと環境変数を使用した 認証メカニズムの使用例については、「 クラスターへの接続 」を参照してください。

MongoDB の認証システムの詳細については、「自己管理型配置での認証 」を参照してください。 また、 509x509 を使用する も検討してください。 x 認証の詳細については 、「 自己管理型配置でクライアントを認証するための 証明書 」を参照してください。

authMechanismProperties

指定されたauthMechanismのプロパティを、キーと値のペアをコロンで区切った、コンマ区切りリストとして指定します。

指定可能なキーと値のペアは次のとおりです。

SERVICE_NAME:<string>

Kerberos 化された MongoDB インスタンスに接続するときには、Kerberos サービス名を設定します。この値は、接続先の MongoDB インスタンスに設定したサービス名と一致している必要があります。これは GSSAPI 認証メカニズムを使用する場合にのみ有効です。

SERVICE_NAME のデフォルトは、すべてのクライアントと MongoDB インスタンスに対して mongodb です。MongoDB インスタンスの saslServiceName 設定を変更する場合は、その設定に合わせて SERVICE_NAME を設定する必要があります。これは GSSAPI 認証メカニズムを使用する場合にのみ有効です。

CANONICALIZE_HOST_NAME:true|false
Kerberos サーバーに接続するときに、クライアント ホスト マシンのホスト名を正規化します。Kerberos データベースに登録されているものとは異なるホスト名がホストにより報告された場合に、この操作が必要になることがあります。デフォルトは false です。これは GSSAPI 認証メカニズムを使用する場合にのみ有効です。
SERVICE_REALM:<string>
MongoDB サービスの Kerberos レルムを設定します。この設定は、ユーザーとサービスのレルムが異なる場合などのクロスレルム認証のサポートに必要になることがあります。これは GSSAPI 認証メカニズムを使用する場合にのみ有効です。
AWS_SESSION_TOKEN:<security_token>
AssumeRole Amazon Web Servicesを使用する場合、一時的な認証情報で認証用の セッション トークンを設定します リクエスト、 またはAmazon Web Services この値を指定する リソース(Lambda など)を操作する場合。MONGODB-AWS認証メカニズムを使用する場合にのみ有効です。 Amazon Web ServicesアクセスキーIDとシークレット アクセスキーも必要です。 使用例については、「 Atlas への接続」を参照してください。
ENVIRONMENT:<string>

OpenID Connect (OIDC)環境を設定します。 用:

  • Microsoft Azure、 セット ENVIRONMENT:azure

  • Google Cloud Platform、 セット ENVIRONMENT:gcp

また、 authMechanismを に設定する必要があります。MONGODB-OIDC

gssapiServiceName

Kerberos 化された MongoDB インスタンスに接続するときには、Kerberos サービス名を設定します。この値は、接続先の MongoDB インスタンスに設定したサービス名と一致している必要があります。

gssapiServiceNameは、すべてのクライアントと MongoDB インスタンスに対してmongodbにデフォルト設定されています。 MongoDB インスタンスでsaslServiceName設定を変更する場合は、その設定に合わせてgssapiServiceNameを設定する必要があります。

gssapiServiceNameauthMechanismProperties=SERVICE_NAME:mongodbの非推奨のエイリアスです。 ドライバーがサポートするオプションと相互の優先順位の詳細については、ご希望のドライバー バージョンのドキュメントを参照してください。

MongoDB には、MongoDB ドライバーと mongos インスタンスによる読み取りまたは書込み(write)操作の送信先サーバーの選択方法を構成するために次のオプションが用意されています。

接続オプション
説明
localThresholdMS

複数の適切な MongoDB インスタンスから最適なものを選択するために使用されるレイテンシ ウィンドウのサイズ(ミリ秒単位)です。デフォルト: 15 ミリ秒。

すべてのドライバーは localThresholdMS を使用します。レイテンシ ウィンドウサイズを mongos に指定する場合は、 localThreshold エイリアスを使用してください。

serverSelectionTimeoutMS
例外をスローする前に、サーバー選択のために他の処理をブロックする時間(ミリ秒単位)を指定します。デフォルト: 30,000 ミリ秒。
serverSelectionTryOnce

シングルスレッド ドライバーのみtrue の場合、サーバー選択が失敗した後に MongoDB 配置を 1 回だけスキャンし、その後サーバーを選択するかエラーとするかを選択するようにドライバーに指示します。false の場合、ドライバーはブロックし、 serverSelectionTimeoutMS 値までサーバーを検索します。デフォルト: true

マルチスレッド ドライバーとmongos は、 serverSelectionTryOnceをサポートしていません。

heartbeatFrequencyMS

heartbeatFrequencyMS で、MongoDBデプロイ の状態がドライバーによりチェックされるタイミングを制御できます。チェックの終了から次のチェック開始までの間隔をミリ秒単位で指定できます。

デフォルト:

  • シングルスレッド ドライバー: 60 秒。

  • マルチスレッド ドライバー: 10 秒。

mongos は、ハートビート チェックの頻度の変更に対応していません。

socketCheckIntervalMS

シングルスレッド クライアントのみ。MongoDB 配置への TCP 接続の状態をクライアントが確認する頻度を調整します。値が低いほどクライアントがネットワークの問題を検出するまでの時間は短縮しますが、CPU の使用量は増えます。デフォルトは 5 秒です。

このオプションは一部のドライバーではサポートされません。詳細については、ドライバーのドキュメントを参照してください。

接続オプション
説明
appName

カスタム アプリ名を指定します。アプリ名は次の場所に表示されます。

appName接続オプションは次の OS で使用できます。

retryReads

再試行可能な読み取りを有効にします。

可能な値は次のとおりです。

  • trueで、接続の再試行可能な書き込みが有効になります。

    MongoDB 公式ドライバーのデフォルトは true です。

  • falseで、接続の再試行可能な書き込みが無効になります。

mongosh では、再試行可能な読み取りはサポートされていません。

retryWrites

再試行可能な書き込みを有効にします。

可能な値は次のとおりです。

  • trueで、接続の再試行可能な書き込み(write)が有効になります。

    MongoDB 公式ドライバーのデフォルトは true です。

  • falseで、接続の再試行可能な書き込み(write)が無効になります。

MongoDB ドライバーは、retryWrites の値に関係なく、トランザクション コミットと中止処理を再試行します。トランザクションの再試行可能性の詳細については、「トランザクション エラー処理」を参照してください。

uuidRepresentation

可能な値は次のとおりです。

standard
標準的なバイナリ表現。
csharpLegacy
C# ドライバーのデフォルト表現。
javaLegacy
Java ドライバーのデフォルト表現。
pythonLegacy
Python ドライバーのデフォルトの表現。

デフォルトについては、ドライバーのドキュメントを参照してください。

一部のドライバーは uuidRepresentation オプションをサポートしていません。お使いのドライバーの詳細については、該当ドライバーのドキュメントを参照してください。

loadBalanced

クライアントがロード バランサーに接続しているかどうかを指定します。デフォルトは false です。

このオプションは、次の要件を満たす場合にのみ、true に設定できます。

  • ホスト名は 1 つのみ指定します。

  • レプリカセットに接続していません。

  • srvMaxHosts オプションが設定されていないか、値が 0 になっています。

  • directConnection オプションが設定されていないか、値が false になっています。

srvMaxHosts
シャーディングされたトポロジに作成可能なmongos 接続数を指定します。接続数には負数以外の整数を指定します。デフォルト値の 0 を使用する場合、mongos の接続回数に制限はありません。

戻る

接続文字列