diff options
| author | iElectric <unknown> | 2010-07-11 17:45:29 +0200 |
|---|---|---|
| committer | iElectric <unknown> | 2010-07-11 17:45:29 +0200 |
| commit | 201fe50e6cd03eab7ff96bd565bf3ae37fe4a687 (patch) | |
| tree | dfddaa1d9b776ac1ad56749d4235c779513cf950 /docs/changeset.rst | |
| parent | a3d3470d5ecc5d89b747f634c32093c8143b6013 (diff) | |
| download | sqlalchemy-migrate-201fe50e6cd03eab7ff96bd565bf3ae37fe4a687.tar.gz | |
better document summary of changeset actions
Diffstat (limited to 'docs/changeset.rst')
| -rw-r--r-- | docs/changeset.rst | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/changeset.rst b/docs/changeset.rst index f466c82..ab5993b 100644 --- a/docs/changeset.rst +++ b/docs/changeset.rst @@ -21,6 +21,26 @@ Changeset operations can be used independently of SQLAlchemy Migrate's For more information, see the generated documentation for :mod:`migrate.changeset`. +.. _summary-changeset-api: + +Summary of supported actions: + + +* :meth:`Create a column <ChangesetColumn.create>` +* :meth:`Drop a column <ChangesetColumn.drop>` +* :meth:`Alter a column <ChangesetColumn.alter>` (name, nullabe, type, server_default) +* :meth:`Rename a table <ChangesetTable.rename>` +* :meth:`Rename an index <ChangesetIndex.rename>` +* :meth:`Create primary key constraint <migrate.changeset.constraint.PrimaryKeyConstraint>` +* :meth:`Drop primary key constraint <migrate.changeset.constraint.PrimaryKeyConstraint.drop>` +* :meth:`Create foreign key contraint <migrate.changeset.constraint.ForeignKeyConstraint.create>` +* :meth:`Drop foreign key constraint <migrate.changeset.constraint.ForeignKeyConstraint.drop>` +* :meth:`Create unique key contraint <migrate.changeset.constraint.UniqueConstraint.create>` +* :meth:`Drop unique key constraint <migrate.changeset.constraint.UniqueConstraint.drop>` +* :meth:`Create check key contraint <migrate.changeset.constraint.CheckConstraint.create>` +* :meth:`Drop check key constraint <migrate.changeset.constraint.CheckConstraint.drop>` + + .. note:: alter_metadata keyword defaults to True. @@ -45,6 +65,8 @@ Given a standard SQLAlchemy table:: # Column is added to table based on its name assert col is table.c.col1 + # col1 is populated with 'foobar' because of `populate_default` + .. _column-drop: :meth:`Drop a column <ChangesetColumn.drop>`:: |