flask-migrate是flask的一個擴展模塊,主要是擴展數據庫表結構的.類似于Django的python manage.py migrate

官方文檔:?http://flask-migrate.readthedocs.io/en/latest/

安裝

pip install flask-migrate

使用舉例

from flask import Flask from flask_sqlalchemy import SQLAlchemy from flask_script import Manager from flask_migrate import Migrate, MigrateCommandapp = Flask(__name__) # 實例化app app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///app.db'db = SQLAlchemy(app) # 實例化db migrate = Migrate(app, db) # 實例化migrate，在db對象創建后調用manager = Manager(app) # 實例化manager 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()

?執行命令

1、初始化數據庫,會創建一個migations文件夾,并且會在數據庫中生成一個alembic_version表

python manage.py db init

2、創建遷移歷史，在migrations下生成一個version文件夾，下面包含了對應版本的數據庫操作py腳本。由于migrate并不一定全部發現你對model的所有改動，因此生成的py腳本需要review, 有錯的話則需要edit。例如目前知道的，表名稱表更，列名稱變更，或給constraints命名等，migreate都不能發現的。更多限制細節見此：Alembic autogenerate documentation

python manage.py db migrate?

這條命令可以簡單理解為在flask里對數據庫（db）進行遷移（migrate）。-m選項用來添加遷移備注信息。從上面的輸出信息我們可以看到，Alembic檢測出了模型變化：添加了一個新表，刪除了一個舊表，并且相應生成了一個遷移腳本。腳本詳細信息如下：

"""empty messageRevision ID: d72a7bc93d93 Revises: 7616d2060203 Create Date: 2020-06-30 11:58:46.859000"""# revision identifiers, used by Alembic. revision = 'd72a7bc93d93' down_revision = '7616d2060203'from alembic import op import sqlalchemy as sa from sqlalchemy.dialects import mysqldef upgrade():# ### commands auto generated by Alembic - please adjust! ###op.create_table('MegviiAssset',sa.Column('id', sa.INTEGER(), nullable=False),sa.Column('uuid', sa.String(length=50), nullable=True),)op.drop_table('megviiassset')# ### end Alembic commands ###def downgrade():# ### commands auto generated by Alembic - please adjust! ###op.create_table('megviiassset',sa.Column('id', mysql.INTEGER(display_width=11), autoincrement=True, nullable=False),sa.Column('uuid', mysql.VARCHAR(length=50), nullable=True),sa.PrimaryKeyConstraint('id'),mysql_default_charset=u'utf8',mysql_engine=u'InnoDB')op.drop_table('MegviiAssset')# ### end Alembic commands ###

從上面的代碼可以看出，遷移腳本主要包含了兩個函數：upgrate()函數用來將改動應用到數據庫，而downgrade()函數用來撤消改動

就像這兩個函數中的注釋所說的，遷移命令是有Alembic自動生成的，其中可能包含錯誤，所以有必要在生成后檢查一下。因為每一次遷移都會生成新的遷移腳本，而且Alemic為每一次遷移都生成了修訂版本（revision）ID，所以數據庫可以恢復到修改歷史中的任一點。正因如此，遷移環境中的文件也要納入版本控制。

有些復雜的錯誤無法實現自動遷移，這時可以使用revision命令手動創建遷移腳本。這同樣會生成一個遷移腳本，不過腳本中的upgrade()和downgrade()函數都是空的。你需要使用Alembic提供的Operations對象指令在這兩個函數中實現具體操作，具體可以訪問Alembic官方文檔查看。

3、最后一步。此命令相當于執行了version文件夾下的相應py版本，對數據庫進行變更操作。此后，對model有變更，只要重復migrate和upgrade操作即可。

python manage.py db upgrade # 更新數據庫

如果你想回滾遷移，那么可以使用downgrade命令（降級），它會撤銷最后一次遷移在數據庫中的改動，這在開發時非常有用。比如，當執行upgrade命令后發現某些地方出錯了，這時就可以執行 python manage.py db downgrade 命令進行回滾，刪除對應的遷移腳本，重新生成遷移腳本后再進行更新（upgrade）。

坑

1.設計表時字段的默認值，這里用參數server_default,而不是default

operator = db.Column(db.String(40), nullable=True, server_default="init_data")

2.如果報這個錯誤，將alembic_version表中的數據刪掉即可

Heroku Postgres, db migrate fail: alembic.util.exc.CommandError: Can't locate revision identified by

沒有migrations文件夾時

將 alembic_version 表刪除

重新初始化 python manage.py db init

創建遷移歷史并核對相應py文件 python manage.py db migrate

更新數據庫 python manage.py db upgrade? 如果還沒有創建數據庫和表，這個命令會自動創建，如果已經創建，則會在不損壞數據的前提下執行更新。

總結

以上是生活随笔為你收集整理的Flask 第三方组件之 Migrate的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。