Python的Flask框架中使用Flask-Migrate扩展迁移数据库的教程


Posted in Python onJune 14, 2016

我们在升级系统的时候,经常碰到需要更新服务器端数据结构等操作,之前的方式是通过手工编写alter sql脚本处理,经常会发现遗漏,导致程序发布到服务器上后无法正常使用。

现在我们可以使用Flask-Migrate插件来解决之,Flask-Migrate插件是基于Alembic,Alembic是由大名鼎鼎的SQLAlchemy作者开发数据迁移工具。

具体操作如下:

1. 安装Flask-Migrate插件

$ pip install Flask-Migrate
2. 修改Flask App部分的代码,以增加Migrate相关的Command
db = SQLAlchemy(app)
migrate = Migrate(app, db)

manager = Manager(app)
manager.add_command('db', MigrateCommand)

3. 初始化

$ python app.py db init

使用Flask-Migrate迁移数据库
随着开发进度不断向前,你会发现你的数据库模型需要更改,而当这种情况发生时需要更新数据库。

Flask-SQLAlchemy只有当数据库表不存在了才从模型创建它们,所以更新表的唯一途径就是销毁旧的表,当然这将导致所有数据库中的数据丢失。

有个更好的解决方案就是使用数据库迁移框架。和源码版本控制工具跟踪更改源码文件一样,数据库迁移框架跟踪更改数据库模型,然后将增量变化应用到数据库中。

SQLAlchemy的主要开发人员写了一个Alembic迁移框架,但我们不直接使用Alembic,Flask应用可以使用Flask-Migrate扩展,一个集成了Flask-Script来提供所有操作命令的轻量级Alembic包。

4. 创建迁移仓库

首先,Flask-Migrate必须已经安装到虚拟环境中:

(venv) $ pip install flask-migrate

下面展示扩展如何初始化:

from flask.ext.migrate import Migrate, MigrateCommand 

# ...

migrate = Migrate(app, db)
manager.add_command('db', MigrateCommand)

为了可以使用数据库迁移命令,Flask-Migrate提供MigrateCommand类来连接Flask-Script的manager对象。在这个示例中使用db来连接到命令。

在数据库迁移可以维护之前,必须通过init子命令来创建一个迁移库:

(venv) $ python hello.py db init
Creating directory /home/flask/flasky/migrations...done
 Creating directory /home/flask/flasky/migrations/versions...done
 Generating /home/flask/flasky/migrations/alembic.ini...done
 Generating /home/flask/flasky/migrations/env.py...done
 Generating /home/flask/flasky/migrations/env.pyc...done
 Generating /home/flask/flasky/migrations/README...done
 Generating /home/flask/flasky/migrations/script.py.mako...done
 Please edit configuration/connection/logging settings in
 '/home/flask/flasky/migrations/alembic.ini' before proceeding.

这个命令创建一个migrations文件夹,里面存放了所有迁移脚本。

建议:如果你有克隆在GitHub上的应用程序,你现在可以运行git checkout 5c来切换到这个版本的应用程序。

5. 创建迁移脚本

在Alembic,数据库迁移工作由迁移脚本完成。这个脚本有两个函数,分别叫做upgrade()和downgrade()。upgrade()函数实施数据库更改,是迁移的一部分,downgrade()函数则删除它们。通过添加和删除数据库变化的能力,Alembic可以重新配置数据库从历史记录中的任何时间点。

Alembic迁移可以分别使用revision和migrate命令手动或自动创建。手动迁移通过由开发人员使用Alembic的Operations对象指令实现的空upgrade()和downgrade()函数创建迁移框架脚本。另一方面,自动迁移通过寻找模型定义和数据库当前状态间的不同为upgrade()和downgrade()生成代码。

警告:自动迁移并不总是准确的,可以忽略一些细节。所以应该经常审查一下自动生成的迁移脚本。
migrate子命令创建自动迁移脚本:

(venv) $ python hello.py db migrate -m "initial migration"
INFO [alembic.migration] Context impl SQLiteImpl.
INFO [alembic.migration] Will assume non-transactional DDL.
INFO [alembic.autogenerate] Detected added table 'roles'
INFO [alembic.autogenerate] Detected added table 'users'
INFO [alembic.autogenerate.compare] Detected added index
'ix_users_username' on '['username']'
 Generating /home/flask/flasky/migrations/versions/1bc
 594146bb5_initial_migration.py...done

建议:如果你有克隆在GitHub上的应用程序,你现在可以运行git checkout 5c来切换到这个版本的应用程序。注意,你不需要为这个应用生成migrations,所有的迁移脚本都包含在版本库中。
6. 更新数据库

一旦迁移脚本被审查且接受,就可以使用db upgrade命令更新到数据库中:

(venv) $ python hello.py db upgrade
INFO [alembic.migration] Context impl SQLiteImpl.
INFO [alembic.migration] Will assume non-transactional DDL.
INFO [alembic.migration] Running upgrade None -> 1bc594146bb5, initial migration

第一次迁移实际上相当于调用db.create_all(),但在后续迁移中,upgrade命令对表实施更新操作但不影响表中的内容。

Python 相关文章推荐
python概率计算器实例分析
Mar 25 Python
python 统计代码行数简单实例
May 04 Python
python3 打开外部程序及关闭的示例
Nov 06 Python
使用Python的toolz库开始函数式编程的方法
Nov 15 Python
python 通过类中一个方法获取另一个方法变量的实例
Jan 22 Python
python 利用pandas将arff文件转csv文件的方法
Feb 12 Python
Python图像处理之图片文字识别功能(OCR)
Jul 30 Python
python统计指定目录内文件的代码行数
Sep 19 Python
python 正则表达式参数替换实例详解
Jan 17 Python
Python制作简易版小工具之计算天数的实现思路
Feb 13 Python
keras实现调用自己训练的模型,并去掉全连接层
Jun 09 Python
Django限制API访问频率常用方法解析
Oct 12 Python
Python的Flask框架中使用Flask-SQLAlchemy管理数据库的教程
Jun 14 #Python
全面了解Python的getattr(),setattr(),delattr(),hasattr()
Jun 14 #Python
浅谈python中的getattr函数 hasattr函数
Jun 14 #Python
深入解析Python中的线程同步方法
Jun 14 #Python
详解Python中的Descriptor描述符类
Jun 14 #Python
浅析Python中的getattr(),setattr(),delattr(),hasattr()
Jun 14 #Python
Python中getattr函数和hasattr函数作用详解
Jun 14 #Python
You might like
php自动识别文件编码并转换为UTF-8的方法
2014/06/12 PHP
使用php+swoole对client数据实时更新(一)
2016/01/07 PHP
利用laravel+ajax实现文件上传功能方法示例
2017/08/13 PHP
thinkPHP3.2.3结合Laypage实现的分页功能示例
2018/05/28 PHP
PHP实现爬虫爬取图片代码实例
2021/03/03 PHP
JQuery AJAX提交中文乱码的解决方案
2010/07/02 Javascript
Extjs中DisplayField的日期或者数字格式化扩展
2010/09/03 Javascript
一款Jquery 分页插件的改造方法(服务器端分页)
2011/07/11 Javascript
JS实现很酷的EMAIL地址添加功能实例
2015/02/28 Javascript
javascript实现自动填写表单实例简析
2015/12/02 Javascript
jQuery实现iframe父窗体和子窗体的相互调用
2016/06/17 Javascript
vue响应式更新机制及不使用框架实现简单的数据双向绑定问题
2019/06/27 Javascript
vue实现商城秒杀倒计时功能
2019/12/12 Javascript
vue style width a href动态拼接问题的解决
2020/08/07 Javascript
Python StringIO模块实现在内存缓冲区中读写数据
2015/04/08 Python
用Python计算三角函数之atan()方法的使用
2015/05/15 Python
python中string模块各属性以及函数的用法介绍
2016/05/30 Python
python简单验证码识别的实现方法
2019/05/10 Python
基于python实现微信好友数据分析(简单)
2020/02/16 Python
python梯度下降算法的实现
2020/02/24 Python
python删除指定列或多列单个或多个内容实例
2020/06/28 Python
浅谈keras中的后端backend及其相关函数(K.prod,K.cast)
2020/06/29 Python
Python urllib3软件包的使用说明
2020/11/18 Python
Oracle快照(snapshot)
2015/03/13 面试题
电话销售经理岗位职责
2013/12/07 职场文书
普通简短的个人自我评价
2014/02/15 职场文书
2014年迎新年联欢会活动策划方案
2014/02/26 职场文书
2014年预备党员学习两会心得体会
2014/03/17 职场文书
优秀语文教师事迹
2014/05/18 职场文书
高中同学会活动方案
2014/08/14 职场文书
2014年大学生党员评议表自我评价
2014/09/20 职场文书
2014五年级班主任工作总结
2014/12/05 职场文书
个人求职自荐信范文
2015/03/06 职场文书
文明旅游倡议书
2015/04/28 职场文书
社会主义核心价值观主题教育活动总结
2015/05/07 职场文书
2015年小学教师培训工作总结
2015/07/21 职场文书