トランザクションとセッション

Overview

このガイドでは、 MongoDB PHPライブラリを使用してトランザクションを実行する方法を学習できます。 トランザクションを使用すると、トランザクション全体がコミットされた場合にのみ、データを変更する一連の操作を実行できます。 トランザクション内のいずれかの操作が成功しない場合、ライブラリはトランザクションを停止し、変更が反映される前にすべてのデータ変更を破棄します。 この特徴はアトミック性と 呼ばれます。

MongoDB では、トランザクションは論理セッション内で実行されます。 セッションは 、順番に実行されるよう関連付けられた読み取り操作または書き込み操作のグループです。 セッションにより、一連の操作に対する 因果整合性 が有効になり、 ACID 準拠のトランザクション（アトミック性、整合性、分離、耐久性の期待を満たすトランザクション）内で操作を実行できるようになります。 MongoDBは、トランザクション操作で予期せぬエラーが発生した場合でも、その操作に関わるデータの一貫性が保たれることを保証します。

MongoDB PHPライブラリを使用すると、 MongoDB\Clientインスタンスから新しいセッションを作成できます。 その後、結果のMongoDB\Driver\Sessionインスタンスを使用してトランザクションを実行できます。

トランザクション API

このセクションでは、 MongoDB PHPライブラリが提供するトランザクション API について学習できます。 トランザクションを開始する前に、 ClientインスタンスでMongoDB\Client::startSession()メソッドを使用してSessionを作成する必要があります。 その後、次のいずれかの API を使用してトランザクションを実行できます。

• Convenient API

• Core API

トランザクションの例

この例では、金融トランザクションのためにbankデータベースのコレクション内のデータを変更するコールバック関数を定義します。 このコードは、次のアクションを実行します。

• ターゲット コレクションにアクセスするためのCollectionインスタンスを作成します。

• アカウント間で転送されるアカウント番号と金額を指定します。

• コールバック関数を定義します。この関数は、 Sessionインスタンスをパラメータとして受け取ります。

• 送金を反映するようにカスタマーの残高を更新します。

• トランザクションの受信をタイムスタンプとともに記録します。

• トランザクションが正常にコミットされた場合は、メッセージを出力します。

$receipts = $client->bank->receipts;
$checking = $client->bank->checking_accounts;
$saving = $client->bank->saving_accounts;
$accountId = '5678';
$transferAmount = 1000.0;
$callback = function (MongoDB\Driver\Session $session) use (
    $checking,
    $saving,
    $receipts,
    $accountId,
    $transferAmount,
): void {
    $checking->updateOne(
        ['account_id' => $accountId],
        ['$inc' => ['balance' => -$transferAmount]],
        ['session' => $session],
    );
    $saving->updateOne(
        ['account_id' => $accountId],
        ['$inc' => ['balance' => $transferAmount]],
        ['session' => $session],
    );
    $summary = sprintf('SAVINGS +%1$u CHECKING -%1$u', $transferAmount);
    $receipts->insertOne(
        [
            'account_id' => $accountId,
            'summary' => $summary,
            'timestamp' => new MongoDB\BSON\UTCDateTime(),
        ],
        ['session' => $session],
    );
    echo 'Successfully performed transaction!', PHP_EOL;
    echo 'Summary: ', $summary, PHP_EOL;
};

次に、次のコードを実行してトランザクションを実行します。 このコードは、次のアクションを完了します。

1. startSession()メソッドを使用してクライアントからセッションを作成します。

2. セッションとコールバックをパラメータとして渡して、トランザクションを管理するためにwith_transaction()関数を呼び出します。

$session = $client->startSession();
try {
    MongoDB\with_transaction($session, $callback);
} catch (MongoDB\Driver\Exception\RuntimeException $e) {
    echo 'Caught exception: ', $e->getMessage(), PHP_EOL;
}

Successfully performed transaction!
Summary: SAVINGS +1000 CHECKING -1000

詳細情報

このガイドで言及されている概念の詳細については、 MongoDB Serverマニュアルの次のページ を参照してください。

• トランザクション

• サーバー セッション

• 読み取りの分離、整合性、最新性

ACID compliance の詳細については、 「 データベース管理システムの ACID プロパティとは 」を参照してください。 MongoDB Webサイトの記事。

挿入操作の詳細については、ドキュメントの挿入ガイドを参照してください。