最近在学习使用 Flask 生成一个短链接服务时看到了 Flask-Migrate 这样一款插件，之前学习 Django 的时候自带数据库迁移工具， Flask 中也有这样一款，不过是以插件的形式出现，Flask Migrate 基于 Alembic ，Alembic 是 SQLAlchemy 作者开发的数据迁移工具。

文档主页：https://flask-migrate.readthedocs.io/en/latest/

安装

执行：

pip install Flask-Migrate

在安装完成之后需要在代码中添加如下代码

from flask import Flask
from flask_sqlalchemy import SQLAlchemy
from flask_migrate import Migrate

app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///app.db'

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

class User(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String(128))

在添加代码之后需要运行

flask db init

来初始化项目，命令运行之后会在项目中生成 migrations 文件夹，该文件夹需要添加到版本控制。

之后可以使用 migrate 命令来初始化迁移

flask db migrate

迁移脚本不会检测 models 的所有变更， Alembic 目前无法检测表名修改，列名修改，其他限制可以在 Alembic 网站 查看。

之后可以应用该迁移

flask db upgrade

运行该命令来将修改应用到数据库，以后对 model 的每一次修改需要重复 migrate 和 upgrade 命令。如果要在不同机器之间同步数据库结构，只需要同步 migrations 文件夹，并且在另一台机器上运行 flask db upgrade 即可。

Flask Migrate 也支持直接使用脚本的方式运行，具体可参考 官方的文档 ，非常易懂。

Flask-Migrate 还支持降级：

flask db downgrade

其他常用的命令

(venv) $ flask db
Usage: flask db [OPTIONS] COMMAND [ARGS]...

  Perform database migrations.

Options:
  --help  Show this message and exit.

Commands:
  branches   Show current branch points
  current    Display the current revision for each...
  downgrade  Revert to a previous version
  edit       Edit a revision file
  heads      Show current available heads in the script...
  history    List changeset scripts in chronological...
  init       Creates a new migration repository.
  merge      Merge two revisions together, creating a new...
  migrate    Autogenerate a new revision file (Alias for...
  revision   Create a new revision file.
  show       Show the revision denoted by the given...
  stamp      'stamp' the revision table with the given...
  upgrade    Upgrade to a later version

集成存在的数据库

假如已经有数据库表结构了，后期引入了 Flask-Migrate，那么可以通过如下步骤集成 Flask-Migrate 到项目中。

  • 创建一个临时的数据库
  • 如果项目中存在 migration 文件夹，删除
  • 执行 flask db init 创建新的 migration
  • 执行 flask db migrate 来初始化已经存在的 migration
  • 这个时候切换到已经存在的数据库，修改数据库地址
  • 执行 flask db stamp head 这一步会在数据库创建 alembic_version 表，然后保存最新的 migration 版本

之后就可以使用 Migration 来管理数据库版本了。

flask db migrate
flask db upgrade

在 dev 和 prd 环境中使用

Migrations 总是在开发环境中生成。

生产环境中只会应用变更（upgrade）。

reference