Mongo.startSession()

項目一覧

定義

Mongo.startSession(<options>)

接続のためにセッションを開始します。 mongoshは、セッションに関連付けられたコマンドにセッション ID を割り当てます。

このページでは、mongosh メソッドについて記載しています。ただし、データベースコマンドや Node.js などの言語固有のドライバーのドキュメントには該当しません。

データベースコマンドについては、startSession コマンドを参照してください。

MongoDB API ドライバーについては、各言語の MongoDB ドライバードキュメントを参照してください。

セッションは、セッションを作成したMongoClientオブジェクトでのみ使用できます。 1 つのセッションを同時に使用することはできません。 1 つのセッションを使用する操作は連続して実行する必要があります。

startSession()メソッドは、セッションオプションを持つドキュメントを取ることができます。使用可能なオプションは次のとおりです。

フィールド

説明

因果整合性

ブール値。セッションの因果整合性を有効または無効にします。 Mongo.startSession()causalConsistencyはデフォルトでを有効にします。snapshot と排他関係にあります。

セッションを開始した後は、そのcausalConsistency設定を変更することはできません。

Mongo()接続オブジェクトで因果整合性が無効になっている場合でも、セッションでは因果整合性が有効になっている場合や、接続オブジェクトに因果整合性を設定するには、 Mongo.setCausalConsistency()を参照してください。

ReadConcern

ドキュメント。読み取り保証 ( read concern) を指定します。

readPreference

ドキュメント。読み込み設定 ( read preference) を指定します。

readPreference ドキュメントには、 modeフィールドと任意のtagsフィールドが含まれています。

{ mode: <string>, tags: <array> }

retryWrites

ブール値。一時的なネットワークエラーが発生したときに書き込みを再試行する機能を有効または無効にします。

セッションを開始した後は、そのretryWrites設定を変更することはできません。

スナップショット

ブール値。 MongoDB 5.0 + 配置のセッションのスナップショット読み取りを有効にします。 causalConsistencyと排他関係にあります。

writeConcern

ドキュメント。書込み保証 ( write concern) を指定します。

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

このコマンドは、すべての MongoDB Atlas クラスターでサポートされています。すべてのコマンドに対する Atlas のサポートについては、「サポートされていないコマンド」を参照してください。

次の例では、Mongo() mongoshのグローバルdb 変数に関連付けられている接続オブジェクトで因果整合性と再試行可能な書き込みが有効になっているセッションを起動します。

db = db.getMongo().startSession({retryWrites: true, causalConsistency: true}).getDatabase(db.getName());

戻る

Mongo.setReadPref

Mongo.setWriteConcern