alembic教程:
如果想深入學(xué)習(xí)Flask,可以觀看這套免費(fèi)Flask教學(xué)視頻:零基礎(chǔ):Flask入門到項(xiàng)目實(shí)戰(zhàn)
alembic是sqlalchemy的作者開發(fā)的。用來做OMR模型與數(shù)據(jù)庫的遷移與映射。alembic使用方式跟git有點(diǎn)了類似,表現(xiàn)在兩個(gè)方面,第一個(gè),alembic的所有命令都是以alembic開頭;第二,alembic的遷移文件也是通過版本進(jìn)行控制的。首先,通過pip install alembic進(jìn)行安裝。以下將解釋alembic的用法:
初始化
alembic倉庫:在終端中,cd到你的項(xiàng)目目錄中,然后執(zhí)行命令alembic init alembic,創(chuàng)建一個(gè)名叫alembic的倉庫。-
創(chuàng)建模型類:創(chuàng)建一個(gè)
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中設(shè)置數(shù)據(jù)庫的連接,sqlalchemy.url = driver://user:pass@localhost/dbname,比如以mysql數(shù)據(jù)庫為例,則配置后的代碼為:sqlalchemy.url = mysql+mysqldb://root:root@localhost/alembic_demo?charset=utf8 -
為了使用模型類更新數(shù)據(jù)庫,需要在
env.py文件中設(shè)置target_metadata,默認(rèn)為target_metadata=None。使用sys模塊把當(dāng)前項(xiàng)目的路徑導(dǎo)入到path中:import os import sys sys.path.append(os.path.dirname(os.path.abspath(__file__)) + "/../") from models import Base ... #省略代碼 target_metadata = Base.metadata # 設(shè)置創(chuàng)建模型的元類 ... #省略代碼
-
自動(dòng)生成遷移文件:使用
alembic revision --autogenerate -m "message"將當(dāng)前模型中的狀態(tài)生成遷移文件。更新數(shù)據(jù)庫:使用
alembic upgrade head將剛剛生成的遷移文件,真正映射到數(shù)據(jù)庫中。同理,如果要降級,那么使用alembic downgrade head。修改代碼后,重復(fù)4~5的步驟。
-
命令和參數(shù)解釋:
- init:創(chuàng)建一個(gè)
alembic倉庫。 - revision:創(chuàng)建一個(gè)新的版本文件。
- –autogenerate:自動(dòng)將當(dāng)前模型的修改,生成遷移腳本。
- -m:本次遷移做了哪些修改,用戶可以指定這個(gè)參數(shù),方便回顧。
- upgrade:將指定版本的遷移文件映射到數(shù)據(jù)庫中,會執(zhí)行版本文件中的
upgrade函數(shù)。如果有多個(gè)遷移腳本沒有被映射到數(shù)據(jù)庫中,那么會執(zhí)行多個(gè)遷移腳本。 - [head]:代表最新的遷移腳本的版本號。
- downgrade:會執(zhí)行指定版本的遷移文件中的
downgrade函數(shù)。 - heads:展示head指向的腳本文件版本號。
- history:列出所有的遷移版本及其信息。
- current:展示當(dāng)前數(shù)據(jù)庫中的版本號。
- init:創(chuàng)建一個(gè)
另外,在你第一次執(zhí)行upgrade的時(shí)候,就會在數(shù)據(jù)庫中創(chuàng)建一個(gè)名叫alembic_version表,這個(gè)表只會有一條數(shù)據(jù),記錄當(dāng)前數(shù)據(jù)庫映射的是哪個(gè)版本的遷移文件。
經(jīng)典錯(cuò)誤:
| 錯(cuò)誤描述 | 原因 | 解決辦法 |
|---|---|---|
FAILED: Target database is not up to date. |
主要是heads和current不相同。current落后于heads的版本。 |
將current移動(dòng)到head上。alembic upgrade head |
FAILED: Can't locate revision identified by '77525ee61b5b' |
數(shù)據(jù)庫中存的版本號不在遷移腳本文件中 | 刪除數(shù)據(jù)庫的alembic_version表中的數(shù)據(jù),重新執(zhí)行alembic upgrade head
|
如果想深入學(xué)習(xí)Flask,可以觀看這套免費(fèi)Flask教學(xué)視頻:零基礎(chǔ):Flask入門到項(xiàng)目實(shí)戰(zhàn)
</article>
版權(quán)聲明: https://blog.csdn.net/huangyong1314/article/details/80555201