Welcome to Alembic’s documentation!

Alembic is a lightweight database migration tool for usage with the SQLAlchemy Database Toolkit for Python.

• Front Matter
  • Project Homepage
  • Project Status
  • Installation
    • Dependencies
  • Community
  • Bugs
• Tutorial
  • The Migration Environment
  • Creating an Environment
  • Editing the .ini File
  • Create a Migration Script
  • Running our First Migration
  • Running our Second Migration
  • Partial Revision Identifiers
  • Relative Migration Identifiers
  • Getting Information
    • Viewing History Ranges
  • Downgrading
  • Next Steps
• Auto Generating Migrations
  • What does Autogenerate Detect (and what does it not detect?)
  • Comparing and Rendering Types
    • Controlling the Module Prefix
    • Affecting the Rendering of Types Themselves
    • Comparing Types
• Generating SQL Scripts (a.k.a. “Offline Mode”)
  • Getting the Start Version
  • Writing Migration Scripts to Support Script Generation
  • Customizing the Environment
• The Importance of Naming Constraints
  • Integration of Naming Conventions into Operations, Autogenerate
• Running “Batch” Migrations for SQLite and Other Databases
  • Controlling Table Reflection
  • Dealing with Constraints
    • Dropping Unnamed or Named Foreign Key Constraints
    • Including unnamed UNIQUE constraints
    • Including CHECK constraints
    • Dealing with Referencing Foreign Keys
  • Working in Offline Mode
  • Batch mode with Autogenerate
  • Batch mode with databases other than SQLite
• Working with Branches
  • Merging Branches
  • Working with Explicit Branches
    • Referring to all heads at once
    • Referring to a Specific Version
    • Working with Branch Labels
    • More Label Syntaxes
  • Working with Multiple Bases
    • Setting up Multiple Version Directories
    • Creating a Labeled Base Revision
    • Running with Multiple Bases
  • Branch Dependencies
• Operation Reference
• Cookbook
  • Building an Up to Date Database from Scratch
  • Conditional Migration Elements
  • Sharing a Connection with a Series of Migration Commands and Environments
  • Replaceable Objects
    • The Replaceable Object Structure
    • Create Operations for the Target Objects
    • Create Initial Migrations
    • Create Revision Migrations
  • Don’t Generate Empty Migrations with Autogenerate
• API Details
  • Overview
  • Runtime Objects
    • The Environment Context
    • The Migration Context
  • Configuration
  • Commands
  • Operation Directives
    • Operation Plugins
    • Built-in Operation Objects
  • Autogeneration
    • Getting Diffs
    • Customizing Revision Generation
    • Autogenerating Custom Operation Directives
  • Script Directory
    • Revision
  • DDL Internals
    • MySQL
    • MS-SQL
    • Postgresql
    • SQLite
• Changelog
  • 0.8.3
    • bug
  • 0.8.2
    • bug
  • 0.8.1
    • feature
    • bug
  • 0.8.0
    • feature
    • bug
    • misc
  • 0.7.7
    • feature
    • bug
  • 0.7.6
    • feature
    • bug
  • 0.7.5
    • feature
    • bug
  • 0.7.4
    • bug
  • 0.7.3
    • bug
  • 0.7.2
    • bug
  • 0.7.1
    • feature
    • bug
  • 0.7.0
    • changed
    • feature
    • bug
  • 0.6.7
    • feature
    • bug
  • 0.6.6
    • feature
    • bug
    • misc
  • 0.6.5
    • feature
    • bug
  • 0.6.4
    • feature
    • bug
  • 0.6.3
    • feature
    • bug
  • 0.6.2
    • feature
    • bug
  • 0.6.1
    • feature
    • bug
  • 0.6.0
    • feature
    • bug
    • misc
  • 0.5.0
    • feature
    • bug
    • misc
  • 0.4.2
    • feature
    • bug
  • 0.4.1
    • feature
    • bug
  • 0.4.0
    • feature
    • bug
  • 0.3.6
    • feature
    • bug
  • 0.3.5
    • feature
    • bug
  • 0.3.4
    • bug
  • 0.3.3
    • feature
    • bug
  • 0.3.2
    • feature
    • bug
  • 0.3.1
    • bug
  • 0.3.0
    • feature
    • misc
  • 0.2.2
    • feature
    • bug
  • 0.2.1
    • bug
  • 0.2.0
    • feature
    • bug
  • 0.1.1
    • feature
    • bug
  • 0.1.0

Indices and tables

• Index
• Module Index
• Search Page