sqlalchemy-migrate/docs/changeset.rst

Database schema migrations

migrate.changeset.schema

Importing migrate.changeset adds some new methods to existing SQLAlchemy objects, as well as creating functions of its own. Most operations can be done either by a method or a function. Methods match SQLAlchemy's existing API and are more intuitive when the object is available; functions allow one to make changes when only the name of an object is available (for example, adding a column to a table in the database without having to load that table into Python).

Changeset operations can be used independently of SQLAlchemy Migrate's versioning <versioning-system>.

For more information, see the generated documentation for migrate.changeset.

Summary of supported actions:

• Create a column <ChangesetColumn.create>
• Drop a column <ChangesetColumn.drop>
• Alter a column <ChangesetColumn.alter> (follow a link for list of supported changes)
• Rename a table <ChangesetTable.rename>
• Rename an index <ChangesetIndex.rename>
• Create primary key constraint <migrate.changeset.constraint.PrimaryKeyConstraint>
• Drop primary key constraint <migrate.changeset.constraint.PrimaryKeyConstraint.drop>
• Create foreign key contraint <migrate.changeset.constraint.ForeignKeyConstraint.create>
• Drop foreign key constraint <migrate.changeset.constraint.ForeignKeyConstraint.drop>
• Create unique key contraint <migrate.changeset.constraint.UniqueConstraint.create>
• Drop unique key constraint <migrate.changeset.constraint.UniqueConstraint.drop>
• Create check key contraint <migrate.changeset.constraint.CheckConstraint.create>
• Drop check key constraint <migrate.changeset.constraint.CheckConstraint.drop>

Note

alter_metadata keyword defaults to True.

Column

Given a standard SQLAlchemy table:

table = Table('mytable', meta,
   Column('id', Integer, primary_key=True),
)
table.create()

Create a column <ChangesetColumn.create>:

col = Column('col1', String, default='foobar')
col.create(table, populate_default=True)

# Column is added to table based on its name
assert col is table.c.col1

# col1 is populated with 'foobar' because of `populate_default`

Drop a column <ChangesetColumn.drop>:

col.drop()

Alter a column <ChangesetColumn.alter>:

col.alter(name='col2')

# Renaming a column affects how it's accessed by the table object
assert col is table.c.col2

# Other properties can be modified as well
col.alter(type=String(42), default="life, the universe, and everything", nullable=False)

# Given another column object, col1.alter(col2), col1 will be changed to match col2
col.alter(Column('col3', String(77), nullable=True))
assert col.nullable
assert table.c.col3 is col

Warning

Since version 0.6.0 passing column into ChangesetColumn.alter is deprecated. Pass in explicit parameters instead.

Note

Since version 0.6.0 you can pass primary_key_name, index_name and unique_name to column.create method to issue ALTER TABLE ADD CONSTRAINT after changing the column. Note for multi columns constraints and other advanced configuration, check constraint tutorial <constraint-tutorial>.

Table

SQLAlchemy supports table create/drop.

Rename a table <ChangesetTable.rename>:

table.rename('newtablename')

migrate.changeset.constraint

Index

SQLAlchemy supports index create/drop.

Rename an index <migrate.changeset.schema.ChangesetIndex.rename>, given an SQLAlchemy Index object:

index.rename('newindexname')

Constraint

SQLAlchemy supports creating/dropping constraints at the same time a table is created/dropped. SQLAlchemy Migrate adds support for creating/dropping PrimaryKeyConstraint/ForeignKeyConstraint/CheckConstraint/UniqueConstraint constraints independently. (as ALTER TABLE statements).

The following rundowns are true for all constraints classes:

1. Make sure you do from migrate.changeset import * after SQLAlchemy imports since migrate does not patch SA's Constraints.

2. You can also use Constraints as in SQLAlchemy. In this case passing table argument explicitly is required:

   cons = PrimaryKeyConstraint('id', 'num', table=self.table)
   
   # Create the constraint
   cons.create()
   
   # Drop the constraint
   cons.drop()

or you can pass in column objects (and table argument can be left out):

cons = PrimaryKeyConstraint(col1, col2)

3. Some dialects support CASCADE option when dropping constraints:

   cons = PrimaryKeyConstraint(col1, col2)
   
   # Create the constraint
   cons.create()
   
   # Drop the constraint
   cons.drop(cascade=True)

Note

SQLAlchemy Migrate will try to guess the name of the constraints for databases, but if it's something other than the default, you'll need to give its name. Best practice is to always name your constraints. Note that Oracle requires that you state the name of the constraint to be created/dropped.

Examples

Primary key constraints:

from migrate.changeset import *

cons = PrimaryKeyConstraint(col1, col2)

# Create the constraint
cons.create()

# Drop the constraint
cons.drop()

Foreign key constraints:

from migrate.changeset import *

cons = ForeignKeyConstraint([table.c.fkey], [othertable.c.id])

# Create the constraint
cons.create()

# Drop the constraint
cons.drop()

Check constraints:

from migrate.changeset import *

cons = CheckConstraint('id > 3', columns=[table.c.id])

# Create the constraint
cons.create()

# Drop the constraint
cons.drop()

Unique constraints:

from migrate.changeset import *

cons = UniqueConstraint('id', 'age', table=self.table)

# Create the constraint
cons.create()

# Drop the constraint
cons.drop()