]> git.ipfire.org Git - thirdparty/sqlalchemy/alembic.git/commitdiff
1.11.0 in changelog file; doc updates
authorMike Bayer <mike_mp@zzzcomputing.com>
Mon, 15 May 2023 19:19:11 +0000 (15:19 -0400)
committerMike Bayer <mike_mp@zzzcomputing.com>
Mon, 15 May 2023 19:44:20 +0000 (15:44 -0400)
Change-Id: I5098f9fe2bf57ad93f400e34d914ae0e3b45c747

alembic/op.pyi
alembic/operations/base.py
alembic/operations/ops.py
alembic/runtime/migration.py
docs/build/changelog.rst
docs/build/unreleased/1178.rst
docs/build/unreleased/1231.rst
docs/build/unreleased/1237.rst

index 8c672fa3778f935de54cc16561b175b8ed5457c9..10e6f5914afbb149fe1cb0b81127180f8fd069d7 100644 (file)
@@ -1096,8 +1096,8 @@ def execute(
     * a :func:`sqlalchemy.sql.expression.update`,
       :func:`sqlalchemy.sql.expression.insert`,
       or :func:`sqlalchemy.sql.expression.delete`  construct.
-    * Pretty much anything that's "executable" as described
-      in :ref:`sqlexpression_toplevel`.
+    * Any "executable" described in SQLAlchemy Core documentation,
+      noting that no result set is returned.
 
     .. note::  when passing a plain string, the statement is coerced into
        a :func:`sqlalchemy.sql.expression.text` construct. This construct
index 39dadda86d1134f1268571eb4abce2ac8279f7a0..4e59e5ba56a3ce8f18438a0a9ec2ca4fd3a5d7fa 100644 (file)
@@ -1505,8 +1505,8 @@ class Operations(AbstractOperations):
             * a :func:`sqlalchemy.sql.expression.update`,
               :func:`sqlalchemy.sql.expression.insert`,
               or :func:`sqlalchemy.sql.expression.delete`  construct.
-            * Pretty much anything that's "executable" as described
-              in :ref:`sqlexpression_toplevel`.
+            * Any "executable" described in SQLAlchemy Core documentation,
+              noting that no result set is returned.
 
             .. note::  when passing a plain string, the statement is coerced into
                a :func:`sqlalchemy.sql.expression.text` construct. This construct
index 05c01aa1deed7b56d8929f68dde23c1c56e5cc9d..5334a01e0774511c3db93e126bb14f2f25b2466b 100644 (file)
@@ -2499,8 +2499,8 @@ class ExecuteSQLOp(MigrateOperation):
         * a :func:`sqlalchemy.sql.expression.update`,
           :func:`sqlalchemy.sql.expression.insert`,
           or :func:`sqlalchemy.sql.expression.delete`  construct.
-        * Pretty much anything that's "executable" as described
-          in :ref:`sqlexpression_toplevel`.
+        * Any "executable" described in SQLAlchemy Core documentation,
+          noting that no result set is returned.
 
         .. note::  when passing a plain string, the statement is coerced into
            a :func:`sqlalchemy.sql.expression.text` construct. This construct
index e67434d02850342849d1703209e5f2ff8b5d9294..8baeaf0ba691017ea56799b6b0b9e278656b3b79 100644 (file)
@@ -683,7 +683,7 @@ class MigrationContext:
         In online mode, this is an instance of
         :class:`sqlalchemy.engine.Connection`, and is suitable
         for ad-hoc execution of any kind of usage described
-        in :ref:`sqlexpression_toplevel` as well as
+        in SQLAlchemy Core documentation as well as
         for usage with the :meth:`sqlalchemy.schema.Table.create`
         and :meth:`sqlalchemy.schema.MetaData.create_all` methods
         of :class:`~sqlalchemy.schema.Table`,
index b62df7dc04949de2618a21b32bcc44f7e4262922..aa3704734abf5b8c0cc0004960f6d6cfeeac3594 100644 (file)
@@ -4,7 +4,7 @@ Changelog
 ==========
 
 .. changelog::
-    :version: 1.10.5
+    :version: 1.11.0
     :include_notes_from: unreleased
 
 .. changelog::
index 25789d3c2366724c0272acdcf9c8c3ab24c47bbe..99cf546ebf5018c2091973e5f5592b7fcbadf340 100644 (file)
@@ -1,9 +1,14 @@
 .. change::
-    :tags: changed, autogenerate
+    :tags: bug, autogenerate
     :tickets: 1178
 
-    Don't modify the metadata server default when comparing it in the
-    autogenerate process.
-    This impacts the value passes to user provided functions passed in
-    :paramref:`.EnvironmentContext.configure.compare_server_default`
-    and third party dialect that implement a custom ``compare_server_default``.
+    Modified the autogenerate implementation for comparing "server default"
+    values from user-defined metadata to not apply any quoting to the value
+    before comparing it to the server-reported default, except for within
+    dialect-specific routines as needed. This change will affect the format of
+    the server default as passed to the
+    :paramref:`.EnvironmentContext.configure.compare_server_default` hook, as
+    well as for third party dialects that implement a custom
+    ``compare_server_default`` hook in their alembic impl, to be passed "as is"
+    and not including additional quoting.   Custom implementations which rely
+    on this quoting should adjust their approach based on observed formatting.
index 37678caf8b48081d07d8dd0d8aec448aaea6e769..b472f228732c2d298722831e4fd849d4d611a0c1 100644 (file)
@@ -3,9 +3,9 @@
     :tags: usecase, asyncio
     :tickets: 1231
 
-    Added :meth:`.Operations.run_async` to the operation module to allow
-    running async functions in the ``upgrade`` or ``downgrade`` migration
-    function when running alembic using an async dialect.
-    This function will receive as first argument an
+    Added :meth:`.AbstractOperations.run_async` to the operation module to
+    allow running async functions in the ``upgrade`` or ``downgrade`` migration
+    function when running alembic using an async dialect. This function will
+    receive as first argument an
     :class:`~sqlalchemy.ext.asyncio.AsyncConnection` sharing the transaction
     used in the migration context.
index 9717064503f1b4ef1ef9c099fc9c2717c79ba556..bc4c5e0ce252e23e2fbcf52ab49f41fa2182bc3a 100644 (file)
@@ -2,8 +2,9 @@
     :tags: bug, batch
     :tickets: 1237
 
-    Added placeholder classes for ``Computed`` and ``Identity`` when older 1.x
-    SQLAlchemy versions are in use, namely prior to SQLAlchemy 1.3.11 when the
-    ``Computed`` construct was introduced. Previously these were set to None,
-    however this could cause issues with certain codepaths that were using
-    ``isinstance()`` such as one within "batch mode".
+    Added placeholder classes for :class:`~.sqla.Computed` and
+    :class:`~.sqla.Identity` when older 1.x SQLAlchemy versions are in use,
+    namely prior to SQLAlchemy 1.3.11 when the :class:`~.sqla.Computed`
+    construct was introduced. Previously these were set to None, however this
+    could cause issues with certain codepaths that were using ``isinstance()``
+    such as one within "batch mode".