Flask-Migrate

可以直接通过flask-script的方式进行调用。
以下对各个文件的作用进行解释：

constants.py文件：常量文件，用来存放数据库配置。

# constants.py
HOSTNAME = '127.0.0.1'
PORT = '3306'
DATABASE = 'xt_flask_migrate'
USERNAME = 'root'
PASSWORD = 'root'
DB_URI = 'mysql+mysqldb://{}:{}@{}:{}/{}'.format(USERNAME,PASSWORD,HOSTNAME,PORT,DATABASE)

 

ext.py文件：把db变量放到一个单独的文件，而不是放在主app文件。这样做的目的是为了在大型项目中如果db被多个模型文件引用的话，会造成from your_app import db这样的方式，但是往往也在your_app.py中也会引入模型文件定义的类，这就造成了循环引用。所以最好的办法是把它放在不依赖其他模块的独立文件中。

# ext.py
from flask_sqlalchemy import SQLAlchemy
db = SQLAlchemy()

models.py文件：模型文件，用来存放所有的模型，并且注意，因为这里使用的是flask-script的方式进行模型和表的映射，因此不需要使用db.create_all()的方式创建数据库。

# models.py
from ext import db
class User(db.Model):
    id = db.Column(db.Integer,primary_key=True)
    username = db.Column(db.String(50))
    addresses = db.relationship('Address',backref='user')
    def __init__(self,username):
        self.username = username

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'))

    def __init__(self,email_address):
        self.email_address = email_address

 

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

# manage.py
from flask_migrate import Migrate,MigrateCommand
from ext import db
from flask_script import Manager
from flask import Flask
from constants import DB_URI
import models
app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = DB_URI
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = True
db.init_app(app)
migrate = Migrate(app,db)
manager = Manager(app)
manager.add_command('db',MigrateCommand)

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

flaskmigrate.py文件：这个是主app文件，运行文件。并且因为db被放到另外一个文件中，所以使用db.init_app(app)的方式来绑定数据库。

# flaskmigrate.py
from flask import Flask
from ext import db

app = Flask(__name__)
db.init_app(app)

@app.route('/')
def hello_world():
    return 'Hello World!'

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

 

之后运行命令来初始化迁移文件：

python manage.py db init

然后运行命令来将模型的映射添加到文件中：

python manage.py db migrate

最后添加将映射文件真正的映射到数据库中：

python manage.py db upgrade