From c7e0f3d3aa1897b1d01a43972f35690311fe9354 Mon Sep 17 00:00:00 2001 From: Mike Bayer Date: Fri, 20 Mar 2020 16:40:47 -0400 Subject: [PATCH] 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 (cherry picked from commit a25e2e02e108551d2910171202fd91fdaeb8162c) --- doc/build/core/metadata.rst | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/doc/build/core/metadata.rst b/doc/build/core/metadata.rst index 259566a24a..3d219ec069 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 `_ - 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 `_ - 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 `_ +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 +`_ project, which is the +original migration tool for SQLAlchemy and is now considered legacy. Specifying the Schema Name -- 2.47.2