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中的列表推导浅析
Apr 26 Python
Python深入学习之上下文管理器
Aug 31 Python
在windows系统中实现python3安装lxml
Mar 23 Python
Python实现FTP上传文件或文件夹实例(递归)
Jan 16 Python
Python实现视频下载功能
Mar 14 Python
详解Python 协程的详细用法使用和例子
Jun 15 Python
浅析Python 3 字符串中的 STR 和 Bytes 有什么区别
Oct 14 Python
pycharm使用matplotlib.pyplot不显示图形的解决方法
Oct 28 Python
Python flask路由间传递变量实例详解
Jun 03 Python
Python中zipfile压缩包模块的使用
May 14 Python
pytorch通过训练结果的复现设置随机种子
Jun 01 Python
Python+Selenium实现读取网易邮箱验证码
Mar 13 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抓取淘宝商品的用户晒单评论+图片+搜索商品列表实例
2016/04/14 PHP
Ajax实现对静态页面的文章访问统计功能示例
2016/10/10 PHP
javascript操作文本框readOnly
2007/05/15 Javascript
js String对象中常用方法小结(字符串操作)
2012/01/27 Javascript
FireBug 调试JS入门教程 如何调试JS
2013/12/23 Javascript
浅析javascript的间隔调用和延时调用
2014/11/12 Javascript
浅谈Javascript如何实现匀速运动
2014/12/19 Javascript
JavaScript匿名函数用法分析
2015/02/13 Javascript
jQuery实现返回顶部效果的方法
2015/05/29 Javascript
jQuery.trim() 函数及trim()用法详解
2015/10/26 Javascript
JavaScript生成带有缩进的表格代码
2016/06/15 Javascript
实例分析浏览器中“JavaScript解析器”的工作原理
2016/12/12 Javascript
Node.js学习入门
2017/01/03 Javascript
微信小程序 两种滑动方式(横向滑动,竖向滑动)详细及实例代码
2017/01/13 Javascript
老生常谈js中的MVC
2017/07/25 Javascript
微信小程序 swiper组件构建轮播图的实例
2017/09/20 Javascript
angular2中使用第三方js库的实例
2018/02/26 Javascript
Vue实现导出excel表格功能
2018/03/30 Javascript
记一次vue去除#问题处理经过小结
2019/01/24 Javascript
js获取form表单中name属性的值
2019/02/27 Javascript
python生成日历实例解析
2014/08/21 Python
浅谈Python中chr、unichr、ord字符函数之间的对比
2016/06/16 Python
keras model.fit 解决validation_spilt=num 的问题
2020/06/19 Python
用gpu训练好的神经网络,用tensorflow-cpu跑出错的原因及解决方案
2021/03/03 Python
如何用H5实现一个触屏版的轮播器的实例
2017/01/09 HTML / CSS
bonprix匈牙利:女士、男士和儿童服装
2019/07/19 全球购物
临床医学大学生求职信
2013/09/28 职场文书
秋季运动会加油稿200字
2014/01/11 职场文书
个人借款担保书
2014/04/02 职场文书
学生上课看漫画的检讨书
2014/09/26 职场文书
2014年无财产无子女离婚协议书范本
2014/10/09 职场文书
关于学习的决心书
2015/02/05 职场文书
企业财务经理岗位职责
2015/04/08 职场文书
硕士毕业答辩开场白
2015/05/27 职场文书
nginx负载功能+nfs服务器功能解析
2022/02/28 Servers
MySQL提取JSON字段数据实现查询
2022/04/22 MySQL