Flask-Migrate

• Flask-Migrate

  • 在实际的开发环境中，经常会发生数据库修改的行为。一般我们修改数据库不会直接手动的去修改，而是去修改ORM对应的模型，然后再把模型映射到数据库中。这时候如果有一个工具能专门做这种事情，就显得非常有用了，而flask-migrate就是做这个事情的。flask-migrate是基于Alembic进行的一个封装，并集成到Flask中，而所有的迁移操作其实都是Alembic做的，他能跟踪模型的变化，并将变化映射到数据库中。

  • 使用Flask-Migrate需要安装

    pip install flask-migrate
    

  • 要让Flask-Migrate能够管理app中的数据库，需要使用Migrate(app,db)来绑定app和数据库

    from flask import Flask
    from flask_sqlalchemy import SQLAlchemy
    from constants import DB_URI
    from flask_migrate import Migrate
    
    app = Flask(__name__)
    app.config['SQLALCHEMY_DATABASE_URI'] = DB_URI
    app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = True
    db = SQLAlchemy(app)
    # 绑定app和数据库
    migrate = Migrate(app,db)
    
    class User(db.Model):
        id = db.Column(db.Integer,primary_key=True)
        username = db.Column(db.String(20))
    
        addresses = db.relationship('Address',backref='user')
    
    class Address(db.Model):
        id = db.Column(db.Integer,primary_key=True)
        email_address = db.Column(db.String(50))
        user_id = db.Column(db.Integer,db.ForeignKey('user.id'))
    
    db.create_all()
    
    @app.route('/')
    def hello_world():
        return 'Hello World!'
    
    if __name__ == '__main__':
        app.run()
    

  • 初始化一个迁移文件夹

    flask db init
    

  • 然后再把当前的模型添加到迁移文件中

    flask db migrate
    

  • 最后再把迁移文件中对应的数据库操作，真正的映射到数据库中

    flask db upgrade
    

• manage.py文件
  • 这个文件用来存放映射数据库的命令，MigrateCommand是flask-migrate集成的一个命令，因此想要添加到脚本命令中，需要采用manager.add_command(‘db’,MigrateCommand)的方式，以后运行python manage.py db xxx的命令，其实就是执行MigrateCommand。

    from flask_script import Manager
    from flask_migrate import MigrateCommand, Migrate
    from exts import db
    from demo import app
    from models import User
    
    manage = Manager(app)
    Migrate(app, db)
    manage.add_command("db", MigrateCommand)
    
    if __name__ == '__main__':
        manage.run()