Flask-Migrate和Flask-Script模块的使用

迷南。 2022-05-15 14:44 209阅读 0赞

# 一.Flask-Migrate #

### 1.功能 ###

flask-migrate是flask的一个扩展模块,主要是扩展数据库表结构的。

### 2.安装 ###

切换到自己的解释器环境，执行下面命令即可安装

pip install  Flask-Migrate

###  ###

# 二.Flask-Scipt #

### 1.功能 ###

flask\_script 作用：可以通过命令行的形式来操作Flask，例如通过命令跑一个开发版本的服务器、设置数据库、定时任务等

### 2.安装 ###

pip install  Flask-Script

### 3.常用方法 ###

这些都是在shell中执行的。（一般我们常用前三个用法）.这里的manage.py不是一成不变的，需要根据你的文件名称而定。

1- 初始化数据库,会创建一个migations文件夹,并且会在数据库中生成一个alembic\_version表

`python manage.py db init`

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZvcmV2ZXJfd2Vu_size_16_color_FFFFFF_t_70]  
2-修改数据库表结构

`python manage.py db migrate (-m    "注释"`)   ##对文件进行注释

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZvcmV2ZXJfd2Vu_size_16_color_FFFFFF_t_70 1]  
3- 更新数据库

`python manage.py db upgrade`

4-查看修改历史

python manage.py db  history

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZvcmV2ZXJfd2Vu_size_16_color_FFFFFF_t_70 2]  
5-撤销修改

python manage.py db  downgrade  + 操作id  ###返回到指定步
    
    python manage.py db  downgrade base   ###返回最开始状态

# 三.两个模块相结合的使用 #

1）首先我们用下面的方法建立一个数据库中的user表

from flask import Flask
    from flask_sqlalchemy import  SQLAlchemy
    from flask_bootstrap import  Bootstrap
    import pymysql
    
    app = Flask(__name__)
    app.config['SQLALCHEMY_DATABASE_URI'] = 'mysql+pymysql://root:forever@localhost/Todo'
    app.config['SECRET_KEY'] = 'westos'
    # SQLAlchemy 将会追踪对象的修改并且发送信号。
    app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = True
    db = SQLAlchemy(app)
    
    
    class User(db.Model):
        id = db.Column(db.Integer, autoincrement=True, primary_key=True)
        # unique:用户名唯一, nullable=False指用户名不能为空;
        name = db.Column(db.String(50), unique=True, nullable=False)
    
    if __name__ == '__main__':
    
        db.create_all()
    
        u1 = User(name="westos1")
        db.session.add(u1)
        db.session.commit()

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZvcmV2ZXJfd2Vu_size_16_color_FFFFFF_t_70 3]  
2）但后期我们可能想要向其中加入某一列新的属性，但又因为采用’db.create\_all’在后期修改数据库表字段的时候，不会自动的映射到数据库中，必须删除表，然后重新运行’db.create\_all’ 才会重新映射。这样不符合我们的要求，因此flask-migrate就是为了解决这个问题。它可以在每次修改类（class）后，将修改的字段映射到数据库中.也就是所谓的数据库的迁移

例：在User类中加入下面代码，即新的属性，运行后我们发现表中的内容并没有变。也就是该列并没有加入。

passwd = db.Column(db.String(100))

所以我们需要借助这两个模块进行数据库的迁移。进行数据库迁移之前我们必须要在原数据库操作的代码中加入我们想要加入的那一列。也就是上面提到的passwd项。  
接下来就要发挥**Flask-Scipt**模块的作用----让我们能在命令行中进行数据库的迁移。  
先执行下面的代码：

from flask_migrate import  Migrate, MigrateCommand
    from flask_script import  Shell, Manager
    from models import app, db, User  ###models是我建立表时的文件，所以从这里导入
    # 用来管理命令的对象, Manager用来跟踪所有并处理他们如何从命令行调用;
    manager = Manager(app)
    migrate = Migrate(app, db)
    # 添加一条数据库迁移管理的命令
    manager.add_command('db', MigrateCommand)
    
    
    
    if __name__ == "__main__":
        # 准备
        manager.run()

出现下图结果，也就是我们可以进行的操作（db,shell,runserver）  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZvcmV2ZXJfd2Vu_size_16_color_FFFFFF_t_70 4]

再在shell中依次执行常用方法的前三个即可。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZvcmV2ZXJfd2Vu_size_16_color_FFFFFF_t_70 5]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZvcmV2ZXJfd2Vu_size_16_color_FFFFFF_t_70 6]  
经过上面的一系列操作我们就可以发现数据库迁移成功了，加入了我们想要的那一列。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZvcmV2ZXJfd2Vu_size_16_color_FFFFFF_t_70 7]

# 四.多种方式实现命令行管理命令 #

from flask_script import Manager,Command
    from flask import Flask
    
    
    app = Flask(__name__)
    manager = Manager(app)
    ##1.继承父类
    class Hello(Command):
        def run(self):
            print("hello world")
    
    manager.add_command('hello',Hello)
    
    ##2.使用装饰器
    @manager.command
    def add_user():
        """添加用户"""        ###帮助
        print("添加用户成功")
    
    ###3.当需要传参数时，可用该装饰器
    @manager.option('-n','--name',help="删除用户的名称")
    @manager.option('-p','--passwd',help="删除用户密码")
    def delete_user(name,passwd):
        if name:
            print("删除%s成功%s" %(name,passwd))
        else:
            print("yonghuweikong")
    
    if __name__ == "__main__":
        manager.run()

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZvcmV2ZXJfd2Vu_size_16_color_FFFFFF_t_70 8]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZvcmV2ZXJfd2Vu_size_16_color_FFFFFF_t_70 9]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZvcmV2ZXJfd2Vu_size_16_color_FFFFFF_t_70 10]

# 五.实现命令行管理数据库 #

from flask_migrate import  Migrate, MigrateCommand
    from flask_script import  Shell, Manager
    from models import app, db, User
    # 用来管理命令的对象, Manager用来跟踪所有并处理他们如何从命令行调用;
    manager = Manager(app)
    migrate = Migrate(app, db)
    
    # 添加一条数据库迁移管理的命令
    manager.add_command('db', MigrateCommand)
    
    #  添加一条命令, 可以显示所有的用户
    @manager.command
    def showUser():
        """显示所有的用户"""
        users = User.query.all()
        print(users)
    
    
     # 添加用户
    @manager.option('-n', '--name', help="yonghuming")
    def add_user(name):
        try:
            user2 = User(name=name)
            db.session.add(user2)
            db.session.commit()
        except Exception:
            print("失败!")
        else:
            print("创建用户%s成功!" %(name))
    
    
    if __name__ == "__main__":
        # 准备
        manager.run()

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZvcmV2ZXJfd2Vu_size_16_color_FFFFFF_t_70 11]  
出现上图结果，则可以进行数据库的管理。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZvcmV2ZXJfd2Vu_size_16_color_FFFFFF_t_70 12]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZvcmV2ZXJfd2Vu_size_16_color_FFFFFF_t_70 13]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZvcmV2ZXJfd2Vu_size_16_color_FFFFFF_t_70]: /images/20220503/b4a83a7fe6be427bb456f83851a828ed.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZvcmV2ZXJfd2Vu_size_16_color_FFFFFF_t_70 1]: /images/20220503/37404328f9754aedb9966e9b26d38d61.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZvcmV2ZXJfd2Vu_size_16_color_FFFFFF_t_70 2]: /images/20220503/1bb5ccfc9634407883cdbb18fb096bd4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZvcmV2ZXJfd2Vu_size_16_color_FFFFFF_t_70 3]: /images/20220503/86b3d6088e264b5dab93306215306645.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZvcmV2ZXJfd2Vu_size_16_color_FFFFFF_t_70 4]: /images/20220503/a322af0108cc4d5b84e957f8c1a24749.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZvcmV2ZXJfd2Vu_size_16_color_FFFFFF_t_70 5]: /images/20220503/04dac4edb2ee4645927fae0bf59687d2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZvcmV2ZXJfd2Vu_size_16_color_FFFFFF_t_70 6]: /images/20220503/7251b520fdf04c8fb8df3a211153fe93.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZvcmV2ZXJfd2Vu_size_16_color_FFFFFF_t_70 7]: /images/20220503/1385cc1981da454cbe060ed207b389ad.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZvcmV2ZXJfd2Vu_size_16_color_FFFFFF_t_70 8]: /images/20220503/9b4644feb8c8411eb7288690f9374b1e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZvcmV2ZXJfd2Vu_size_16_color_FFFFFF_t_70 9]: /images/20220503/c5f1a0d5dcee4ea6a27b6ddad25432ff.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZvcmV2ZXJfd2Vu_size_16_color_FFFFFF_t_70 10]: /images/20220503/b71458afd13d4ef583db629a5aba14ea.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZvcmV2ZXJfd2Vu_size_16_color_FFFFFF_t_70 11]: /images/20220503/6e3f529205174fc998e63d8cff166b1e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZvcmV2ZXJfd2Vu_size_16_color_FFFFFF_t_70 12]: /images/20220503/ae251596d3f94e90a986082d4ca48405.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZvcmV2ZXJfd2Vu_size_16_color_FFFFFF_t_70 13]: /images/20220503/fba969947cb848b29246bfb979e0de55.png