前言
1.
指南
❱
1.1.
迁移环境
1.2.
创建环境
1.3.
编辑.ini文件
1.4.
创建迁移脚本
1.5.
初次运行迁移
1.6.
再次运行迁移
1.7.
部分修订标识符
1.8.
相对迁移标识符
1.9.
获取信息
❱
1.9.1.
查看历史范围
1.10.
降级
1.11.
下一步
2.
基于自动生成的迁移
❱
2.1.
Autogenerate 检测什么
2.2.
自动生成多个元数据集合
2.3.
控制要自动生成的内容
❱
2.3.1.
从自动生成过程中过滤模式名称
2.3.2.
从自动生成过程中过滤表名
2.3.3.
基于对象的过滤
2.4.
比较和渲染类型
❱
2.4.1.
控制模块前缀
2.4.2.
影响类型本身的渲染
2.4.3.
比较类型
2.5.
将提交处理过程和 Python 代码格式化程序应用于生成的修订
❱
2.5.1.
基本格式化程序配置
2.5.2.
自定义Python函数钩子
3.
生成SQL脚本(又称离线模式)
❱
3.1.
获取起始版本
3.2.
编写支持生成脚本的迁移脚本
3.3.
自定义环境
4.
命名约束的重要性
❱
4.1.
将命名约定集成到操作中以及自动生成中
5.
在SQLite和其他数据中运行"批处理"迁移脚本
❱
5.1.
控制表反射
5.2.
处理约束
❱
5.2.1.
删除未命名或命名的外键约束
5.2.2.
包含未命名的 UNIQUE 约束
5.2.3.
更改布尔、枚举和其他隐式 CHECK 数据类型的类型
5.2.4.
包括 CHECK 约束
5.2.5.
处理引用外键
5.3.
在离线模式下工作
5.4.
带自动生成的批处理模式
5.5.
SQLite 以外的数据库的批处理模式
6.
工作分支
❱
6.1.
合并分支
6.2.
使用显式分支
❱
6.2.1.
一次引用到所有的head
6.2.2.
引用特定版本
6.2.3.
使用分支标注
6.2.4.
更多标注语法
6.3.
基于多个base工作
❱
6.3.1.
设置多版本目录
6.3.2.
创建带标注的基本修订
6.3.3.
基于多个base运行
6.4.
分支依赖
7.
操作参考
❱
7.1.
alembic.operations.Operations
❱
7.1.1.
add_column
7.1.2.
alter_column
7.1.3.
batch_alter_table
7.1.4.
bulk_insert
7.1.5.
create_check_constraint
7.1.6.
create_exclude_constraint
7.1.7.
create_foreign_key
7.1.8.
create_index
7.1.9.
create_primary_key
7.1.10.
create_table
7.1.11.
create_table_comment
7.1.12.
create_unique_constraint
7.1.13.
drop_column
7.1.14.
drop_constraint
7.1.15.
drop_index
7.1.16.
drop_table
7.1.17.
drop_table_comment
7.1.18.
execute
7.1.19.
f
7.1.20.
get_bind
7.1.21.
get_context
7.1.22.
implementation_for
7.1.23.
inline_literal
7.1.24.
invoke
7.1.25.
register_operation
7.1.26.
rename_table
7.2.
alembic.operations.BatchOperations
❱
7.2.1.
add_column
7.2.2.
alter_column
7.2.3.
create_check_constraint
7.2.4.
create_exclude_constraint
7.2.5.
create_foreign_key
7.2.6.
create_index
7.2.7.
create_primary_key
7.2.8.
create_table_comment
7.2.9.
create_unique_constraint
7.2.10.
drop_column
7.2.11.
drop_constraint
7.2.12.
drop_index
7.2.13.
drop_table_comment
8.
cookbook
❱
8.1.
从头开始构建最新的数据库
8.2.
条件迁移元素
8.3.
与一系列迁移命令和环境共享连接
8.4.
可替换对象
❱
8.4.1.
可替换对象结构
8.4.2.
为目标对象创建操作
8.4.3.
创建初始迁移
8.4.4.
创建修订迁移
8.5.
PostgreSQL 数据库的基础架构级多租户
8.6.
不要使用 Autogenerate 生成空迁移
8.7.
当表也将被删除时不要发出 DROP INDEX
8.8.
不要使用autogenerate生成任何 DROP TABLE 指令
8.9.
将自定义排序应用于 CREATE TABLE 中的表列
8.10.
不要为视图发出 CREATE TABLE 语句
8.11.
从一个 .ini 文件运行多个 Alembic 环境
8.12.
打印 Python 代码以生成特定的数据库表
8.13.
直接运行 Alembic 操作对象（如来自autogenerate）
8.14.
测试当前的数据库修订版本处于head
8.15.
将 Asyncio 与 Alembic 结合使用
9.
API详细
❱
9.1.
概览
9.2.
运行时对象
❱
9.2.1.
Environment Context
❱
9.2.1.1.
begin_transaction
9.2.1.2.
config
9.2.1.3.
configure
9.2.1.4.
execute
9.2.1.5.
get_bind
9.2.1.6.
get_context
9.2.1.7.
get_head_revision
9.2.1.8.
get_head_revisions
9.2.1.9.
get_revision_argument
9.2.1.10.
get_starting_revision_argument
9.2.1.11.
get_tag_argument
9.2.1.12.
get_x_argument
9.2.1.13.
is_offline_mode
9.2.1.14.
is_transactional_ddl
9.2.1.15.
run_migrations
9.2.1.16.
script
9.2.1.17.
static_output
9.2.2.
Migration Context
❱
9.2.2.1.
autocommit_block
9.2.2.2.
begin_transaction
9.2.2.3.
bind
9.2.2.4.
config
9.2.2.5.
configure
9.2.2.6.
execute
9.2.2.7.
get_current_heads
9.2.2.8.
get_current_revision
9.2.2.9.
run_migrations
9.2.2.10.
stamp
9.3.
配置
❱
9.3.1.
attributes
9.3.2.
cmd_opts
9.3.3.
config_file_name
9.3.4.
config_ini_section
9.3.5.
file_config
9.3.6.
get_main_option
9.3.7.
get_section
9.3.8.
get_section_option
9.3.9.
get_template_directory
9.3.10.
print_stdout
9.3.11.
set_main_option
9.3.12.
set_section_option
9.3.13.
main
9.4.
命令
❱
9.4.1.
branches
9.4.2.
current
9.4.3.
downgrade
9.4.4.
edit
9.4.5.
ensure_version
9.4.6.
heads
9.4.7.
history
9.4.8.
init
9.4.9.
list_templates
9.4.10.
merge
9.4.11.
revision
9.4.12.
show
9.4.13.
stamp
9.4.14.
upgrade
9.5.
操作指令
❱
9.5.1.
操作插件
9.5.2.
内置操作对象
9.6.
自动生成
❱
9.6.1.
获取差异
9.6.2.
生成自定义修订
9.6.3.
Autogenerate自定义操作指令
9.7.
脚本目录
❱
9.7.1.
修订
9.7.2.
写钩子
9.8.
DDL 内部结构
❱
9.8.1.
MySQL
9.8.2.
MS-SQL
9.8.3.
Postgresql
9.8.4.
SQLite
10.
更新历史
index
module-index
Document-English
Light (default)
Rust
Coal
Navy
Ayu
alembic 中文文档
main
alembic.config.
main
(
argv
=None,
prog
=None, **kwargs)
The console runner function for Alembic.