如何重命名Wagtail StreamField父块且不丢失数据？

当然可以实现——直接修改模型后生成默认迁移会丢失数据，但通过扩展Wagtail的迁移辅助类或手动调整迁移逻辑，就能安全完成父块重命名并保留所有数据。以下是两种实用方案：

方案一：自定义块迁移处理器 #

Wagtail的BlockMigrationHandler体系支持扩展，用来处理顶级块的slug重命名：

1. 先修改模型中的块slug（比如把原来的stream1父块改成new_parent_block）：

from wagtail.fields import StreamField
from wagtail.blocks import StructBlock, CharBlock

class BlogPage(Page):
    content = StreamField([
        # 原父块slug是'stream1'，现在替换为'new_parent_block'
        ('new_parent_block', StructBlock([
            ('field1', CharBlock()),
        ])),
    ], use_json_field=True)

2. 运行python manage.py makemigrations生成初始迁移文件。此时生成的迁移只会修改字段结构，不会处理旧数据的块slug，所以需要手动编辑迁移文件。

3. 在迁移文件中添加自定义的迁移处理器，替换旧的块slug：

from django.db import migrations
from wagtail.fields import StreamField
from wagtail.blocks import BlockMigrationHandler

class RenameTopLevelBlockHandler(BlockMigrationHandler):
    def apply(self, value):
        # 遍历StreamField中的所有块条目
        if isinstance(value, list):
            updated_blocks = []
            for block in value:
                if block['type'] == 'stream1':
                    # 替换块类型slug为新名称
                    updated_block = block.copy()
                    updated_block['type'] = 'new_parent_block'
                    updated_blocks.append(updated_block)
                else:
                    updated_blocks.append(block)
            return updated_blocks
        return value

def migrate_streamfield_data(apps, schema_editor):
    BlogPage = apps.get_model('your_app', 'BlogPage')
    # 批量处理所有页面的StreamField数据
    for page in BlogPage.objects.all():
        if page.content:
            page.content = RenameTopLevelBlockHandler().apply(page.content)
            page.save(update_fields=['content'])

class Migration(migrations.Migration):
    dependencies = [
        # 替换为你当前应用的上一个迁移编号
        ('your_app', '0001_initial'),
    ]

    operations = [
        # 保留自动生成的AlterField操作
        migrations.AlterField(
            model_name='blogpage',
            name='content',
            field=StreamField([('new_parent_block', StructBlock([('field1', CharBlock())]))], use_json_field=True),
        ),
        # 添加数据迁移的Python操作
        migrations.RunPython(migrate_streamfield_data),
    ]

方案二：直接用SQL批量替换JSON数据 #

如果你的StreamField启用了use_json_field=True（Wagtail 2.15+默认开启），可以用SQL直接替换JSON中的块slug，操作更高效：

1. 同样先修改模型中的块slug，生成初始迁移文件。

2. 编辑迁移文件，添加RunSQL操作来批量替换数据：

from django.db import migrations

class Migration(migrations.Migration):
    dependencies = [
        ('your_app', '0001_initial'),
    ]

    operations = [
        migrations.AlterField(
            model_name='blogpage',
            name='content',
            field=StreamField([('new_parent_block', StructBlock([('field1', CharBlock())]))], use_json_field=True),
        ),
        # 执行SQL替换JSON中的旧块slug
        migrations.RunSQL(
            "UPDATE your_app_blogpage SET content = REPLACE(content, '\"type\": \"stream1\"', '\"type\": \"new_parent_block\"');"
        ),
    ]

关键注意事项 #

• 执行迁移前一定要备份数据库，避免操作失误导致数据丢失。
• 如果StreamField包含多层嵌套块，方案一的apply方法需要递归处理嵌套结构，但顶级父块重命名通常不需要。
• 如果你的StreamField还在使用Pickle存储（use_json_field=False），不能用方案二的SQL替换，必须用方案一的Python处理器来解析Pickle数据。

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