简单分析Flask 数据库迁移详情

Posted 2023-03-21

参考技术A

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

db.create_all()不会重新创建表或是更新表，需要先使用db.drop_all()删除数据库中所有的表之后再调用db.create_all()才能重新创建表，但是这样的话，原来表中的数据就都被删除了，这肯定是不行的，这时就出现了数据库迁移的概念。

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

2、Flask-Migrate的使用

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

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

2.1 数据库的迁移过程

先定义 User 模型类。

创建迁移环境

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

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

生成迁移脚本

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

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

迁移脚本内有两个函数：

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

downgrade()：将改动撤销

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

更新数据库

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

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

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

3、总结

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

flask-migrate数据库迁移

数据库迁移

---

• 在Flask中可以使用Flask-Migrate扩展，来实现数据迁移。并且集成到Flask-Script中，所有操作通过命令就能完成。
• 为了导出数据库迁移命令，Flask-Migrate提供了一个MigrateCommand类，可以附加到flask-script的manager对象上。

 

• 创建迁移仓库

python3 database.py db init

• 创建迁移脚本

 

• 自动创建迁移脚本有两个函数
  • upgrade()：函数把迁移中的改动应用到数据库中。
  • downgrade()：函数则将改动删除。
• 自动创建的迁移脚本会根据模型定义和数据库当前状态的差异，生成upgrade()和downgrade()函数的内容。
• 对比不一定完全正确，有可能会遗漏一些细节，需要进行检查

python3 database.py db migrate -m ‘initial migration‘

• 更新数据库

  # 更新
  python3 database.py db upgrade
  
  # 查看历史版本
  python app.py db history
  
  # 回退
  python3 app.py db downgrade 版本号
  
  ‘‘‘
  实际操作顺序:
  1.python 文件 db init
  2.python 文件 db migrate -m"版本名(注释)"
  3.python 文件 db upgrade 然后观察表结构
  4.根据需求修改模型
  5.python 文件 db migrate -m"新版本名(注释)"
  6.python 文件 db upgrade 然后观察表结构
  7.若返回版本,则利用 python 文件 db history查看版本号
  8.python 文件 db downgrade(upgrade) 版本号
  
  ‘‘‘

   

  ---

   

 1 from flask import Flask
 2 from flask_sqlalchemy import SQLAlchemy
 3 from flask_migrate import MigrateCommand, Migrate
 4 from flask_script import Manager
 5 
 6 ‘‘‘
 7 MigrateCommand:迁移命令
 8 
 9 第一步初始化：python3 demo6_数据库迁移.py db init
10 第二步生成迁移版本文件：python3 demo6_数据库迁移.py db migrate -m‘initial_01‘
11 第三步执行迁移：python3 demo6_数据库迁移.py db upgrade|downgrade
12 
13 
14 ‘‘‘
15 
16 app = Flask(__name__)
17 
18 #设置连接数据库的URL
19 app.config[‘SQLALCHEMY_DATABASE_URI‘] = ‘mysql://root:[email protected]:3306/migratetest‘
20 app.config[‘SQLALCHEMY_TRACK_MODIFICATIONS‘] = True
21 
22 db = SQLAlchemy(app)
23 
24 # 一、迁移初始化，第一个参数是flask实例， 第二个参数是数据库实例
25 Migrate(app, db)
26 # 二、实例终端命令执行对象
27 manager = Manager(app)
28 # 三、为manager添加迁移命令
29 manager.add_command(‘db‘, MigrateCommand)
30 
31 
32 
33 
34 # 创建数据表模型----实例化后就是指向数据表中的一条记录
35 class Role(db.Model):
36     # 定义表名
37     __tablename__ = ‘roles‘
38     # 定义列对象
39     id = db.Column(db.Integer, primary_key=True)
40     nike_name = db.Column(db.String(64), unique=True)  # 修改字段名
41     age = db.Column(db.Integer, nullable=True)  # 新增字段
42     # height = db.Column(db.Integer)  # 新增字段, 删除此字段
43     user = db.relationship(‘User‘, backref=‘role‘)
44 
45 
46     #repr()方法显示一个可读字符串
47     def __repr__(self):
48         return ‘Role:%s‘% self.name
49 
50 
51 class User(db.Model):
52     __tablename__ = ‘users‘
53     id = db.Column(db.Integer, primary_key=True)
54     name = db.Column(db.String(64), unique=True, index=True)
55     email = db.Column(db.String(64),unique=True)
56     password = db.Column(db.String(64))
57     role_id = db.Column(db.Integer, db.ForeignKey(‘roles.id‘))
58 
59     def __repr__(self):
60         return ‘User:%s‘%self.name
61 
62 
63 @app.route(‘/‘)
64 def index():
65     return "hello world"
66 
67 
68 
69 if __name__ == ‘__main__‘:
70     manager.run()
71