]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
Clarify Alembic vs. Migrate
authorMike Bayer <mike_mp@zzzcomputing.com>
Fri, 20 Mar 2020 20:40:47 +0000 (16:40 -0400)
committerMike Bayer <mike_mp@zzzcomputing.com>
Fri, 20 Mar 2020 20:42:14 +0000 (16:42 -0400)
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
(cherry picked from commit a25e2e02e108551d2910171202fd91fdaeb8162c)

doc/build/core/metadata.rst

index 259566a24a5b3b240449181c34ea89aa66b44607..3d219ec069832f286c15cb502a426e5fb88f81b2 100644 (file)
@@ -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