Flask 入门系列之数据库迁移！

这是我参与11月更文挑战的第19天，活动详情查看：2021最后一次更文挑战。

使用 Flask-Migrate 实现数据库迁移

在上篇文章 Flask 入门系列之 Flask-SQLAlchemy！提到的db.create_all()不会重新创建表或是更新表，需要先使用db.drop_all()删除数据库中所有的表之后再调用db.create_all()才能重新创建表，但是这样的话，原来表中的数据就都被删除了，这肯定是不行的，这时就出现了数据库迁移的概念。

在开发过程中，随着需求的变化，有可能需要添加或修改表的一些字段，但是原表中的数据不能删除，此时就需要创建新表，并将旧表中的数据迁移至新表中，Flask-Migrate这个扩展就可以在不破坏数据的情况下更新数据库表的结构，并完成数据从旧表到新表的迁移。

Flask-Migrate的使用

可以使用pip install flask-migrate进行安装。在程序中，我们实例化 Flask_Migrate 提供的 Migrate 类，进行初始化操作。

from flask_migrate import Migrate
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)

···

db = SQLAlchemy(app)
migrate = Migrate(app, db)

实例化 Migrate 类，需要传入 Flask 实例 app 和 SQLAlchemy创建的实例 db。

数据库的迁移过程

先定义 User 模型类。

class User(db.Model):
    __tablename__ = 'user'
    id = db.Column(db.Integer, primary_key=True)
    user_name = db.Column(db.String)
    password = db.Column(db.String)

创建迁移环境

在开始迁移数据之前，需要先使用下面的命令创建一个迁移环境：

flask db init

迁移环境只需创建一次，创建后会在项目根目录下生成一个 migrations 目录，其中包含了自动生成的配置文件和迁移版本目录。

生成迁移脚本

使用如下命令自动生成迁移脚本：

flask db migrate -m "create_table"

-m 选项添加备注信息，执行后迁移版本目录生成了迁移脚本。

迁移脚本内有两个函数：

upgrade()：把迁移中的改动应用到数据库中
downgrade()：将改动撤销

自动生成的迁移脚本会根据模型定义和数据库当前状态的差异，生成upgrade()和downgrade()函数的内容，不一定完全正确，有必要再进行检查一下。

更新数据库

生成了迁移脚本后，使用flask db upgrade命令可完成对数据库的更新。执行后即可生成数据库及表。

如果之后我们需要改动 user 表中的字段，比如添加一个mobile字段，我们只需在 User 模型类中添加该属性，之后执行flask db migrate -m '注释'和flask db upgrade命令即可。

class User(db.Model):
    __tablename__ = 'user'
    id = db.Column(db.Integer, primary_key=True)
    user_name = db.Column(db.String)
    password = db.Column(db.String)
    mobile = db.Column(db.String)

如果想要回滚迁移的话，可以执行flask db downgrade命令。

总结

这里只是介绍如何在 Flask 中进行数据库迁移，关于在生产环境下，是否需要使用迁移工具或者使用何种工具进行迁移，这里不做讨论，至于我的话，在生产环境中，我没有使用过Flask-Migrate，而是选择编写 SQL 脚本来处理数据库及表的更新或改动，我觉得这样更不容易出错，其实各有各的好处，看自己选择。

原创不易，如果小伙伴们觉得有帮助，麻烦点个赞再走呗~

最后，感谢女朋友在工作和生活中的包容、理解与支持！

Flask 入门系列之 数据库迁移！