AberSheeran
Aber Sheeran
I know nothing except the fact of my ignorance.

清理Django的迁移文件

起笔自
所属文集: 杂记
共计 1766 个字符
落笔于

这个问题其实要分两步,第一步是清理数据库中django_migrations这张表,第二步是重新生成迁移文件并且在不影响现有数据库结构的情况下实施到数据库中。

清理数据库中迁移记录

这里要分两种情况讨论,当你的迁移文件不小心丢失了一部分或者全部没了的时候,你需要手动去数据库里清空django_migrations这张表。

而如果你本地拥有完整的迁移文件,就可以使用Django自带的命令manage.py migrate --fake APP_NAME zero进行清理。参考 How to Reset Migrations 可以得知,使用manage.py migrate --fake APP_NAME zero可以清理对应的迁移文件依赖,并且将它们从数据库里的django_migrations表里删除。

migrate --fake

根据 Django Document 的描述,当执行manage.py migrate --fake时,它并不会真的去运行SQL,只是把对应的迁移文件给填充进数据库中django_migrations这张表里。

当然,在运行此命令之前,你必须保证迁移文件与数据库结构吻合。

封装成命令

对于某些爱好清理迁移文件以保持整个项目的迁移文件看起来很干净的人来说,一键清理很必要。

在任意一个(只需要一个就够了)APP里,新建立如上图的结构,并且在clearmigrations.py文件里写入以下内容

import os
import sys
import shutil
from django.core.management.base import BaseCommand, CommandError
from django.conf import settings


class Command(BaseCommand):
    help = 'Clear all migration files in project.'

    def handle(self, *args, **options):

        def get_app():
            for app in settings.INSTALLED_APPS:
                path = os.path.join(settings.BASE_DIR, app.replace(".", "/"), "migrations")
                if os.path.exists(path):
                    yield app, path

        def clear(path):
            shutil.rmtree(path)
            os.makedirs(path)
            with open(os.path.join(path, "__init__.py"), "w+") as file:
                pass
            self.stdout.write(self.style.SUCCESS(f"Clear {path}"))

        for app, path in get_app():
            os.system(f"{sys.executable} manage.py migrate --fake {app} zero")

        for app, path in get_app():
            clear(path)

        self.stdout.write(self.style.SUCCESS('Successfully cleared!'))

然后当你执行python manage.py clearmigrations的时候,就会自动的从数据库和本地清除迁移文件了。

如果你觉得本文值得,不妨赏杯茶
给CharField定义更优雅的Choice
文件自动同步七牛云