summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2023-05-15 15:19:11 -0400
committerMike Bayer <mike_mp@zzzcomputing.com>2023-05-15 15:44:20 -0400
commit871a409f69e07a345ccdfac766ffade80425e6f7 (patch)
treea695ff943dfb854dae637673319815879e4443cb
parent32a82f7e4d18c0c1459a30cd91e2265971de10f8 (diff)
downloadalembic-871a409f69e07a345ccdfac766ffade80425e6f7.tar.gz
1.11.0 in changelog file; doc updates
Change-Id: I5098f9fe2bf57ad93f400e34d914ae0e3b45c747
-rw-r--r--alembic/op.pyi4
-rw-r--r--alembic/operations/base.py4
-rw-r--r--alembic/operations/ops.py4
-rw-r--r--alembic/runtime/migration.py2
-rw-r--r--docs/build/changelog.rst2
-rw-r--r--docs/build/unreleased/1178.rst17
-rw-r--r--docs/build/unreleased/1231.rst8
-rw-r--r--docs/build/unreleased/1237.rst11
8 files changed, 29 insertions, 23 deletions
diff --git a/alembic/op.pyi b/alembic/op.pyi
index 8c672fa..10e6f59 100644
--- a/alembic/op.pyi
+++ b/alembic/op.pyi
@@ -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
diff --git a/alembic/operations/base.py b/alembic/operations/base.py
index 39dadda..4e59e5b 100644
--- a/alembic/operations/base.py
+++ b/alembic/operations/base.py
@@ -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
diff --git a/alembic/operations/ops.py b/alembic/operations/ops.py
index 05c01aa..5334a01 100644
--- a/alembic/operations/ops.py
+++ b/alembic/operations/ops.py
@@ -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
diff --git a/alembic/runtime/migration.py b/alembic/runtime/migration.py
index e67434d..8baeaf0 100644
--- a/alembic/runtime/migration.py
+++ b/alembic/runtime/migration.py
@@ -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`,
diff --git a/docs/build/changelog.rst b/docs/build/changelog.rst
index b62df7d..aa37047 100644
--- a/docs/build/changelog.rst
+++ b/docs/build/changelog.rst
@@ -4,7 +4,7 @@ Changelog
==========
.. changelog::
- :version: 1.10.5
+ :version: 1.11.0
:include_notes_from: unreleased
.. changelog::
diff --git a/docs/build/unreleased/1178.rst b/docs/build/unreleased/1178.rst
index 25789d3..99cf546 100644
--- a/docs/build/unreleased/1178.rst
+++ b/docs/build/unreleased/1178.rst
@@ -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.
diff --git a/docs/build/unreleased/1231.rst b/docs/build/unreleased/1231.rst
index 37678ca..b472f22 100644
--- a/docs/build/unreleased/1231.rst
+++ b/docs/build/unreleased/1231.rst
@@ -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.
diff --git a/docs/build/unreleased/1237.rst b/docs/build/unreleased/1237.rst
index 9717064..bc4c5e0 100644
--- a/docs/build/unreleased/1237.rst
+++ b/docs/build/unreleased/1237.rst
@@ -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".