news 2026/6/10 13:54:44

alembic使用指南

作者头像

张小明

前端开发工程师

1.2k 24
文章封面图
alembic使用指南

一、alembic是什么?

Alembic 是一个用于 Python 数据库迁移和版本控制的工具。它与 SQLAlchemy(一个流行的 Python ORM 库)紧密集成,共同为 Python 应用程序提供数据库管理和迁移支持。

python使用mysql时常用SQLAlchemy+Alembic进行ORM和数据库迁移。

二、如何集成到项目中?

1.安装

uv install alembic==1.13.0 or pip install alembic==1.13.0

2.进入项目根目录 初始化Alembic

2.1 终端执行 alembic init alembic init 初始化命令 alembic 环境名称

项目中多出alembic目录

alembic.ini: Alembic 的主配置文件。

env.py: Alembic 运行时环境的 Python 脚本,用于配置 SQLAlchemy 引擎和元数据。

script.py.mako: 迁移脚本的模板文件。

versions/: 存放所有迁移脚本的目录。

图片

2.2 配置 alembic.ini(指定数据库连接字符串)

通过环境变量读取 不要硬编码

图片

2.3 配置 env.py (告诉 Alembic 你的 SQLAlchemy 模型在哪里,以便它能够进行自动检测。)

找到 target_metadata 变量,将其指向你的 SQLAlchemy Base.metadata 对象。

图片

解释一下:Base对象是所有模型类的基类,你创建的所有模型都要继承Base

from sqlalchemy.ext.declarative import declarative_base

Base = declarative_base()

创建Base虽然创建在哪都可以,最好放在数据库连接层,结构清晰,目录结构如下

图片

2.4 创建SQLAlchemy模型

所有模型集成Base对象,这样后面执行迁移就会自动检测所有更改的字段

图片

3.生成第一个迁移脚本

要提前安装 pip install pymysql

3.1 自动生成

终端输入命令: alembic revision --autogenerate -m "Create initial tables"

alembic revision: 创建一个新的数据库迁移脚本。

--autogenerate: 自动检测你的 SQLAlchemy 模型与数据库当前状态的差异,并生成相应的升级/降级 SQL 语句。

-m "Create initial tables": 为这个迁移脚本添加一个描述性消息,方便你理解其目的。

图片

图片

检查生成的迁移文件sql命令是否正常 不正常就手动或者找ai修复下

3.2 手动生成(推荐)

第一次创建迁移文件 上一次版本号为None

后续按照现有的文件格式创建新的迁移即可,版本号使用基于时间戳的uuid即可,上一个版本的版本号记得填。

upgrade:对应新的sql操作

downgrade:操作失败回滚

有时候alembic对于修改和删除的字段检测不出来,最好就手写迁移脚本

4.执行迁移

终端命令 alembic upgrade head 检查库中表是否存在

图片

逻辑流程图

初始化 Alembic 项目

配置 alembic.ini (数据库连接) & env.py (加载 ORM 模型, 建立连接)

定义 SQLAlchemy Base 和 ORM 模型

ORM 模型发生变化?

├─ 是 (模型与数据库结构不一致)

│ ↓

│ 5. 生成迁移文件 (alembic revision --autogenerate)

│ (Alembic 比较 ORM 模型定义 与 MySQL 数据库实际结构)

│ ↓

│ 6. 人工检查并修改迁移文件 (确保 upgrade/downgrade 逻辑正确)

│ ↓

│ 7. 执行迁移 (alembic upgrade head)

│ (Alembic 读取迁移文件, 更新 MySQL 数据库结构, 并更新 alembic_version 表)

│ ↓

└─ 否 (模型与数据库结构一致)

(无需迁移)

应用程序启动 & 与更新后的 MySQL 数据库交互

三、常用的命令?

alembic revision --autogenerate -m "描述" 自动生成迁移脚本

alembic upgrade head 执行最新迁移

alembic current 查看当前数据库迁移脚本

alembic stamp <revision_id> 将数据库标记为指定版本(不执行迁移)

alembic history 查看迁移历史

版权声明: 本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若内容造成侵权/违法违规/事实不符,请联系邮箱:809451989@qq.com进行投诉反馈,一经查实,立即删除!
网站建设 2026/6/10 3:01:13

大模型通义千问3-VL-Plus - 视觉推理(在线视频)

一、概论通义千问VL模型支持对视频内容进行理解&#xff0c;文件形式包括图像列表&#xff08;视频帧&#xff09;或视频文件。视频抽帧说明通义千问VL 模型通过从视频中提取帧序列进行内容分析&#xff0c;抽帧的频率决定了模型分析的精细度&#xff0c;不同 SDK 抽帧频率不同…

作者头像 李华
网站建设 2026/6/8 23:35:48

400亿美元骗局落幕,LUNA加密货币创始人被判15年!

一场震动全球金融市场、导致约400亿美元市值在短短数日内灰飞烟灭的加密货币海啸&#xff0c;终于迎来了司法上的关键时刻。美国纽约南区联邦地方法院于12月11日做出历史性宣判&#xff0c;Terraform Labs的联合创始人权道亨&#xff08;Do Kwon&#xff09;&#xff0c;因其在…

作者头像 李华
网站建设 2026/6/10 8:23:02

香港就加密货币税收规则启动公众咨询

在全球数字资产监管格局日益清晰化的宏大背景下&#xff0c;香港正以其一贯的审慎与前瞻&#xff0c;迈出至关重要的一步。近日&#xff0c;香港特区政府正式宣布&#xff0c;就引入国际性的《加密资产报告框架》&#xff08;Crypto-Asset Reporting Framework, CARF&#xff0…

作者头像 李华
网站建设 2026/6/10 13:20:11

探索VSG并联:原理与实践

VSG并联&#xff0c;有对应讲解视频最近在电力电子领域研究VSG&#xff08;虚拟同步发电机&#xff09;并联相关的内容&#xff0c;感觉特别有意思&#xff0c;也发现网上有对应讲解视频&#xff0c;今天就来和大家分享下我的学习心得。 VSG并联是什么&#xff1f; VSG并联&…

作者头像 李华
网站建设 2026/6/10 2:24:07

GPU并行计算同步技术终极指南:高效方案与性能优化技巧

GPU并行计算同步技术终极指南&#xff1a;高效方案与性能优化技巧 【免费下载链接】tilelang Domain-specific language designed to streamline the development of high-performance GPU/CPU/Accelerators kernels 项目地址: https://gitcode.com/GitHub_Trending/ti/tile…

作者头像 李华
网站建设 2026/6/10 13:20:40

基于php多媒体教室管理系统(源码+lw+部署文档+讲解等)

课题介绍本课题聚焦校园多媒体教室运营管理的实际需求&#xff0c;设计实现一套基于PHP技术的多媒体教室管理系统。当前多数院校多媒体教室存在预约流程繁琐、设备状态监管不足、使用记录混乱等问题&#xff0c;影响教学活动高效开展。系统采用“PHP&#xff08;ThinkPHP框架&a…

作者头像 李华