flask_migrate英文文档翻译

flask_migrate英文文档翻译

Flask

Flask-Migrate是用于使用Alembic处理Flask应用程序的SQLAlchemy数据库迁移的扩展。可通过Flask命令行界面或Flask-Script扩展名使用数据库操作。

为什么直接使用Flask-Migrate与Alembic？
Flask-Migrate是一个扩展，它以正确的方式配置Alembic以与Flask和Flask-SQLAlchemy应用程序一起使用。就实际的数据库迁移而言，一切都由Alembic处理，因此您可以获得完全相同的功能。

Installation
用pip安装Flask-Migrate ：

pip install Flask-Migrate

Example

这是一个通过Flask-Migrate处理数据库迁移的示例应用程序：

from flask_sqlalchemy import SQLAlchemy
from flask_migrate import Migrate

app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///app.db'
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False //这里是自己加上的为了去掉警告部分

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

这会将一个迁移文件夹添加到您的应用程序。该文件夹的内容需要与其他源文件一起添加到版本控制中。

然后，您可以生成初始迁移：

$ flask db migrate

迁移脚本需要进行检查和编辑，因为Alembic当前无法检测到您对模型所做的每项更改。特别是，Alembic当前无法检测表名称更改，列名称更改或匿名命名的约束。限制的详细摘要可在Alembic自动生成文档中找到。完成后，还需要将迁移脚本添加到版本控制中。

然后，您可以将迁移应用于数据库：

$ flask db upgrade

然后，每次数据库模型更改时，重复migrate和upgrade命令。

要在另一个系统中同步数据库，只需从源代码管理中刷新迁移文件夹并运行upgrade命令。

要查看所有可用命令，请运行以下命令：

$ flask db --help

请注意，必须按照命令行脚本的FLASK_APP要求，在环境变量中设置应用程序脚本，以上所有命令才能起作用flask。

使用Flask- Script

Flask-Migrate还支持Flask-Script命令行界面。这是一个示例应用程序，通过Flask-Script公开了所有数据库迁移命令：

from flask import Flask
from flask_sqlalchemy import SQLAlchemy
from flask_script import Manager
from flask_migrate import Migrate, MigrateCommand

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

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

manager = Manager(app)
manager.add_command('db', MigrateCommand)

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

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

假设以上脚本存储在名为的文件中manage.py，则可以通过运行脚本来访问所有数据库迁移命令：

$ python manage.py db init
$ python manage.py db migrate
$ python manage.py db upgrade
$ python manage.py db --help

配置回调

有时，应用程序需要将自己的设置动态插入Alembic配置中。configure在读取配置之后和使用配置之前，将调用以回调装饰的函数。该功能可以修改配置对象，或将其替换为其他对象。

@migrate.configure
def configure_alembic(config):
    # modify config object
    return config

多数据库支持

Flask-Migrate可以与Flask-SQLAlchemy 的绑定功能集成在一起 ，从而可以跟踪到与应用程序关联的多个数据库的迁移。

要创建多数据库迁移存储库，请将–multidb参数添加到init命令中：

$ flask db init --multidb

使用此命令，将建立迁移存储库以跟踪主数据库以及SQLALCHEMY_BINDS配置选项中定义的任何其他数据库上的迁移。