Django与PostgreSQL中GeneratedField报错的解决方案咨询

问题说明 #

在PostgreSQL中使用Django的GeneratedField时，频繁遇到以下错误：

django.db.utils.ProgrammingError: generation expression is not immutable

这是因为PostgreSQL有明确限制：

PostgreSQL要求生成列中引用的函数和运算符标记为IMMUTABLE。

比如使用Func()调用age或date_part这类默认是STABLE的数据库函数时，就会触发错误：

from django.db.models import Func, Value, IntegerField, GeneratedField, DateTimeField

age_func = Func("date_of_birth", function="age")
age_years = Func(Value("year"), age_func, function="date_part", output_field=IntegerField())

# 以下字段会触发错误
class Person(models.Model):
    date_of_birth = DateTimeField()
    age_years = GeneratedField(expression=age_years, db_persist=True)

类似的，直接使用Concat()函数也会出现相同问题（Django 5.1+已内置解决方案）。

解决方案 #

方法1：通过Django迁移创建IMMUTABLE包装函数 #

由于PostgreSQL要求生成列的表达式必须使用IMMUTABLE函数，而像age、date_part这类系统函数默认是STABLE的，我们可以创建一个IMMUTABLE的包装函数，通过Django迁移部署到数据库中，再在模型里调用这个包装函数。

1. 创建空迁移文件
   运行命令生成一个空的迁移：

python manage.py makemigrations --empty your_app_name

2. 编写迁移逻辑
   在生成的迁移文件中，添加创建IMMUTABLE包装函数的SQL操作：

from django.db import migrations

class Migration(migrations.Migration):
    dependencies = [
        ('your_app_name', '0001_initial'),  # 替换为实际的依赖迁移
    ]

    operations = [
        # 创建包装date_part的IMMUTABLE函数
        migrations.RunSQL(
            sql="""
            CREATE OR REPLACE FUNCTION immutable_date_part(part text, dt timestamp)
            RETURNS double precision AS $$
            SELECT date_part($1, $2);
            $$ LANGUAGE sql IMMUTABLE;
            """,
            reverse_sql="DROP FUNCTION IF EXISTS immutable_date_part(text, timestamp);"
        ),
        # 若需要包装age函数，可添加类似的SQL
        migrations.RunSQL(
            sql="""
            CREATE OR REPLACE FUNCTION immutable_age(dt timestamp)
            RETURNS interval AS $$
            SELECT age($1);
            $$ LANGUAGE sql IMMUTABLE;
            """,
            reverse_sql="DROP FUNCTION IF EXISTS immutable_age(timestamp);"
        ),
    ]

3. 在模型中使用自定义函数
   创建对应的Func子类来调用这些IMMUTABLE包装函数：

from django.db.models import Func, IntegerField, DateTimeField, GeneratedField, Value

class ImmutableDatePart(Func):
    function = 'immutable_date_part'
    output_field = IntegerField()

class Person(models.Model):
    date_of_birth = DateTimeField()
    age_years = GeneratedField(
        expression=ImmutableDatePart(Value('year'), 'date_of_birth'),
        output_field=IntegerField(),
        db_persist=True,
    )

方法2：重写Func类（针对自定义函数） #

如果你自己定义了数据库函数，且可以安全标记为IMMUTABLE，但Django默认没有指定，可通过重写Func的as_sql方法，在生成SQL时显式声明函数的稳定性（仅适用于确实符合IMMUTABLE定义的函数，否则会导致数据不一致）：

from django.db.models import Func, IntegerField

class MyImmutableFunc(Func):
    function = 'my_custom_function'
    output_field = IntegerField()

    def as_sql(self, compiler, connection):
        sql, params = super().as_sql(compiler, connection)
        # 仅针对PostgreSQL添加IMMUTABLE标记
        if connection.vendor == 'postgresql':
            sql = f"{sql} IMMUTABLE"
        return sql, params

注意事项 #

• 只有当函数的输出完全由输入决定、不依赖任何外部状态（如当前时间、数据库数据变化）时，才能标记为IMMUTABLE，否则会导致生成列的数据不一致。
• Django 5.1+已针对Concat()等常用函数内置了IMMUTABLE支持，无需手动处理。

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