接続文字列オプション

replicaSet

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

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

directConnection

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

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

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

重要:レプリカセットがDockerで実行される場合、公開されるMongoDBエンドポイントは 1 つだけになる可能性があります。この場合、レプリカセットは検出できず、directConnection=false を指定するとアプリケーションがそのレプリカセットに接続できなくなる可能性があります。

テスト環境または開発環境では、接続 URI で directConnection=true を指定するとレプリカセットに接続できます。本番環境では、Docker 仮想ネットワークの外部から各 MongoDB インスタンスにアクセスできるようにクラスターを構成することを推奨します。

w

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

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

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

wtimeoutMS

重要: wtimeoutMSオプションは非推奨です。代わりに を設定してください。 はtimeoutMS timeoutMSwtimeoutMSを優先します。

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

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

journal

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

journal を true に設定し、w の値を 1 未満に指定すると、journal が優先されます。

readConcernLevel

分離レベル 。次のいずれかの値を受け入れます。

• local

• majority

• linearizable

• available

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

readPreference

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

• primary（デフォルト）

• primaryPreferred

• secondary

• secondaryPreferred

• nearest

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

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

maxStalenessSeconds

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

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

maxStalenessSecondsの最小値は90 秒です。0 90秒から 秒の間の値を指定するとエラーが発生します。 MongoDBドライバーは、maxStalenessSeconds の 値を-1 "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() を参照してください。

authSource

ユーザーの認証情報に関連付けられているデータベース名。デフォルトは、指定されている場合は defaultauthdb、それ以外の場合はデフォルトで admin になります。

、 、 メカニズムでは、認証情報のストレージを外部サービスに委任するため、 をPLAIN GSSAPIMONGODB-AWSauthSourceに設定する必要があります。$external

接続文字列または 経由でユーザー名が指定されていない場合、authSource MongoDB は--username を無視します。

authMechanism

デフォルト: SCRAM-SHA-256

接続の認証メカニズム。明示的な 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 の mongod と mongos インスタンスによってのみ提供されます。

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

を使用するには、MONGODB-AWS AWS IAM 認証情報（ AWSアクセスキーIDとシークレット アクセスキー、および任意でAWSセッション トークン ）による認証をサポートするように構成されたMongoDB Atlasクラスターに接続する必要があります。MONGODB-AWS 認証メカニズムでは、 をauthSource $externalに設定する必要があります。

AWSアクセスキーID、シークレット アクセスキー、またはセッション トークンが、それぞれのAWS IAM 環境変数を使用してプラットフォーム上で定義されている場合、mongosh はこれらの環境変数値を使用して自動的に認証を行います。接続文字列で指定する必要はありません。配置環境とセキュリティ要件に応じて、 AWS認証情報を提供する他の方法があります。

MONGODB-AWS認証メカニズムの使用例については、接続文字列を参照してください。

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

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リクエストを使用する場合、またはこの値を指定するAWSリソース（ Lambdaなど）と連携する場合、一時的な認証情報を使用して認証用のAWSセッションMONGODB-AWS トークンを設定します。 認証メカニズムを使用する場合にのみ有効です。 AWSアクセスキーIDとシークレット アクセスキーも必要です。使用例については、「 接続文字列 」を参照してください。

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 を設定する必要があります。

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