SessionOptions

定義

SessionOptions

sessionのmongosh のオプション。SessionOptions()オブジェクトにアクセスするには、 Session.getOptions()メソッドを使用します。

使用可能なセッション オプションは次のとおりです。

オプション	説明
causalConsistency	ブール値。 セッションの因果整合性を有効または無効にします。 セッションを手動で開始するときに、 オプションを明示的に設定できます。 Session = db.getMongo().startSession( { causalConsistency: true } )
readConcern	ドキュメント。 読み取り保証 ( read concern) を指定します。 mongoshでは、 Mongo.startSession()を実行するときに オプションを設定できます。 次の方法でもreadConcernオプションにアクセスすることもできます。 Session.getOptions().getReadConcern() Session.getOptions().setReadConcern(<document>)
readPreference	ドキュメント。 読み込み設定 ( read preference) を指定します。 mongoshでは、 Mongo.startSession()を実行するときに オプションを設定できます。 次の方法でもreadPreferenceオプションにアクセスすることもできます。 Session.getOptions().getReadPreference() Session.getOptions().setReadPreference({ mode: <string>, tags: <array>})
retryWrites	ブール値。 フェイルオーバー中など一時的なネットワークエラーが発生した場合に書き込みを再試行する機能を有効または無効にします。 書込みの再試行を有効にするには、 オプションを使用してmongosh --retryWritesを開始します。 retryWritesがセッションで有効になっているかどうかは、次の方法で確認できます。 Session.getOptions().shouldRetryWrites()
writeConcern	ドキュメント。 書込み保証 ( write concern) を指定します。 mongoshでは、 Mongo.startSession()を実行するときにオプションを設定できます。 次の方法でもwriteConcernオプションにアクセスすることもできます。 Session.getOptions().getWriteConcern() Session.getOptions().setWriteConcern(<document>)

どのオプションがセッションで有効になっているか確認するには、 Session.getOptions()を実行します。

互換性

このメソッドは、次の環境でホストされている配置で使用できます。

• MongoDB Atlas はクラウドでの MongoDB 配置のためのフルマネージド サービスです

• MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン

• MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン