news 2026/8/7 15:22:38

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/8/7 21:18:30

2025年GEO优化机会与争议以及规范发展的必要性

一、2025年GEO现状&#xff1a;争议与机会并存 1. GEO是什么&#xff1f;与SEO有什么区别 GEO含义&#xff1a;是Generative Engine Optimization的首字母简称&#xff0c;含义是生成式引擎优化&#xff0c;GEO是AI大模型时代的内容优化新策略&#xff0c;是指通过生成结构化…

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

2026老年春晚怀化区域节目征集启动仪式在怀化学院举行

2025年12月12日&#xff0c;由中国老龄事业发展基金会主办的2026老年春节联欢晚会怀化选区节目征集启动仪式在怀化学院举行。中国老龄事业发展基金会是民政部、全国老龄办领导下的全国性慈善组织&#xff0c;老年春节联欢晚会是中国老龄事业发展基金会主办以中老年群体为主的系…

作者头像 李华
网站建设 2026/8/7 23:33:37

【笔记篇】【硬件基础篇】电力电子元器件应用手册 阅读笔记(1)电阻器及其应用

电力电子元器件应用手册 曲学基第一章 电阻器及其应用一、电阻器基础核心知识点1. 定义与核心特性2. 固定电阻器主要指标3. 阻值标示方法4. 选用常识二、各类电阻器核心知识点1. 高压精密电阻器2. 高阻/超高阻电阻器3. 热敏电阻4. 压敏电阻5. 湿敏电阻6. 磁敏电阻7. 气敏电阻8.…

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

柠檬 软件测试之python全栈自动化测试工程师第25期

在自动化测试领域&#xff0c;我们常常将接口自动化和 UI 自动化视为两个独立的“山头”。接口测试团队负责后端逻辑的验证&#xff0c;快而准&#xff1b;UI 测试团队负责用户流程的验证&#xff0c;直观但脆弱。然而&#xff0c;随着业务复杂度的提升&#xff0c;这种“各扫门…

作者头像 李华
网站建设 2026/8/7 23:00:19

基于php的微信小程序的学习交流平台系统(源码+lw+部署文档+讲解等)

课题介绍本课题聚焦学习交流场景的数字化需求&#xff0c;设计实现一套基于PHP后端与微信小程序前端的学习交流平台系统。随着移动学习热潮兴起&#xff0c;微信小程序凭借无需安装、触达便捷的优势&#xff0c;成为搭建轻量化学习场景的理想载体&#xff0c;而PHP语言成熟稳定…

作者头像 李华