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 20 Python
使用scrapy实现爬网站例子和实现网络爬虫(蜘蛛)的步骤
Jan 23 Python
Python实现抓取网页并且解析的实例
Sep 20 Python
详解Python中contextlib上下文管理模块的用法
Jun 28 Python
Python数据结构与算法之列表(链表,linked list)简单实现
Oct 30 Python
Python中的函数式编程:不可变的数据结构
Oct 08 Python
Python基于class()实现面向对象原理详解
Mar 26 Python
python中读入二维csv格式的表格方法详解(以元组/列表形式表示)
Apr 24 Python
Python常用库Numpy进行矩阵运算详解
Jul 21 Python
解决PyCharm不在run输出运行结果而不是再Console里输出的问题
Sep 21 Python
python 对一幅灰度图像进行直方图均衡化
Oct 27 Python
Python爬虫之爬取哔哩哔哩热门视频排行榜
Apr 28 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中的类-什么叫类
2006/11/20 PHP
php查询相似度最高的字符串的方法
2015/03/12 PHP
PHP中预定义的6种接口介绍
2015/05/12 PHP
php中ob函数缓冲机制深入理解
2015/08/03 PHP
PHP常用技巧汇总
2016/03/04 PHP
jquery1.4.2 for Visual studio 2010 模板文件
2010/07/14 Javascript
js获取客户端外网ip的简单实例
2013/11/21 Javascript
JS获取url链接字符串 location.href
2013/12/23 Javascript
JavaScript fontsize方法入门实例(按照指定的尺寸来显示字符串)
2014/10/17 Javascript
JQuery中使用on方法绑定hover事件实例
2014/12/09 Javascript
JQuery实现的图文自动轮播效果插件
2015/06/19 Javascript
AngularJS实用开发技巧(推荐)
2016/07/13 Javascript
使用Node.js实现简易MVC框架的方法
2017/08/07 Javascript
vue生成文件本地打开查看效果的实例
2018/09/06 Javascript
JavaScript中引用vs复制示例详析
2018/12/06 Javascript
ES6 Promise对象的应用实例分析
2019/06/27 Javascript
Vue 实例中使用$refs的注意事项
2021/01/29 Vue.js
Python IDLE 错误:IDLE''s subprocess didn''t make connection 的解决方案
2017/02/13 Python
python实现一个简单的并查集的示例代码
2018/03/19 Python
浅谈pytorch和Numpy的区别以及相互转换方法
2018/07/26 Python
python 返回列表中某个值的索引方法
2018/11/07 Python
Python数据类型之String字符串实例详解
2019/05/08 Python
Python学习笔记之列表推导式实例分析
2019/08/13 Python
详解使用PyInstaller将Pygame库编写的小游戏程序打包为exe文件
2019/08/23 Python
Python tkinter常用操作代码实例
2020/01/03 Python
Python爬虫爬取电影票房数据及图表展示操作示例
2020/03/27 Python
Python实现钉钉/企业微信自动打卡的示例代码
2021/02/02 Python
PyCharm+Miniconda3安装配置教程详解
2021/02/16 Python
英国广泛的照明产品网站:Lights4living
2018/01/28 全球购物
瑞士隐形眼镜和护理产品网上商店:Linsenklick
2019/10/21 全球购物
英国领先的独立酒精饮料零售商:DrinkSupermarket
2021/01/13 全球购物
策划主管的工作职责
2013/11/24 职场文书
2015出纳试用期工作总结
2014/12/12 职场文书
left join、inner join、right join的区别
2021/04/05 MySQL
MySQL Shell的介绍以及安装
2021/04/24 MySQL
Python的三个重要函数详解
2022/01/18 Python