alembic
是sqlalchemy
的作者开发的。用来做OMR
模型与数据库的迁移与映射。alembic
使用方式跟git
有点了类似,表现在两个方面,第一个,alembic
的所有命令都是以alembic
开头;第二,alembic
的迁移文件也是通过版本进行控制的。首先,通过pip install alembic
进行安装。以下将解释alembic
的用法:
初始化alembic
仓库:在终端中,cd
到你的项目目录中,然后执行命令alembic init alembic
,创建一个名叫alembic
的仓库。
创建模型类:创建一个models.py
模块,然后在里面定义你的模型类,示例代码如下:
from sqlalchemy import Column,Integer,String,create_engine,Text
from sqlalchemy.orm import sessionmaker
from sqlalchemy.ext.declarative import declarative_base
Base = declarative_base()
class User(Base):
__tablename__ = ‘user‘
id = Column(Integer,primary_key=True)
username = Column(String(20),nullable=False)
password = Column(String(100),nullable=False)
class Article(Base):
__tablename__ = ‘article‘
id = Column(Integer,primary_key=True)
title = Column(String(100),nullable=False)
content = Column(Text, nullable=False)
修改配置文件:
alembic.ini
中设置数据库的连接,sqlalchemy.url = driver://user:pass@localhost/dbname
,比如以mysql
数据库为例,则配置后的代码为:
sqlalchemy.url = mysql+mysqldb://root:root@localhost/alembic_demo?charset=utf8
env.py
文件中设置target_metadata
,默认为target_metadata=None
。使用sys
模块把当前项目的路径导入到path
中:
import os
import sys
sys.path.append(os.path.dirname(os.path.abspath(__file__)) + "/../")
from models import Base
... #省略代码
target_metadata = Base.metadata # 设置创建模型的元类
... #省略代码
自动生成迁移文件:使用alembic revision --autogenerate -m "message"
将当前模型中的状态生成迁移文件。
更新数据库:使用alembic upgrade head
将刚刚生成的迁移文件,真正映射到数据库中。同理,如果要降级,那么使用alembic downgrade head
。
修改代码后,重复4~5的步骤。
命令和参数解释:
alembic
仓库。upgrade
函数。如果有多个迁移脚本没有被映射到数据库中,那么会执行多个迁移脚本。downgrade
函数。另外,在你第一次执行upgrade
的时候,就会在数据库中创建一个名叫alembic_version
表,这个表只会有一条数据,记录当前数据库映射的是哪个版本的迁移文件。
错误描述 | 原因 | 解决办法 |
---|---|---|
FAILED: Target database is not up to date. |
主要是heads 和current 不相同。current 落后于heads 的版本。 |
将current移动到head上。alembic upgrade head |
FAILED: Can‘t locate revision identified by ‘77525ee61b5b‘ |
数据库中存的版本号不在迁移脚本文件中 | 删除数据库的alembic_version 表中的数据,重新执行alembic upgrade head |
原文:https://www.cnblogs.com/YiwenGG/p/13364365.html