Flask_Flask-Migrate数据迁移扩展(十二)

在开发过程中，需要修改数据库模型，而且还要在修改之后更新数据库。最直接的方式就是删除旧表，但这样会丢失数据。更好的解决办法是使用数据库迁移框架，它可以追踪数据库模式的变化，然后把变动应用到数据库中。

在Flask中可以使用Flask-Migrate扩展，来实现数据迁移。并且集成到Flask-Script中，所有操作通过命令就能完成。为了导出数据库迁移命令，Flask-Migrate提供了一个MigrateCommand类，可以附加到flask-script的manager对象上。

首先需要安装Flask-Migrate

pip install flask-migrate

文件：database.py

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+pymysql://root:123456@192.168.3.109:3306/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-Scrip t的实例，这条语句在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)

    def __repr__(self):
        return 'Role:'.format(self.name)


# 定义用户
class User(db.Model):
    __tablename__ = 'users'

    id = db.Column(db.Integer, primary_key=True)
    username = db.Column(db.String(64), unique=True, index=True)

    def __repr__(self):
        return 'User:'.format(self.username)


if __name__ == '__main__':
    manager.run()

创建迁移仓库

python database.py db init

这个命令会创建migrations文件夹，所有迁移文件都放在里面。

数据迁移

python database.py db migrate -m '初始化'  # -m 备注说明

注意：创建的迁移脚本会删除当前库中不存在模型类的表，会在执行upgrade()后被删除。如果不想删除这些表，在生成的migrations->version->.py文件删除对应的drop行代码即可。

自动创建迁移脚本有两个函数，upgrade()函数把迁移中的改动应用到数据库中。downgrade()函数则将改动回退。自动创建的迁移脚本会根据模型定义和数据库当前状态的差异，生成upgrade()和downgrade()函数的内容。对比不一定完全正确，有可能会遗漏一些细节，需要进行检查

更新数据库

python database.py db upgrade

回退数据库

回退数据库时，需要指定回退版本号，由于版本号是随机字符串，为避免出错，建议先使用python database.py db history命令查看历史版本的具体版本号，然后复制具体版本号执行回退。

python database.py db downgrade 版本号

问题汇总

1、执行迁移命令时报错 ERROR [root] Error: Can't locate revision identified by 'da2806e980fa'

报错原因：数据库版本不对，可能是更换了 migrations 文件，但是仍旧使用的是原来的数据库表。

解决方法：删除 migrations 文件夹 + 数据库表中的 alembic_version 表，重新初始化数据库并更新；（可以保存原来的数据库表中的数据）