Flask-migrate基本使用方法
简介
在开发时，以删除表再重建的方式更新数据库简单直接，但明显的缺陷是会丢掉数据库中的所有数据。在生产环境下，没有人想把数据都删除掉，这时需要使用数据库迁移工具来完成这个工作。SQLAlchemy的开发者Michael Bayer写了一个数据库迁移工作—Alembic来帮助我们实现数据库的迁移，数据库迁移工具可以在不破坏数据的情况下更新数据库表的结构。蒸馏器（Alembic）是炼金术士最重要的工具，要学习SQL炼金术（SQLAlchemy），当然要掌握蒸馏器的使用。
扩展Flask-Migrate继承了Alembic，提供了一些flask命令来简化迁移工作，我们将使用它来迁移数据库。Flask-Migrate及其依赖（主要是Alembic）可以使用pipenv安装：
数据库迁移操作顺序
- 1.python 文件 db init
- 2.根据需求修改模型
- 3.python flaskapp文件 db migrate -m"新版本名(注释)"
- 4.python flaskapp文件 db upgrade 然后观察表结构
- 5.若返回版本,则利用 python 文件 db history查看版本号
- 6.python 文件 db downgrade(upgrade) 版本号
首先要在虚拟环境中安装Flask-Migrate
pip install flask-migrate
将flask-migrate注册到flask中
flask-migrate依赖flask-script对其进行操作和管理
#coding=utf-8
from flask import Flask
from flask_sqlalchemy import SQLAlchemy
from flask_migrate import Migrate,MigrateCommand
from flask_script import Shell,Manager
app = Flask(__name__)
manager = Manager(app)
app.config['SQLALCHEMY_DATABASE_URI'] = 'mysql://root:mysql@127.0.0.1:3306/Flask_test'
app.config['SQLALCHEMY_COMMIT_ON_TEARDOWN'] = True
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = True
db = SQLAlchemy(app)
#第一个参数是Flask的实例，第二个参数是Sqlalchemy数据库实例
migrate = Migrate(app,db)
#manager是Flask-Script的实例，这条语句在flask-Script中添加一个db命令
manager.add_command('db',MigrateCommand)
#定义模型Role
class Role(db.Model):
# 定义表名
__tablename__ = 'roles'
# 定义列对象
id = db.Column(db.Integer, primary_key=True)
name = db.Column(db.String(64), unique=True)
user = db.relationship('User', backref='role')
#repr()方法显示一个可读字符串，
def __repr__(self):
return 'Role:'.format(self.name)
#定义用户
class User(db.Model):
__talbe__ = 'users'
id = db.Column(db.Integer, primary_key=True)
username = db.Column(db.String(64), unique=True, index=True)
#设置外键
role_id = db.Column(db.Integer, db.ForeignKey('roles.id'))
def __repr__(self):
return 'User:'.format(self.username)
if __name__ == '__main__':
manager.run()
创建迁移仓库
- 这个命令会创建migrations文件夹，所有迁移文件都放在里面。
python database.py db init # 将database.py替换为有manager.run()的执行文件
创建迁移脚本
- 自动创建迁移脚本有两个函数
- upgrade()：函数把迁移中的改动应用到数据库中。
- downgrade()：函数则将改动删除。
- 自动创建的迁移脚本会根据模型定义和数据库当前状态的差异，生成upgrade()和downgrade()函数的内容。
- 对比不一定完全正确，有可能会遗漏一些细节，需要进行检查
python database.py db migrate -m 'initial migration' # 第一次迁移不要使用 - m
更新数据库
python database.py db upgrade
返回以前的版本
- 可以根据history命令找到版本号,然后传给downgrade命令:
python app.py db history
输出格式：<base> -> 版本号 (head), initial migration
- 回滚到指定版本
python app.py db downgrade 版本号
新版本下的情况
flask>2.0 /migrate>3.0的情况下flask-migrate不再兼容flask-script，需要使用不同的方式来初始化
#coding=utf-8
from flask import Flask
from flask_sqlalchemy import SQLAlchemy
from flask_migrate import Migrate
app = Flask(__name__)
db = SQLAlchemy(app)
migrate = Migrate(app, db)
......
在环境变量中写入app.py的位置
# 以下操作均在包含 app.run()代码的文件所在的目录下执行，这个位置也是flask的工作目录
$env:FLASK_APP='app.py' # windows系统
export FLASK_APP=app.py # linux/macos系统
创建迁移仓库
- 这个命令会创建migrations文件夹，所有迁移文件都放在里面。
flask db init
创建迁移脚本
- 自动创建迁移脚本有两个函数
- upgrade()：函数把迁移中的改动应用到数据库中。
- downgrade()：函数则将改动删除。
- 自动创建的迁移脚本会根据模型定义和数据库当前状态的差异，生成upgrade()和downgrade()函数的内容。
- 对比不一定完全正确，有可能会遗漏一些细节，需要进行检查
flask db migrate -m 'initial migration'
更新数据库
flask db upgrade
返回以前的版本
- 可以根据history命令找到版本号,然后传给downgrade命令:
flask db history
输出格式：<base> -> 版本号 (head), initial migration
- 回滚到指定版本
flask db downgrade 版本号
