如何通过Django Migrations合规创建MySQL函数（替代手动改迁移文件）

针对你不想手动编辑空迁移文件的需求，这里提供几种适合生产环境的方案，让你可以像管理模型表一样通过migrate命令管理MySQL函数：

方案1：通过post_migrate信号自动创建函数 #

这种方式无需手动维护迁移文件，每次执行migrate后会自动检查并创建函数，确保函数存在：

1. 在你的应用目录下修改apps.py，添加信号处理逻辑：

from django.apps import AppConfig
from django.db.models.signals import post_migrate
from django.db import connection

def ensure_mysql_functions(sender, **kwargs):
    # 检查函数是否已存在，避免重复执行创建语句
    with connection.cursor() as cursor:
        db_name = connection.settings_dict['NAME']
        # 替换成你的函数名
        func_name = 'calculate_discount'
        cursor.execute("""
            SELECT COUNT(*) 
            FROM information_schema.ROUTINES 
            WHERE ROUTINE_SCHEMA = %s 
              AND ROUTINE_NAME = %s 
              AND ROUTINE_TYPE = 'FUNCTION'
        """, [db_name, func_name])
        
        if cursor.fetchone()[0] == 0:
            # 执行函数创建SQL
            cursor.execute("""
                CREATE FUNCTION calculate_discount(original_price DECIMAL(10,2), discount_rate INT)
                RETURNS DECIMAL(10,2)
                DETERMINISTIC
                BEGIN
                    RETURN original_price * (1 - discount_rate / 100);
                END
            """)

class MyAppConfig(AppConfig):
    default_auto_field = 'django.db.models.BigAutoField'
    name = 'myApp'

    def ready(self):
        post_migrate.connect(ensure_mysql_functions, sender=self)

2. 在settings.py的INSTALLED_APPS中替换应用的配置类：

INSTALLED_APPS = [
    # ... 其他应用
    'myApp.apps.MyAppConfig',  # 代替原来的'myApp'
]

此后每次执行python manage.py migrate，信号会自动触发，确保函数存在。

方案2：自定义命令自动生成函数迁移文件 #

如果你需要通过迁移文件严格管理函数的版本（支持回滚、版本控制），可以自定义一个manage.py命令，自动生成包含函数创建SQL的迁移文件：

1. 在应用目录下创建management/commands/make_function_migration.py（需先创建management和management/commands目录，并添加__init__.py）：

from django.core.management.base import BaseCommand
from django.core.management.commands.makemigrations import Command as MakeMigrationsCmd
from django.conf import settings
import os

class Command(BaseCommand):
    help = '自动生成包含MySQL函数创建逻辑的迁移文件'

    def add_arguments(self, parser):
        parser.add_argument('app_label', help='目标应用的标签')
        parser.add_argument('--sql', required=True, help='创建函数的SQL语句')
        parser.add_argument('--name', default='add_mysql_function', help='迁移文件名称前缀')

    def handle(self, *args, **options):
        app_label = options['app_label']
        func_sql = options['sql']
        migration_name = options['name']

        # 生成空迁移文件
        makemigrations_cmd = MakeMigrationsCmd()
        makemigrations_cmd.handle(
            app_label=app_label,
            empty=True,
            name=migration_name,
            no_input=True
        )

        # 定位到最新生成的迁移文件
        app_mig_dir = os.path.join(settings.BASE_DIR, app_label, 'migrations')
        migration_files = sorted(
            [f for f in os.listdir(app_mig_dir) if f.endswith('.py') and not f.startswith('_')]
        )
        latest_file = migration_files[-1]
        file_path = os.path.join(app_mig_dir, latest_file)

        # 修改迁移文件，添加RunSQL操作
        with open(file_path, 'r') as f:
            content = f.read()
        
        # 替换空的operations列表，reverse_sql用于回滚时删除函数
        updated_content = content.replace(
            'operations = []',
            f"operations = [\n    migrations.RunSQL('''{func_sql}''', reverse_sql='DROP FUNCTION IF EXISTS calculate_discount;'),\n]"
        )

        with open(file_path, 'w') as f:
            f.write(updated_content)

        self.stdout.write(self.style.SUCCESS(f'成功生成迁移文件：{latest_file}'))

2. 使用命令生成迁移：

python manage.py make_function_migration myApp --sql "CREATE FUNCTION calculate_discount(original_price DECIMAL(10,2), discount_rate INT) RETURNS DECIMAL(10,2) DETERMINISTIC BEGIN RETURN original_price * (1 - discount_rate / 100); END" --name add_calculate_discount

生成的迁移文件会自动包含RunSQL操作，执行python manage.py migrate即可创建函数，同时reverse_sql参数支持回滚时删除函数。

方案3：使用第三方工具（可选） #

如果你愿意引入第三方库，django-mysql提供了SQLFunction工具，可以在models.py中像定义模型字段一样声明MySQL函数，自动生成对应的迁移文件。不过如果不想依赖外部库，前两种方案更可控。

内容的提问来源于stack exchange，提问作者Charmi