Alembic数据库迁移工具使用

基本语法：
python manage.py xx [app_name]

xx如下：
migrate，负责应用和撤销迁移。
makemigrations，基于模型的修改创建迁移。
sqlmigrate，展示迁移使用的 SQL 语句。
showmigrations，列出项目的迁移和迁移的状态。

# 安装alembic
pip install alembic

# 初次使用时，需要初始化，创建迁移环境和 alembic.ini 文件、env.py文件
alembic init migrations

# 修改alembic.ini配置，改变 sqlalchemy.url 值，配置数据库连接。
sqlalchemy.url = mysql+pymysql://root:mysql@localhost/ocean_209_old
    
# 生成数据库迁移文件。
# --autogrenerate 选项参数来自动生成迁移脚本（这里演示使用手动：仅生成空模板）
alembic revision -m "first comment"

# 同步数据库
alembic upgrade head

# 切换到项目根目录下
alembic init alembic
# init之后的alembic指的是保存迁移文件的目录名称。
# 执行之后会在项目根目录下生成 alembic.ini文件 和指定名称的迁移文档保存目录（）。

$ alembic init alembic
Creating directory C:\Projects\ocean\alembic ...  done
Creating directory C:\Projects\ocean\alembic\versions ...  done
Generating C:\Projects\ocean\alembic.ini ...  done
Generating C:\Projects\ocean\alembic\env.py ...  done
Generating C:\Projects\ocean\alembic\README ...  done
Generating C:\Projects\ocean\alembic\script.py.mako ...  done
Please edit configuration/connection/logging settings in 'C:\\Projects\\ocean\\alembic.ini' before proceeding.

alembic
├── README
├── env.py
├── script.py.mako
└── versions/
alembic.ini

# mysql
sqlalchemy.url = mysql+pymysql://fdz:[email protected]:3333/ocean_209_old

# postgres
sqlalchemy.url = postgresql+psycopg2://root:[email protected]/table_name

"""配置target_metadata"""
# 来源一：Model Base
import os
import sys
sys.path.append(os.path.dirname(os.path.abspath(__file__)) + "/../")
from ocean.model._base import Base  # 不同代码结构不同
metadata = Base.metadata  # # 从任意一个我们的model可以拿到总的Base

# # 来源二：已存在表reflect
from sqlalchemy import create_engine
from sqlalchemy.schema import MetaData

engine = create_engine('mysql+pymysql://root:mysql@localhost/ocean_253_test_alembic')
metadata = MetaData(engine)
# # only参数可传入指定的数据库表名列表，表示只对这些表生成迁移脚本，否则就对DB中的全表生成
# metadata.reflect(only=["users"])
metadata.reflect()  # 不会返回任何值

# #　以上两种方式根据需要选择其中一种即可
target_metadata = metadata

# --autogrenerate 选项参数来自动生成迁移脚本
# -m 增加版本信息
alembic revision --autogenerate -m "gen_ddl_by_reflect"

INFO  [alembic.runtime.migration] Context impl MySQLImpl.
INFO  [alembic.runtime.migration] Will assume non-transactional DDL.
INFO  [alembic.autogenerate.compare] Detected added table 'incomplete'
INFO  [alembic.autogenerate.compare] Detected added table 'regions'
INFO  [alembic.autogenerate.compare] Detected added table 'sms_push_history'
INFO  [alembic.autogenerate.compare] Detected added table 'template'
INFO  [alembic.autogenerate.compare] Detected added table 'voice_failure'
INFO  [alembic.autogenerate.compare] Detected added table 'voice_push_history'
INFO  [alembic.autogenerate.compare] Detected added table 'voice_report'
INFO  [alembic.autogenerate.compare] Detected added table 'whitelist_batch'
INFO  [alembic.autogenerate.compare] Detected NULL on column 'alarm_level_policy.create_at'
INFO  [alembic.autogenerate.compare] Detected NULL on column 'user_login_event.current'
INFO  [alembic.autogenerate.compare] Detected added column 'users.mobile'
Generating C:\Projects\ocean\alembic\versions\daf4b972f41d_gen_ddl_by_reflect.py ...  done

# 主要是两大操作函数：分别对应了升级和降级操作
def upgrade():
    # ### commands auto generated by Alembic - please adjust! ###
    op.drop_table('supplier_attach')
    op.add_column('users', sa.Column('test_add_col', mysql.CHAR(length=11), nullable=True, comment='测试增加字段'))
    op.alter_column('whitelist_batch', 'uid',
               existing_type=mysql.INTEGER(),
               nullable=False)
    # ### end Alembic commands ###


def downgrade():
    # ### commands auto generated by Alembic - please adjust! ###
    op.alter_column('whitelist_batch', 'uid',
               existing_type=mysql.INTEGER(),
               nullable=True)
    op.drop_column('users', 'test_add_col')
    op.create_table('supplier_attach',
    sa.Column('id', mysql.INTEGER(), autoincrement=True, nullable=False),
    sa.Column('supplier', mysql.INTEGER(), autoincrement=False, nullable=False),
    sa.Column('filename', mysql.CHAR(charset='utf8', collation='utf8_general_ci', length=255), nullable=False),
    sa.Column('raw_filename', mysql.CHAR(charset='utf8', collation='utf8_general_ci', length=255), nullable=False),
    sa.Column('create_at', mysql.TIMESTAMP(), nullable=True),
    sa.PrimaryKeyConstraint('id'),
    mysql_default_charset='utf8',
    mysql_engine='InnoDB',
    mysql_row_format='DYNAMIC'
    )
    # ### end Alembic commands ###

INFO  [alembic.runtime.migration] Context impl MySQLImpl.
INFO  [alembic.runtime.migration] Will assume non-transactional DDL.
INFO  [alembic.runtime.migration] Running upgrade  -> daf4b972f41d, gen_ddl_by_reflect

#查看线上数据库处于什么版本
alembic current
#查看项目目录中的迁移脚本信息（当前head）
alembic history

#更新数据库
alembic upgrade 版本号
#更新到最新版
alembic upgrade head
#降级数据库
alembic downgrade 版本号
#降级到最初版
alembic downgrade head
#离线更新(生成sql)
alembic upgrade 版本号 --sql > migration.sql
#从特定起始版本生成sql
alembic upgrade 版本一:版本二 --sql >migration.sql
    
#清除所有生成版本
将version删除, 并删除alembic_version表