Django マイグレーションで django.db.migrations.operations.RunPython を使いこなす

Django の django.db.migrations.operations.RunPython とは？

django.db.migrations.operations.RunPython は、Django のマイグレーションで Python コードを実行 するための操作です。データベーススキーマの変更だけでなく、データの移行やその他のカスタム処理にも使用できます。

主な用途

• データベーススキーマの変更に伴うデータ移行
• カスタムの初期データ作成
• トリガーやストアドプロシージャの作成
• その他、マイグレーションで実行したい任意の処理

利点

• データベーススキーマの変更とデータ移行をまとめて行える
• マイグレーションの自動化に役立つ
• 複雑なデータ移行処理を柔軟に記述できる

注意点

• 誤ったコードを実行すると、データ損失などの問題が発生する可能性がある
• コードの内容は、マイグレーションを実行するすべての環境で互換性がある必要がある
• 使用には注意が必要

実行方法

RunPython 操作は、マイグレーションファイルの中で以下の形式で記述します。

from django.db import migrations

def forwards(apps, schema_editor):
    # マイグレーション適用時の処理
    # ...

def backwards(apps, schema_editor):
    # マイグレーションロールバック時の処理
    # ...

class Migration(migrations.Migration):

    dependencies = [
        # 依存関係のあるマイグレーション
    ]

    operations = [
        migrations.RunPython(
            forwards_func=forwards,
            backwards_func=backwards,
        ),
    ]

• forwards_func: マイグレーション適用時に実行される関数
• backwards_func: マイグレーションロールバック時に実行される関数

コード例

データ移行

def forwards(apps, schema_editor):
    # すべてのユーザーの年齢を10歳増加させる
    User = apps.get_model('auth', 'User')
    for user in User.objects.all():
        user.age += 10
        user.save()

def backwards(apps, schema_editor):
    # すべてのユーザーの年齢を10歳減少させる
    User = apps.get_model('auth', 'User')
    for user in User.objects.all():
        user.age -= 10
        user.save()

カスタム初期データ作成

def forwards(apps, schema_editor):
    # 新しいカテゴリを作成
    Category.objects.create(name='その他')

def backwards(apps, schema_editor):
    # カテゴリを削除
    Category.objects.filter(name='その他').delete()

• RunPython 操作は、データベースバックエンドによってはサポートされていない場合があります。
• 複雑な処理を行う場合は、RunPython 操作ではなく、別の方法を検討することも必要です。

Django の django.db.migrations.operations.RunPython サンプルコード集

データ移行

データ型の変更

def forwards(apps, schema_editor):
    # フィールドのデータ型を `CharField` から `TextField` に変更
    MyModel = apps.get_model('myapp', 'MyModel')
    MyModel._meta.get_field('description').alter(
        db_type='text',
    )

def backwards(apps, schema_editor):
    # フィールドのデータ型を `TextField` から `CharField` に変更
    MyModel = apps.get_model('myapp', 'MyModel')
    MyModel._meta.get_field('description').alter(
        db_type='string',
        max_length=255,
    )

データの追加

def forwards(apps, schema_editor):
    # 新しいユーザーを作成
    User = apps.get_model('auth', 'User')
    User.objects.create_superuser(
        username='admin',
        email='[email protected]',
        password='password',
    )

def backwards(apps, schema_editor):
    # ユーザーを削除
    User = apps.get_model('auth', 'User')
    User.objects.filter(username='admin').delete()

データの削除

def forwards(apps, schema_editor):
    # 古いデータを削除
    MyModel = apps.get_model('myapp', 'MyModel')
    MyModel.objects.filter(created_at__lt=datetime.date(2023, 1, 1)).delete()

def backwards(apps, schema_editor):
    # データを復元 (不可能な場合が多い)
    # ...

カスタム初期データ作成

def forwards(apps, schema_editor):
    # 設定ファイルから読み込んだデータに基づいて、初期データを生成
    from myapp.utils import load_initial_data
    load_initial_data()

def backwards(apps, schema_editor):
    # 初期データを削除
    # ...

トリガーの作成

def forwards(apps, schema_editor):
    # 新しいトリガーを作成
    connection = schema_editor.connection
    with connection.cursor() as cursor:
        cursor.execute("""
            CREATE TRIGGER my_trigger
            AFTER INSERT ON myapp_mymodel
            FOR EACH ROW
            BEGIN
                # トリガー処理
            END;
        """)

def backwards(apps, schema_editor):
    # トリガーを削除
    connection = schema_editor.connection
    with connection.cursor() as cursor:
        cursor.execute("""
            DROP TRIGGER my_trigger
            ON myapp_mymodel;
        """)

データ移行

• Django のデータ移行ツール: ./manage.py migrate --fake コマンドを使用して、ダミーマイグレーションを作成し、その中でデータ移行処理を実装できます。
• カスタムコマンド: ./manage.py コマンドで実行できるカスタムコマンドを作成し、その中でデータ移行処理を実装できます。
• サードパーティ製ライブラリ: django-migration-fixtures などのライブラリを使用して、データ移行を管理できます。

• カスタムモデル: データベーススキーマの変更に伴う処理は、カスタムモデルの save() メソッドなどで実装できます。
• ストアドプロシージャ: 複雑な処理は、データベースのストアドプロシージャとして実装できます。

以下は、それぞれの方法の利点と欠点です。