API 详细信息

Alembic 的内部 API 具有许多公共集成点，可用于扩展 Alembic 的功能以及以新方式重新使用其功能。随着项目的增长，为此目的创建并公开了更多 API。

通常情况下，对于 Alembic 的基本使用，无需直接使用此处讨论的大多数 API 详细信息；最终用户通常使用的唯一 API 是 Operations 类提供的方法，该类在该小节之外进行了讨论，以及可传递给 EnvironmentContext.configure() 方法的参数，在配置 env.py 环境时使用。但是，实际应用通常会最终使用更多内部 API，特别是能够以编程方式运行命令，如 命令 部分中所述。

• 概述
• 运行时对象
  • 环境上下文
  • 迁移上下文
• 配置
  • 配置
  • MessagingOptions
  • main()
• 命令
  • branches()
  • check()
  • current()
  • downgrade()
  • edit()
  • ensure_version()
  • heads()
  • history()
  • init()
  • list_templates()
  • merge()
  • revision()
  • show()
  • stamp()
  • upgrade()
• 操作指令
  • 操作插件
  • 内置操作对象
• 自动生成
  • 获取差异
  • 自定义修订版生成
  • 自动生成自定义操作指令
• 脚本目录
  • 脚本
  • ScriptDirectory
  • 修订版
  • 写入挂钩
• DDL 内部
  • AddColumn
  • AlterColumn
  • AlterTable
  • ColumnComment
  • ColumnDefault
  • ColumnName
  • ColumnNullable
  • ColumnType
  • ComputedColumnDefault
  • DropColumn
  • IdentityColumnDefault
  • RenameTable
  • add_column()
  • alter_column()
  • alter_table()
  • drop_column()
  • format_column_name()
  • format_server_default()
  • format_table_name()
  • format_type()
  • quote_dotted()
  • visit_add_column()
  • visit_column_default()
  • visit_column_name()
  • visit_column_nullable()
  • visit_column_type()
  • visit_computed_column()
  • visit_drop_column()
  • visit_identity_column()
  • visit_rename_table()
  • DefaultImpl
  • ImplMeta
  • Params
  • MySQL
  • MS-SQL
  • Postgresql
  • SQLite