【初心者向け】Djangoのsavepoint_rollback()でトランザクションを理解し、データベース操作をもっと便利に

仕組み

Djangoでは、@transaction.atomicデコレータを使用してトランザクションを管理します。このデコレータで修飾された関数内では、データベース操作が実行され、問題なく完了すれば自動的にコミットされます。しかし、操作中にエラーが発生した場合、トランザクション全体が自動的にロールバックされます。

しかし、場合によっては、トランザクションの一部のみをロールバックし、残りの操作をコミットしたいことがあります。そのような状況で役立つのがsavepoint機能です。savepointは、トランザクション内の特定の時点をマーカーとして設定し、その時点まで実行された操作を独立してロールバックできる機能です。

django.db.transaction.savepoint_rollback()関数は、このsavepoint機能を使用して、指定されたsavepointまでのデータベース操作をロールバックします。

使い方

django.db.transaction.savepoint_rollback()関数は、以下の引数を取ります。

sid: ロールバック対象のsavepointID

この関数は、以下の手順で呼び出されます。

savepointを作成します。
データベース操作を実行します。
エラーが発生した場合、savepoint_rollback()を使用して、その時点までの操作をロールバックします。
問題なく完了した場合は、トランザクションをコミットします。

例

from django.db import transaction

def my_view(request):
    try:
        # savepointを作成
        sid = transaction.savepoint()

        # データベース操作1
        # ...

        # データベース操作2
        # ...

        # 問題なく完了
        transaction.savepoint_commit(sid)
    except Exception as e:
        # エラーが発生
        transaction.savepoint_rollback(sid)
        raise e

savepointを複数回作成し、それぞれ異なる操作をロールバックすることができます。
savepointは、ネストしたトランザクション内でのみ使用できます。
savepoint機能は、PostgreSQL 8以降でのみサポートされています。

from django.db import transaction

def process_order(order_id):
    try:
        # savepointを作成
        sid = transaction.savepoint()

        # 顧客情報更新
        customer = Customer.objects.get(pk=order.customer_id)
        customer.balance -= order.total_price
        customer.save()

        # 在庫更新
        for item in order.items.all():
            item.stock -= item.quantity
            item.save()

        # 注文確定
        order.status = Order.STATUS_CONFIRMED
        order.save()

        # 問題なく完了
        transaction.savepoint_commit(sid)
    except Exception as e:
        # エラーが発生
        transaction.savepoint_rollback(sid)
        raise e

このコードでは、注文処理を以下のステップに分割しています。

顧客情報更新
在庫更新
注文確定

これらのステップのうち、いずれか1つでもエラーが発生した場合、savepoint_rollback()を使用して、顧客情報と在庫の更新をロールバックし、注文を確定しない状態に戻します。

例2：銀行振替システムにおける送金処理

この例では、銀行振替システムにおける送金処理を想定し、送金の一部をロールバックするシナリオを紹介します。

from django.db import transaction

def transfer_money(from_account_id, to_account_id, amount):
    try:
        # savepointを作成
        sid = transaction.savepoint()

        # 送金元口座から出金
        from_account = Account.objects.get(pk=from_account_id)
        from_account.balance -= amount
        from_account.save()

        # 送金先口座に入金
        to_account = Account.objects.get(pk=to_account_id)
        to_account.balance += amount
        to_account.save()

        # 送金完了
        transaction.savepoint_commit(sid)
    except Exception as e:
        # エラーが発生
        transaction.savepoint_rollback(sid)
        raise e

送金元口座から出金
送金先口座に入金
送金完了

これらのステップのうち、いずれか1つでもエラーが発生した場合、savepoint_rollback()を使用して、出金と入金の操作をロールバックし、送金が完了しない状態に戻します。

上記の例はあくまでも一例であり、実際の用途に合わせてコードを調整する必要があります。また、savepoint機能は、複雑なトランザクション処理を扱う場合に特に有効です。

savepointを複数回作成し、それぞれ異なる操作をロールバックすることができます。
savepointは、ネストしたトランザクション内でのみ使用できます。
savepoint機能は、PostgreSQL 8以降でのみサポートされています。
上記のコードはあくまで例であり、実際の用途に合わせて修正する必要があります。

ネストしたトランザクションを使用する

ネストしたトランザクションを使用すれば、外側のトランザクションで全体を制御し、内側のトランザクションで個別の操作を管理することができます。内側のトランザクションでエラーが発生した場合、そのトランザクションのみをロールバックし、外側のトランザクションはコミットすることができます。

from django.db import transaction

def my_view(request):
    try:
        # 外部トランザクションを開始
        with transaction.atomic():
            # 内部トランザクションを開始
            with transaction.atomic():
                # データベース操作1
                # ...

                # データベース操作2
                # ...

            # 内部トランザクションをコミット
            transaction.savepoint_commit()
    except Exception as e:
        # 外部トランザクションをロールバック
        transaction.rollback()
        raise e

この例では、my_view()関数内で2つのトランザクションをネストしています。データベース操作1とデータベース操作2は、内側のトランザクションで実行されます。もしデータベース操作2でエラーが発生した場合、内側のトランザクションのみがロールバックされ、データベース操作1はコミットされた状態になります。

例外処理を使用する

例外処理を使用して、エラー発生時に個別の操作をロールバックすることもできます。

from django.db import transaction

def my_view(request):
    try:
        # データベース操作1
        # ...

        # データベース操作2
        # ...
    except Exception as e:
        # エラーが発生
        # ロールバック処理を実行
        # ...
        raise e

この例では、my_view()関数内で2つのデータベース操作を実行しています。もしデータベース操作2でエラーが発生した場合、exceptブロック内の処理が実行されます。この処理内で、ロールバック処理を実行することができます。

どちらの方法を選択するべきか

どちらの方法を選択するかは、状況によって異なります。

例外処理は、シンプルなトランザクション処理を扱う場合や、ロールバック処理の内容が複雑でない場合に適しています。
ネストしたトランザクションは、より複雑なトランザクション処理を扱う場合に適しています。

上記以外にも、以下の方法でdb.transaction.savepoint_rollback()の機能を代替することができます。

データベースライブラリの提供するロールバック機能を使用する
カスタムトランザクションマネージャーを使用する