接続文字列オプション

replicaSet

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

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

directConnection

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

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

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

w

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

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

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

wtimeoutMS

書き込み保証（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 ドライバーは、-1 の maxStalenessSeconds 値を "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

ユーザーの認証情報に関連付けられたデータベース名を指定します。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 の mongod と mongos インスタンスによってのみ提供されます。

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

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