2020-12-08 Django Migrations 初探

问题背景

在对django项目进行版本控制的时候,因为在编写app的某些阶段会涉及到一些manage=False的旧数据表,这时必须手动使用navicat/执行sql语句进行数据库迁移
这样一来导致一部分models使用migrations可以执行自动迁移,另一部分models则需要手动同步数据库,由于对django项目数据库迁移多人协作最佳的工作流程目前还不是很明确,以及不同models之间相互的引用耦合,在下拉更新后执行migrate的时候总会出现一些奇奇怪怪的依赖问题。这次希望通过重新构建以及整理一遍migrations的流程,探索一下在版本控制下的最佳的迁移流程。

问题一:如何重置migrations,让每个app的migrations的依赖关系更加明确

1. 查看当前迁移状态

python manage.py showmigrations
其中展示的信息为当前项目INSTALLED_APPS中所有的app的迁移文件的列表, 其中[X]代表已经migrate了的migration
优先列出项目内创建的app的migrations(字母顺序) ,其次列出引用外部的app的migrations(字母顺序)

# my_project/my_project/settings.py
INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'rest_framework',
    'rest_framework.authtoken', # TOKEN 验证
    'django_filters', # 查询
    
    'django_celery_results', # Celery result backend
    'django_celery_beat', # Celery beat
    
    'my_app_1',
    'my_app_2',
]
$ python manage.py showmigrations
my_app_1
 [X] 0001_initial
 [X] 0002_some_migrations
 [ ] 0003_some_migrations
 [ ] 0004_some_migrations
 [ ] 0005_some_migrations
my_app_2
 [X] 0001_initial
 [X] 0002_some_migrations
 [X] 0003_some_migrations
 [ ] 0004_some_migrations
admin
 [X] 0001_initial
auth
 [X] 0001_initial
authtoken
 [X] 0001_initial
contenttypes
 [X] 0001_initial
django_celery_beat
 [X] 0001_initial
django_celery_results
 [X] 0001_initial
sessions
 [X] 0001_initial

2. 重置迁移状态

$ python manage.py runserver 确保程序在当前状态是可以执行的
如果报错则先对某些指定的app进行migrate$ python manage.py migrate <APP_NAME>之后再进行下一步操作
$ python manage.py migrate --fake <APP_NAME> zero 将某个app的迁移状态全部标记为未执行,即把上面所有的[X]全部变为[ ]

3. 删除迁移文件

将所有的迁移文件删除

  • 对于项目内构建的app,默认位置在my_project/<APP_NAME>/migrations/内,可以将整个migrations文件夹删除,或者建议用文件夹改名的方式之后如果报错还可以还原
    之后观察$ python manage.py showmigrations 在对应的app位置会显示没有任何migtrations
  • 对于第三方app,则在当前运行环境的site-packages/<APP_FULL_PATH>/migrations/`内,可以将整个migrations文件夹删除,或者建议用文件夹改名的方式之后如果报错还可以还原

注: 引用的app的APP_NAME为实际app的名称,不需要加全地址,例如django.contrib.admin 的APP_NAME为 admin

4. 重新构建迁移文件

$ python manage.py makemigrations / $ python manage.py makemigrations <APP_NAME>
注: 引用的app的APP_NAME为实际app的名称,不需要加全地址,例如django.contrib.admin 的APP_NAME为 admin
对所有app进行构建之后变成这样:每个app只有一个initial的migration,舒服了!

$ python manage.py showmigrations
my_app_1
 [ ] 0001_initial
my_app_2
 [ ] 0001_initial
admin
 [ ] 0001_initial
auth
 [ ] 0001_initial
authtoken
 [ ] 0001_initial
contenttypes
 [ ] 0001_initial
django_celery_beat
 [ ] 0001_initial
django_celery_results
 [ ] 0001_initial
sessions
 [ ] 0001_initial

5. 伪造迁移记录

$ python manage.py migrate --fake-initial [<APP_NAME>] # 这条命令只会将每个app/指定app第一条初始化的migration标记为[X],并不实际执行migration操作
$ python manage.py migrate --fake [<APP_NAME>] # 这条命令会将所每个app/指定app的所有migrations标记为[X],并不实际执行migration操作
参数备注: <...> 表示里面的内容为变量, 需要替换为实际的字符串, [...] 表示该参数可选可不选

Tips:

已经执行的迁移记录会被记录在settings.DATABASES, "default"alias定义的数据库connection里的django_migrations里,这个记录大致上就是showmigratons判断哪条migration需要标记[X]的依据,从而决定在migrate时需要执行哪些没有的
总的来说:

  • migrations files -> 位于不同app的位置,用于定义每个migration的详细操作
  • django_migrations数据库表记录 -> 标记migrations files哪些被执行了,以及执行时间,仅此而已

问题二:如何对引用外部app(非在项目内创建的app)的migrations进行版本控制

TODO

参考

How to Reset Migrations
How to store third party apps migrations in django

官方文档 settings.MIGRATION_MODULES
TODO:
简化对managed=False的Model的测试流程:
https://www.caktusgroup.com/blog/2010/09/24/simplifying-the-testing-of-unmanaged-database-models-in-django/

系列教程: Django Migrations详细解释
https://realpython.com/django-migrations-a-primer/

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,099评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,828评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,540评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,848评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,971评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,132评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,193评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,934评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,376评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,687评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,846评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,537评论 4 335
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,175评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,887评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,134评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,674评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,741评论 2 351

推荐阅读更多精彩内容