diff options
| author | Mike Bayer <mike_mp@zzzcomputing.com> | 2020-03-20 16:40:47 -0400 |
|---|---|---|
| committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2020-03-20 16:40:47 -0400 |
| commit | a25e2e02e108551d2910171202fd91fdaeb8162c (patch) | |
| tree | 1fc52ba46d66ca8a3adfa820394865a3bde59e3e /doc/build/core | |
| parent | 376708f4a4958bf2559c14900c52aa6fc7fd05b3 (diff) | |
| download | sqlalchemy-a25e2e02e108551d2910171202fd91fdaeb8162c.tar.gz | |
Clarify Alembic vs. Migrate
Migrate is fully legacy at this point so continue to mention
it to provide clarity, but ensure it isn't suggested
as a real alternative. It's unclear if Migrate will be able
to support SQLAlchemy 2.0.
Change-Id: Ia81aaccbd18f197ab533b083e87cc4d04ea05839
Diffstat (limited to 'doc/build/core')
| -rw-r--r-- | doc/build/core/metadata.rst | 19 |
1 files changed, 9 insertions, 10 deletions
diff --git a/doc/build/core/metadata.rst b/doc/build/core/metadata.rst index 259566a24..3d219ec06 100644 --- a/doc/build/core/metadata.rst +++ b/doc/build/core/metadata.rst @@ -241,16 +241,15 @@ such as by passing a string to :meth:`.Connection.execute` or by using the :class:`.DDL` construct, it's a common practice to automate the maintenance of database schemas in relation to application code using schema migration tools. -There are two major migration tools available for SQLAlchemy: - -* `Alembic <https://alembic.sqlalchemy.org>`_ - Written by the author of SQLAlchemy, - Alembic features a highly customizable environment and a minimalistic usage pattern, - supporting such features as transactional DDL, automatic generation of "candidate" - migrations, an "offline" mode which generates SQL scripts, and support for branch - resolution. -* `SQLAlchemy-Migrate <https://github.com/openstack/sqlalchemy-migrate>`_ - The original - migration tool for SQLAlchemy, SQLAlchemy-Migrate is still used by projects - such as Openstack, however is being superseded by Alembic. +The SQLAlchemy project offers the `Alembic <https://alembic.sqlalchemy.org>`_ +migration tool for this purpose. Alembic features a highly customizable +environment and a minimalistic usage pattern, supporting such features as +transactional DDL, automatic generation of "candidate" migrations, an "offline" +mode which generates SQL scripts, and support for branch resolution. + +Alembic supersedes the `SQLAlchemy-Migrate +<https://github.com/openstack/sqlalchemy-migrate>`_ project, which is the +original migration tool for SQLAlchemy and is now considered legacy. Specifying the Schema Name |
