starred/sandman2-jeffknupp

Fork 0

mirror of https://github.com/jeffknupp/sandman2.git synced 2026-04-25 00:25:49 +03:00

[PR #456] Scheduled weekly dependency update for week 08 #455

New issue

Open

opened 2026-02-26 01:34:26 +03:00 by kerem · 0 comments

kerem commented

2026-02-26 01:34:26 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/jeffknupp/sandman2/pull/456
Author: @pyup-bot
Created: 2/23/2026
Status: 🔄 Open

Base: master ← Head: pyup-scheduled-update-2026-02-23

📝 Commits (10+)

40ee0d7 Update flask from 1.1.2 to 3.1.3
dcb1605 Update flask-admin from 1.5.7 to 2.0.2
1b38d3c Update flask-sqlalchemy from 2.4.4 to 3.1.1
ebacc4e Update sqlalchemy from 1.3.20 to 2.0.46
af39fa2 Update wtforms from 2.3.3 to 3.2.1
82e1660 Update coverage from 5.3 to 7.13.4
04c617d Update pytest from 6.2.0 to 9.0.2
77a88f4 Update flask-cors from 3.0.9 to 6.0.2
4af4b27 Update pytest-cov from 2.10.1 to 7.0.0
5a3ab42 Update pytest-flask from 1.1.0 to 1.3.0

📊 Changes

1 file changed (+15 additions, -15 deletions)

View changed files

📝 requirements.txt (+15 -15)

📄 Description

Update Flask from 1.1.2 to 3.1.3.

The bot wasn't able to find a changelog for this release. Got an idea?

Links

PyPI: https://pypi.org/project/flask

Update Flask-Admin from 1.5.7 to 2.0.2.

Changelog

2.0.2

* Adds support for Python 3.14: https://github.com/pallets-eco/flask-admin/pull/2685
* Adds a MenuDivider item for bootstrap themes: https://github.com/pallets-eco/flask-admin/pull/2696
* Field errors are now shown in red text for bootstrap themes: https://github.com/pallets-eco/flask-admin/pull/2699

2.0.1

* Fix documentation
* Update arabic translations

2.0.0rc2

* Serbian translation updates

2.0.0rc1

Fixes:
* SQLAlchemy boolean filters now convert &quot;1&quot; and &quot;0&quot; to Python booleans, which fixes a type coercion issue with psycopg(3).

2.0.0a5

New functionality:
* Mongonengine support has been added back (no longer using `flask-mongoengine`): https://github.com/pallets-eco/flask-admin/pull/2611
* The default query for pymongo can be overridden: https://github.com/pallets-eco/flask-admin/pull/2661
* Flask async routes are supported: https://github.com/pallets-eco/flask-admin/pull/2659

Fixes:
* Bootstrap menu icons should show up properly and not duplicated: https://github.com/pallets-eco/flask-admin/pull/2666
* Redis CLI commands are now case insensitive: https://github.com/pallets-eco/flask-admin/issues/2411

Misc:
* Translations and docs have been updated
* Various type hinting improvements and fixes

2.0.0a4

Breaking changes:

* Azure Blob Storage SDK has been upgraded from the legacy version (v2) to the latest version (v12). AzureFileAdmin now accept `blob_service_client` rather than `connection_string` to give more flexibility with connection types.

2.0.0a3

Fixes:

* Jinja templates can now be loaded in StrictUndefined mode.
* Remove an implicit dependency on packaging

2.0.0a2

-------

Breaking changes:

* Removed support for Python 3.8.
* Use of the `boto` library has been replaced by `boto3`. S3FileAdmin and S3Storage now accept an `s3_client` parameter taking a `boto3.client(&#x27;s3&#x27;)` instance rather than `aws_access_key_id`, `aws_secret_access_key`, and `region` parameters.

2.0.0a1

-------

Fixes:

* Fixes compatibility with WTForms 3.2+.
* The `Apply` button for filters will show/hide correctly again
* Fix `translations_path` attribute when Flask-Admin is used with Flask-Babel
* Some translation updates.
* Date fields no longer override `widget` if set in `form_args`
* “Save and Continue Editing” button no longer discards the “return URL” (allowing to retain filters when switching back to the list)

2.0.0a0

Changes from v1.x

Breaking changes:

- Added support for Python 3.12
- Dropped support for Python 3.7
- Flask-BabelEx is no longer supported; the package is no longer  maintained and Flask-Babel is recommended/active instead.
- Flask-Mongoengine is no longer supported due to that package being  unmaintained.
- Bootstrap2 and Bootstrap3 themes are no longer available.
- `Admin()` now takes a  `theme` parameter that encapsulates all  of the configuration options for theming the admin instance. This  replaces the `template_mode` parameter.
- All remaining Flask-Admin config has been namespaced under  `FLASK_ADMIN_`.

| Config variable name | What’s changed                                |
|----|-----------------------------------------------|
| FLASK_ADMIN_SWATCH | Removed; use `Theme(swatch=...)` instead       |
| FLASK_ADMIN_FLUID_LAYOUT | Removed; use `Theme(fluid=...)` instead        |
| MAPBOX_MAP_ID | Renamed to FLASK_ADMIN_MAPBOX_MAP_ID          |
| MAPBOX_SEARCH | Renamed to FLASK_ADMIN_MAPBOX_SEARCH          |
| MAPBOX_ACCESS_TOKEN | Renamed to FLASK_ADMIN_MAPBOX_ACCESS_TOKEN    |
| GOOGLE_MAPS_API_KEY | Renamed to FLASK_ADMIN_GOOGLE_MAPS_API_KEY    |
| DEFAULT_CENTER_LAT | Renamed to FLASK_ADMIN_DEFAULT_CENTER_LAT     |
| DEFAULT_CENTER_LONG | Renamed to FLASK_ADMIN_DEFAULT_CENTER_LONG    |
| ADMIN_RAISE_ON_INTEGRITY_ERROR | Renamed to FLASK_ADMIN_RAISE_ON_INTEGRITY_ERROR |
| ADMIN_RAISE_ON_VIEW_EXCEPTION | Renamed to FLASK_ADMIN_RAISE_ON_VIEW_EXCEPTION |

Title

New features:

- Flask-Admin now supports the  `host_matching` mode of Flask apps. See  documentation for how to configure this where needed.
- Flask-Admin is now compatible with SQLAlchemy v2+, Flask v3+, WTForms  v3+, and Pillow v10+.
- Flask-Admin now declares its dependencies and supported dependency  versions more cleanly, including using pip extras. If you use  Flask-Admin with SQLAlchemy, for example, you should use  `pip install flask-admin[sqlalchemy]`  or list `flask-admin[sqlalchemy]` in  your requirements.txt or pyproject.toml files.
- Apps using content security policies to restrict the assets that can  be loaded can now whitelist Flask-Admin’s assets by passing a  `csp_nonce_generator` function to the  Admin instance. See examples or documentation for how to configure  this where needed.
- `page_size_options` can now be configured  on Admin models, to restrict the page sizes that users can select.  These are now enforced properly and cannot be bypassed by URL hacking.

And various smaller bug fixes and documentation updates.

1.6.1

* SQLAlchemy 2.x support
* General updates and bug fixes
* Dropped WTForms 1 support

1.6.0

* Dropped Python 2 support
* WTForms 3.0 support
* Various fixes

1.5.8

* SQLAlchemy 1.4.5+ compatibility fixes
* Redis CLI fixes

Links

PyPI: https://pypi.org/project/flask-admin
Changelog: https://data.safetycli.com/changelogs/flask-admin/

Update Flask-SQLAlchemy from 2.4.4 to 3.1.1.

Changelog

3.1.1

-------------

Released 2023-09-11

-   Deprecate the ``__version__`` attribute. Use feature detection, or
 ``importlib.metadata.version(&quot;flask-sqlalchemy&quot;)``, instead. :issue:`5230`

3.1.0

-------------

Released 2023-09-11

-   Drop support for Python 3.7.  :pr:`1251`
-   Add support for the SQLAlchemy 2.x API via ``model_class`` parameter. :issue:`1140`
-   Bump minimum version of SQLAlchemy to 2.0.16.
-   Remove previously deprecated code.
-   Pass extra keyword arguments from ``get_or_404`` to ``session.get``. :issue:`1149`
-   Fix bug with finding right bind key for clause statements. :issue:`1211`

3.0.5

-------------

Released 2023-06-21

-   ``Pagination.next()`` enforces ``max_per_page``. :issue:`1201`
-   Improve type hint for ``get_or_404`` return value to be non-optional. :pr:`1226`

3.0.4

-------------

Released 2023-06-19

-   Fix type hint for ``get_or_404`` return value. :pr:`1208`
-   Fix type hints for pyright (used by VS Code Pylance extension). :issue:`1205`

3.0.3

-------------

Released 2023-01-31

-   Show helpful errors when mistakenly using multiple ``SQLAlchemy`` instances for the
 same app, or without calling ``init_app``. :pr:`1151`
-   Fix issue with getting the engine associated with a model that uses polymorphic
 table inheritance. :issue:`1155`

3.0.2

-------------

Released 2022-10-14

-   Update compatibility with SQLAlchemy 2. :issue:`1122`

3.0.1

-------------

Released 2022-10-11

-   Export typing information instead of using external typeshed definitions.
 :issue:`1112`
-   If default engine options are set, but ``SQLALCHEMY_DATABASE_URI`` is not set, an
 invalid default bind will not be configured. :issue:`1117`

3.0.0

-------------

Released 2022-10-04

-   Drop support for Python 2, 3.4, 3.5, and 3.6.
-   Bump minimum version of Flask to 2.2.
-   Bump minimum version of SQLAlchemy to 1.4.18.
-   Remove previously deprecated code.
-   The session is scoped to the current app context instead of the thread. This
 requires that an app context is active. This ensures that the session is cleaned up
 after every request.
-   An active Flask application context is always required to access ``session`` and
 ``engine``, regardless of if an application was passed to the constructor.
 :issue:`508, 944`
-   Different bind keys use different SQLAlchemy ``MetaData`` registries, allowing
 tables in different databases to have the same name. Bind keys are stored and looked
 up on the resulting metadata rather than the model or table.
-   ``SQLALCHEMY_DATABASE_URI`` does not default to ``sqlite:///:memory:``. An error is
 raised if neither it nor ``SQLALCHEMY_BINDS`` define any engines. :pr:`731`
-   Configuring SQLite with a relative path is relative to ``app.instance_path`` instead
 of ``app.root_path``. The instance folder is created if necessary. :issue:`462`
-   Added ``get_or_404``, ``first_or_404``, ``one_or_404``, and ``paginate`` methods to
 the extension object. These use SQLAlchemy&#x27;s preferred ``session.execute(select())``
 pattern instead of the legacy query interface. :issue:`1088`
-   Setup methods that create the engines and session are renamed with a leading
 underscore. They are considered internal interfaces which may change at any time.
-   All parameters to ``SQLAlchemy`` except ``app`` are keyword-only.
-   Renamed the ``bind`` parameter to ``bind_key`` and removed the ``app`` parameter
 from various ``SQLAlchemy`` methods.
-   The extension object uses ``__getattr__`` to alias names from the SQLAlchemy
 package, rather than copying them as attributes.
-   The extension object is stored directly as ``app.extensions[&quot;sqlalchemy&quot;]``.
 :issue:`698`
-   The session class can be customized by passing the ``class_`` key in the
 ``session_options`` parameter. :issue:`327`
-   ``SignallingSession`` is renamed to ``Session``.
-   ``Session.get_bind`` more closely matches the base implementation.
-   Model classes and the ``db`` instance are available without imports in
 ``flask shell``. :issue:`1089`
-   The ``CamelCase`` to ``snake_case`` table name converter handles more patterns
 correctly. If model that was already created in the database changed, either use
 Alembic to rename the table, or set ``__tablename__`` to keep the old name.
 :issue:`406`
-   ``Model`` ``repr`` distinguishes between transient and pending instances.
 :issue:`967`
-   A custom model class can implement ``__init_subclass__`` with class parameters.
 :issue:`1002`
-   ``db.Table`` is a subclass instead of a function.
-   The ``engine_options`` parameter is applied as defaults before per-engine
 configuration.
-   ``SQLALCHEMY_BINDS`` values can either be an engine URL, or a dict of engine options
 including URL, for each bind. ``SQLALCHEMY_DATABASE_URI`` and
 ``SQLALCHEMY_ENGINE_OPTIONS`` correspond to the ``None`` key and take precedence.
 :issue:`783`
-   Engines are created when calling ``init_app`` rather than the first time they are
 accessed. :issue:`698`
-   ``db.engines`` exposes the map of bind keys to engines for the current app.
-   ``get_engine``, ``get_tables_for_bind``, and ``get_binds`` are deprecated.
-   SQLite driver-level URIs that look like ``sqlite:///file:name.db?uri=true`` are
 supported. :issue:`998, 1045`
-   SQLite engines do not use ``NullPool`` if ``pool_size`` is 0.
-   MySQL engines use the &quot;utf8mb4&quot; charset by default. :issue:`875`
-   MySQL engines do not set ``pool_size`` to 10.
-   MySQL engines don&#x27;t set a default for ``pool_recycle`` if not using a queue pool.
 :issue:`803`
-   ``Query`` is renamed from ``BaseQuery``.
-   Added ``Query.one_or_404``.
-   The query class is applied to ``backref`` in ``relationship``. :issue:`417`
-   Creating ``Pagination`` objects manually is no longer a public API. They should be
 created with ``db.paginate`` or ``query.paginate``. :issue:`1088`
-   ``Pagination.iter_pages`` and ``Query.paginate`` parameters are keyword-only.
-   ``Pagination`` is iterable, iterating over its items. :issue:`70`
-   Pagination count query is more efficient.
-   ``Pagination.iter_pages`` is more efficient. :issue:`622`
-   ``Pagination.iter_pages`` ``right_current`` parameter is inclusive.
-   Pagination ``per_page`` cannot be 0. :issue:`1091`
-   Pagination ``max_per_page`` defaults to 100. :issue:`1091`
-   Added ``Pagination.first`` and ``last`` properties, which give the number of the
 first and last item on the page. :issue:`567`
-   ``SQLALCHEMY_RECORD_QUERIES`` is disabled by default, and is not enabled
 automatically with ``app.debug`` or ``app.testing``. :issue:`1092`
-   ``get_debug_queries`` is renamed to ``get_recorded_queries`` to better match the
 config and functionality.
-   Recorded query info is a dataclass instead of a tuple. The ``context`` attribute is
 renamed to ``location``. Finding the location uses a more inclusive check.
-   ``SQLALCHEMY_TRACK_MODIFICATIONS`` is disabled by default. :pr:`727`
-   ``SQLALCHEMY_COMMIT_ON_TEARDOWN`` is deprecated. It can cause various design issues
 that are difficult to debug. Call ``db.session.commit()`` directly instead.
 :issue:`216`

2.5.1

-------------

Released 2021-03-18

-   Fix compatibility with Python 2.7.

2.5.0

-------------

Released 2021-03-18

-   Update to support SQLAlchemy 1.4.
-   SQLAlchemy ``URL`` objects are immutable. Some internal methods have changed to
 return a new URL instead of ``None``. :issue:`885`

Links

PyPI: https://pypi.org/project/flask-sqlalchemy
Changelog: https://data.safetycli.com/changelogs/flask-sqlalchemy/
Docs: https://pythonhosted.org/Flask-SQLAlchemy/

Update SQLAlchemy from 1.3.20 to 2.0.46.

Changelog

2.0.46

:released: January 21, 2026

 .. change::
     :tags: bug, sqlite
     :tickets: 13039

     Fixed issue in the aiosqlite driver where SQLAlchemy&#x27;s setting of
     aiosqlite&#x27;s worker thread to &quot;daemon&quot; stopped working because the aiosqlite
     architecture moved the location of the worker thread in version 0.22.0.
     This &quot;daemon&quot; flag is necessary so that a program is able to exit if the
     SQLite connection itself was not explicitly closed, which is particularly
     likely with SQLAlchemy as it maintains SQLite connections in a connection
     pool.  While it&#x27;s perfectly fine to call :meth:`.AsyncEngine.dispose`
     before program exit, this is not historically or technically necessary for
     any driver of any known backend, since a primary feature of relational
     databases is durability.  The change also implements support for
     &quot;terminate&quot; with aiosqlite when using version version 0.22.1 or greater,
     which implements a sync ``.stop()`` method.

 .. change::
     :tags: usecase, mssql
     :tickets: 13045

     Added support for the ``IF EXISTS`` clause when dropping indexes on SQL
     Server 2016 (13.x) and later versions. The :paramref:`.DropIndex.if_exists`
     parameter is now honored by the SQL Server dialect, allowing conditional
     index drops that will not raise an error if the index does not exist.
     Pull request courtesy Edgar Ramírez Mondragón.

 .. change::
     :tags: bug, postgresql
     :tickets: 13059

     Fixed issue where PostgreSQL JSONB operators
     :meth:`_postgresql.JSONB.Comparator.path_match` and
     :meth:`_postgresql.JSONB.Comparator.path_exists` were applying incorrect
     ``VARCHAR`` casts to the right-hand side operand when used with newer
     PostgreSQL drivers such as psycopg. The operators now indicate the
     right-hand type as ``JSONPATH``, which currently results in no casting
     taking place, but is also compatible with explicit casts if the
     implementation were require it at a later point.



 .. change::
     :tags: bug, postgresql
     :tickets: 13067

     Fixed regression in PostgreSQL dialect where JSONB subscription syntax
     would generate incorrect SQL for :func:`.cast` expressions returning JSONB,
     causing syntax errors. The dialect now properly wraps cast expressions in
     parentheses when using the ``[]`` subscription syntax, generating
     ``(CAST(...))[index]`` instead of ``CAST(...)[index]`` to comply with
     PostgreSQL syntax requirements. This extends the fix from :ticket:`12778`
     which addressed the same issue for function calls.

 .. change::
     :tags: bug, mariadb
     :tickets: 13070

     Fixed the SQL compilation for the mariadb sequence &quot;NOCYCLE&quot; keyword that
     is to be emitted when the :paramref:`.Sequence.cycle` parameter is set to
     False on a :class:`.Sequence`.  Pull request courtesy Diego Dupin.

 .. change::
     :tags: bug, typing
     :tickets: 13075

     Fixed typing issues where ORM mapped classes and aliased entities could not
     be used as keys in result row mappings or as join targets in select
     statements. Patterns such as ``row._mapping[User]``,
     ``row._mapping[aliased(User)]``, ``row._mapping[with_polymorphic(...)]``
     (rejected by both mypy and Pylance), and ``.join(aliased(User))``
     (rejected by Pylance) are documented and fully supported at runtime but
     were previously rejected by type checkers. The type definitions for
     :class:`._KeyType` and :class:`._FromClauseArgument` have been updated to
     accept these ORM entity types.

 .. change::
     :tags: bug, postgresql

     Improved the foreign key reflection regular expression pattern used by the
     PostgreSQL dialect to be more permissive in matching identifier characters,
     allowing it to correctly handle unicode characters in table and column
     names. This change improves compatibility with PostgreSQL variants such as
     CockroachDB that may use different quoting patterns in combination with
     unicode characters in their identifiers.  Pull request courtesy Gord
     Thompson.

.. changelog::

2.0.45

:released: December 9, 2025

 .. change::
     :tags: bug, typing
     :tickets: 12730

     Fixed typing issue where :meth:`.Select.with_for_update` would not support
     lists of ORM entities or other FROM clauses in the
     :paramref:`.Select.with_for_update.of` parameter. Pull request courtesy
     Shamil.

 .. change::
     :tags: bug, orm
     :tickets: 12858

     Fixed issue where calling :meth:`.Mapper.add_property` within mapper event
     hooks such as :meth:`.MapperEvents.instrument_class`,
     :meth:`.MapperEvents.after_mapper_constructed`, or
     :meth:`.MapperEvents.before_mapper_configured` would raise an
     ``AttributeError`` because the mapper&#x27;s internal property collections were
     not yet initialized. The :meth:`.Mapper.add_property` method now handles
     early-stage property additions correctly, allowing properties including
     column properties, deferred columns, and relationships to be added during
     mapper initialization events.  Pull request courtesy G Allajmi.

 .. change::
     :tags: bug, postgresql
     :tickets: 12867

     Fixed issue where PostgreSQL dialect options such as ``postgresql_include``
     on :class:`.PrimaryKeyConstraint` and :class:`.UniqueConstraint` were
     rendered in the wrong position when combined with constraint deferrability
     options like ``deferrable=True``. Pull request courtesy G Allajmi.

 .. change::
     :tags: bug, sql
     :tickets: 12915

     Some improvements to the :meth:`_sql.ClauseElement.params` method to
     replace bound parameters in a query were made, however the ultimate issue
     in :ticket:`12915` involving ORM :func:`_orm.aliased` cannot be fixed fully
     until 2.1, where the method is being rewritten to work without relying on
     Core cloned traversal.

 .. change::
     :tags: bug, sqlite, reflection
     :tickets: 12924

     A series of improvements have been made for reflection of CHECK constraints
     on SQLite. The reflection logic now correctly handles table names
     containing the strings &quot;CHECK&quot; or &quot;CONSTRAINT&quot;, properly supports all four
     SQLite identifier quoting styles (double quotes, single quotes, brackets,
     and backticks) for constraint names, and accurately parses CHECK constraint
     expressions containing parentheses within string literals using balanced
     parenthesis matching with string context tracking.    Big thanks to
     GruzdevAV for new test cases and implementation ideas.

 .. change::
     :tags: bug, orm
     :tickets: 12952

     Fixed issue in Python 3.14 where dataclass transformation would fail when
     a mapped class using :class:`.MappedAsDataclass` included a
     :func:`.relationship` referencing a class that was not available at
     runtime (e.g., within a ``TYPE_CHECKING`` block). This occurred when using
     Python 3.14&#x27;s :pep:`649` deferred annotations feature, which is the
     default behavior without a ``from __future__ import annotations``
     directive.

 .. change::
     :tags: bug, sqlite
     :tickets: 12954

     Fixed issue where SQLite dialect would fail to reflect constraint names
     that contained uppercase letters or other characters requiring quoting. The
     regular expressions used to parse primary key, foreign key, and unique
     constraint names from the ``CREATE TABLE`` statement have been updated to
     properly handle both quoted and unquoted constraint names.

 .. change::
     :tags: bug, typing

     Fixed typing issue where :class:`.coalesce` would not return the correct
     return type when a nullable form of that argument were passed, even though
     this function is meant to select the non-null entry among possibly null
     arguments.  Pull request courtesy Yannick PÉROUX.


 .. change::
     :tags: usecase, mysql
     :tickets: 12964

     Added support for MySQL 8.0.1 + ``FOR SHARE`` to be emitted for the
     :meth:`.Select.with_for_update` method, which offers compatibility with
     ``NOWAIT`` and ``SKIP LOCKED``.  The new syntax is used only for MySQL when
     version 8.0.1 or higher is detected. Pull request courtesy JetDrag.

 .. change::
     :tags: bug, sql
     :tickets: 12987

     Fixed issue where using the :meth:`.ColumnOperators.in_` operator with a
     nested :class:`.CompoundSelect` statement (e.g. an ``INTERSECT`` of
     ``UNION`` queries) would raise a :class:`NotImplementedError` when the
     nested compound select was the first argument to the outer compound select.
     The ``_scalar_type()`` internal method now properly handles nested compound
     selects.

 .. change::
     :tags: bug, postgresql
     :tickets: 13015

     Fixed the structure of the SQL string used for the
     :ref:`engine_insertmanyvalues` feature when an explicit sequence with
     ``nextval()`` is used. The SQL function invocation for the sequence has
     been moved from being rendered inline within each tuple inside of VALUES to
     being rendered once in the SELECT that reads from VALUES. This change
     ensures the function is invoked in the correct order as rows are processed,
     rather than assuming PostgreSQL will execute inline function calls within
     VALUES in a particular order. While current PostgreSQL versions appear to
     handle the previous approach correctly, the database does not guarantee
     this behavior for future versions.

 .. change::
     :tags: usecase, postgresql
     :tickets: 6511

     Added support for reflection of collation in types for PostgreSQL.
     The ``collation`` will be set only if different from the default
     one for the type.
     Pull request courtesy Denis Laxalde.

 .. change::
     :tags: bug, examples

     Fixed the &quot;short_selects&quot; performance example where the cache was being
     used in all the examples, making it impossible to compare performance with
     and without the cache.   Less important comparisons like &quot;lambdas&quot; and
     &quot;baked queries&quot; have been removed.


 .. change::
     :tags: change, tests

     A noxfile.py has been added to allow testing with nox.  This is a direct
     port of 2.1&#x27;s move to nox, however leaves the tox.ini file in place and
     retains all test documentation in terms of tox.   Version 2.1 will move to
     nox fully, including deprecation warnings for tox and new testing
     documentation.

.. changelog::

2.0.44

:released: October 10, 2025

 .. change::
     :tags: bug, sql
     :tickets: 12271

     Improved the implementation of :meth:`.UpdateBase.returning` to use more
     robust logic in setting up the ``.c`` collection of a derived statement
     such as a CTE.  This fixes issues related to RETURNING clauses that feature
     expressions based on returned columns with or without qualifying labels.

 .. change::
     :tags: usecase, asyncio
     :tickets: 12273

     Generalize the terminate logic employed by the asyncpg dialect to reuse
     it in the aiomysql and asyncmy dialect implementation.

 .. change::
     :tags: bug, mssql
     :tickets: 12798

     Improved the base implementation of the asyncio cursor such that it
     includes the option for the underlying driver&#x27;s cursor to be actively
     closed in those cases where it requires ``await`` in order to complete the
     close sequence, rather than relying on garbage collection to &quot;close&quot; it,
     when a plain :class:`.Result` is returned that does not use ``await`` for
     any of its methods.  The previous approach of relying on gc was fine for
     MySQL and SQLite dialects but has caused problems with the aioodbc
     implementation on top of SQL Server.   The new option is enabled
     for those dialects which have an &quot;awaitable&quot; ``cursor.close()``, which
     includes the aioodbc, aiomysql, and asyncmy dialects (aiosqlite is also
     modified for 2.1 only).

 .. change::
     :tags: bug, ext
     :tickets: 12802

     Fixed issue caused by an unwanted functional change while typing
     the :class:`.MutableList` class.
     This change also reverts all other functional changes done in
     the same change.

 .. change::
     :tags: bug, typing
     :tickets: 12813

     Fixed typing bug where the :meth:`.Session.execute` method advertised that
     it would return a :class:`.CursorResult` if given an insert/update/delete
     statement.  This is not the general case as several flavors of ORM
     insert/update do not actually yield a :class:`.CursorResult` which cannot
     be differentiated at the typing overload level, so the method now yields
     :class:`.Result` in all cases.  For those cases where
     :class:`.CursorResult` is known to be returned and the ``.rowcount``
     attribute is required, please use ``typing.cast()``.

 .. change::
     :tags: usecase, orm
     :tickets: 12829

     The way ORM Annotated Declarative interprets Python :pep:`695` type aliases
     in ``Mapped[]`` annotations has been refined to expand the lookup scheme. A
     :pep:`695` type can now be resolved based on either its direct presence in
     :paramref:`_orm.registry.type_annotation_map` or its immediate resolved
     value, as long as a recursive lookup across multiple :pep:`695` types is
     not required for it to resolve. This change reverses part of the
     restrictions introduced in 2.0.37 as part of :ticket:`11955`, which
     deprecated (and disallowed in 2.1) the ability to resolve any :pep:`695`
     type that was not explicitly present in
     :paramref:`_orm.registry.type_annotation_map`. Recursive lookups of
     :pep:`695` types remains deprecated in 2.0 and disallowed in version 2.1,
     as do implicit lookups of ``NewType`` types without an entry in
     :paramref:`_orm.registry.type_annotation_map`.

     Additionally, new support has been added for generic :pep:`695` aliases that
     refer to :pep:`593` ``Annotated`` constructs containing
     :func:`_orm.mapped_column` configurations. See the sections below for
     examples.

     .. seealso::

         :ref:`orm_declarative_type_map_pep695_types`

         :ref:`orm_declarative_mapped_column_generic_pep593`

 .. change::
     :tags: bug, postgresql
     :tickets: 12847

     Fixed issue where selecting an enum array column containing NULL values
     would fail to parse properly in the PostgreSQL dialect. The
     :func:`._split_enum_values` function now correctly handles NULL entries by
     converting them to Python ``None`` values.

 .. change::
     :tags: bug, typing
     :tickets: 12855

     Added new decorator :func:`_orm.mapped_as_dataclass`, which is a function
     based form of :meth:`_orm.registry.mapped_as_dataclass`; the method form
     :meth:`_orm.registry.mapped_as_dataclass` does not seem to be correctly
     recognized within the scope of :pep:`681` in recent mypy versions.

 .. change::
     :tags: bug, sqlite
     :tickets: 12864

     Fixed issue where SQLite table reflection would fail for tables using
     ``WITHOUT ROWID`` and/or ``STRICT`` table options when the table contained
     generated columns. The regular expression used to parse ``CREATE TABLE``
     statements for generated column detection has been updated to properly
     handle these SQLite table options that appear after the column definitions.
     Pull request courtesy Tip ten Brink.

 .. change::
     :tags: bug, postgresql
     :tickets: 12874

     Fixed issue where the :func:`_sql.any_` and :func:`_sql.all_` aggregation
     operators would not correctly coerce the datatype of the compared value, in
     those cases where the compared value were not a simple int/str etc., such
     as a Python ``Enum`` or other custom value.   This would lead to execution
     time errors for these values.  This issue is essentially the same as
     :ticket:`6515` which was for the now-legacy :meth:`.ARRAY.any` and
     :meth:`.ARRAY.all` methods.

 .. change::
     :tags: bug, engine
     :tickets: 12881

     Implemented initial support for free-threaded Python by adding new tests
     and reworking the test harness to include Python 3.13t and Python 3.14t in
     test runs. Two concurrency issues have been identified and fixed: the first
     involves initialization of the ``.c`` collection on a ``FromClause``, a
     continuation of :ticket:`12302`, where an optional mutex under
     free-threading is added; the second involves synchronization of the pool
     &quot;first_connect&quot; event, which first received thread synchronization in
     :ticket:`2964`, however under free-threading the creation of the mutex
     itself runs under the same free-threading mutex. Support for free-threaded
     wheels on Pypi is implemented as well within the 2.1 series only.  Initial
     pull request and test suite courtesy Lysandros Nikolaou.

 .. change::
     :tags: bug, schema
     :tickets: 12884

     Fixed issue where :meth:`_schema.MetaData.reflect` did not forward
     dialect-specific keyword arguments to the :class:`_engine.Inspector`
     methods, causing options like ``oracle_resolve_synonyms`` to be ignored
     during reflection. The method now ensures that all extra kwargs passed to
     :meth:`_schema.MetaData.reflect` are forwarded to
     :meth:`_engine.Inspector.get_table_names` and related reflection methods.
     Pull request courtesy Lukáš Kožušník.

 .. change::
     :tags: bug, mssql
     :tickets: 12894

     Fixed issue where the index reflection for SQL Server would
     not correctly return the order of the column inside an index
     when the order of the columns in the index did not match the
     order of the columns in the table.
     Pull request courtesy of Allen Chen.

 .. change::
     :tags: bug, orm
     :tickets: 12905

     Fixed a caching issue where :func:`_orm.with_loader_criteria` would
     incorrectly reuse cached bound parameter values when used with
     :class:`_sql.CompoundSelect` constructs such as :func:`_sql.union`. The
     issue was caused by the cache key for compound selects not including the
     execution options that are part of the :class:`_sql.Executable` base class,
     which :func:`_orm.with_loader_criteria` uses to apply its criteria
     dynamically. The fix ensures that compound selects and other executable
     constructs properly include execution options in their cache key traversal.

 .. change::
     :tags: bug, mssql, reflection
     :tickets: 12907

     Fixed issue in the MSSQL dialect&#x27;s foreign key reflection query where
     duplicate rows could be returned when a foreign key column and its
     referenced primary key column have the same name, and both the referencing
     and referenced tables have indexes with the same name. This resulted in an
     &quot;ForeignKeyConstraint with duplicate source column references are not
     supported&quot; error when attempting to reflect such tables. The query has been
     corrected to exclude indexes on the child table when looking for unique
     indexes referenced by foreign keys.

 .. change::
     :tags: bug, platform

     Unblocked automatic greenlet installation for Python 3.14 now that
     there are greenlet wheels on pypi for python 3.14.

.. changelog::

2.0.43

:released: August 11, 2025

 .. change::
     :tags: usecase, oracle
     :tickets: 12711

     Extended :class:`_oracle.VECTOR` to support sparse vectors. This update
     introduces :class:`_oracle.VectorStorageType` to specify sparse or dense
     storage and added :class:`_oracle.SparseVector`. Pull request courtesy
     Suraj Shaw.

 .. change::
     :tags: bug, orm
     :tickets: 12748

     Fixed issue where using the ``post_update`` feature would apply incorrect
     &quot;pre-fetched&quot; values to the ORM objects after a multi-row UPDATE process
     completed.  These &quot;pre-fetched&quot; values would come from any column that had
     an :paramref:`.Column.onupdate` callable or a version id generator used by
     :paramref:`.orm.Mapper.version_id_generator`; for a version id generator
     that delivered random identifiers like timestamps or UUIDs, this incorrect
     data would lead to a DELETE statement against those same rows to fail in
     the next step.


 .. change::
     :tags: bug, postgresql
     :tickets: 12778

     Fixed regression in PostgreSQL dialect where JSONB subscription syntax
     would generate incorrect SQL for JSONB-returning functions, causing syntax
     errors. The dialect now properly wraps function calls and expressions in
     parentheses when using the ``[]`` subscription syntax, generating
     ``(function_call)[index]`` instead of ``function_call[index]`` to comply
     with PostgreSQL syntax requirements.

 .. change::
     :tags: usecase, engine
     :tickets: 12784

     Added new parameter :paramref:`.create_engine.skip_autocommit_rollback`
     which provides for a per-dialect feature of preventing the DBAPI
     ``.rollback()`` from being called under any circumstances, if the
     connection is detected as being in &quot;autocommit&quot; mode.   This improves upon
     a critical performance issue identified in MySQL dialects where the network
     overhead of the ``.rollback()`` call remains prohibitive even if autocommit
     mode is set.

     .. seealso::

         :ref:`dbapi_autocommit_skip_rollback`

 .. change::
     :tags: bug, orm
     :tickets: 12787

     Fixed issue where :paramref:`_orm.mapped_column.use_existing_column`
     parameter in :func:`_orm.mapped_column` would not work when the
     :func:`_orm.mapped_column` is used inside of an ``Annotated`` type alias in
     polymorphic inheritance scenarios. The parameter is now properly recognized
     and processed during declarative mapping configuration.

 .. change::
     :tags: bug, orm
     :tickets: 12790

     Improved the implementation of the :func:`_orm.selectin_polymorphic`
     inheritance loader strategy to properly render the IN expressions using
     chunks of 500 records each, in the same manner as that of the
     :func:`_orm.selectinload` relationship loader strategy.  Previously, the IN
     expression would be arbitrarily large, leading to failures on databases
     that have limits on the size of IN expressions including Oracle Database.

.. changelog::

2.0.42

:released: July 29, 2025

 .. change::
     :tags: usecase, orm
     :tickets: 10674

     Added ``dataclass_metadata`` argument to all ORM attribute constructors
     that accept dataclasses parameters, e.g. :paramref:`.mapped_column.dataclass_metadata`,
     :paramref:`.relationship.dataclass_metadata`, etc.
     It&#x27;s passed to the underlying dataclass ``metadata`` attribute
     of the dataclass field. Pull request courtesy Sigmund Lahn.

 .. change::
     :tags: usecase, postgresql
     :tickets: 10927

     Added support for PostgreSQL 14+ :class:`.JSONB` subscripting syntax.
     When connected to PostgreSQL 14 or later, JSONB columns now
     automatically use the native subscript notation ``jsonb_col[&#x27;key&#x27;]``
     instead of the arrow operator ``jsonb_col -&gt; &#x27;key&#x27;`` for both read and
     write operations. This provides better compatibility with PostgreSQL&#x27;s
     native JSONB subscripting feature while maintaining backward
     compatibility with older PostgreSQL versions. JSON columns continue to
     use the traditional arrow syntax regardless of PostgreSQL version.

     .. warning::

       **For applications that have indexes against JSONB subscript
       expressions**

       This change caused an unintended side effect for indexes that were
       created against expressions that use subscript notation, e.g.
       ``Index(&quot;ix_entity_json_ab_text&quot;, data[&quot;a&quot;][&quot;b&quot;].astext)``. If these
       indexes were generated with the older syntax e.g. ``((entity.data -&gt;
       &#x27;a&#x27;) -&gt;&gt; &#x27;b&#x27;)``, they will not be used by the PostgreSQL query
       planner when a query is made using SQLAlchemy 2.0.42 or higher on
       PostgreSQL versions 14 or higher. This occurs because the new text
       will resemble ``(entity.data[&#x27;a&#x27;] -&gt;&gt; &#x27;b&#x27;)`` which will fail to
       produce the exact textual syntax match required by the PostgreSQL
       query planner.  Therefore, for users upgrading to SQLAlchemy 2.0.42
       or higher, existing indexes that were created against :class:`.JSONB`
       expressions that use subscripting would need to be dropped and
       re-created in order for them to work with the new query syntax, e.g.
       an expression like ``((entity.data -&gt; &#x27;a&#x27;) -&gt;&gt; &#x27;b&#x27;)`` would become
       ``(entity.data[&#x27;a&#x27;] -&gt;&gt; &#x27;b&#x27;)``.

       .. seealso::

             :ticket:`12868` - discussion of this issue

 .. change::
     :tags: bug, orm
     :tickets: 12593

     Implemented the :func:`_orm.defer`, :func:`_orm.undefer` and
     :func:`_orm.load_only` loader options to work for composite attributes, a
     use case that had never been supported previously.

 .. change::
     :tags: bug, postgresql, reflection
     :tickets: 12600

     Fixed regression caused by :ticket:`10665` where the newly modified
     constraint reflection query would fail on older versions of PostgreSQL
     such as version 9.6.  Pull request courtesy Denis Laxalde.

 .. change::
     :tags: bug, mysql
     :tickets: 12648

     Fixed yet another regression caused by by the DEFAULT rendering changes in
     2.0.40 :ticket:`12425`, similar to :ticket:`12488`, this time where using a
     CURRENT_TIMESTAMP function with a fractional seconds portion inside a
     textual default value would also fail to be recognized as a
     non-parenthesized server default.



 .. change::
     :tags: bug, mssql
     :tickets: 12654

     Reworked SQL Server column reflection to be based on the ``sys.columns``
     table rather than ``information_schema.columns`` view.  By correctly using
     the SQL Server ``object_id()`` function as a lead and joining to related
     tables on object_id rather than names, this repairs a variety of issues in
     SQL Server reflection, including:

     * Issue where reflected column comments would not correctly line up
       with the columns themselves in the case that the table had been ALTERed
     * Correctly targets tables with awkward names such as names with brackets,
       when reflecting not just the basic table / columns but also extended
       information including IDENTITY, computed columns, comments which
       did not work previously
     * Correctly targets IDENTITY, computed status from temporary tables
       which did not work previously

 .. change::
     :tags: bug, sql
     :tickets: 12681

     Fixed issue where :func:`.select` of a free-standing scalar expression that
     has a unary operator applied, such as negation, would not apply result
     processors to the selected column even though the correct type remains in
     place for the unary expression.


 .. change::
     :tags: bug, sql
     :tickets: 12692

     Hardening of the compiler&#x27;s actions for UPDATE statements that access
     multiple tables to report more specifically when tables or aliases are
     referenced in the SET clause; on cases where the backend does not support
     secondary tables in the SET clause, an explicit error is raised, and on the
     MySQL or similar backends that support such a SET clause, more specific
     checking for not-properly-included tables is performed.  Overall the change
     is preventing these erroneous forms of UPDATE statements from being
     compiled, whereas previously it was relied on the database to raise an
     error, which was not always guaranteed to happen, or to be non-ambiguous,
     due to cases where the parent table included the same column name as the
     secondary table column being updated.


 .. change::
     :tags: bug, orm
     :tickets: 12692

     Fixed bug where the ORM would pull in the wrong column into an UPDATE when
     a key name inside of the :meth:`.ValuesBase.values` method could be located
     from an ORM entity mentioned in the statement, but where that ORM entity
     was not the actual table that the statement was inserting or updating.  An
     extra check for this edge case is added to avoid this problem.

 .. change::
     :tags: bug, postgresql
     :tickets: 12728

     Re-raise caught ``CancelledError`` in the terminate method of the
     asyncpg dialect to avoid possible hangs of the code execution.


 .. change::
     :tags: usecase, sql
     :tickets: 12734

     The :func:`_sql.values` construct gains a new method :meth:`_sql.Values.cte`,
     which allows creation of a named, explicit-columns :class:`.CTE` against an
     unnamed ``VALUES`` expression, producing a syntax that allows column-oriented
     selection from a ``VALUES`` construct on modern versions of PostgreSQL, SQLite,
     and MariaDB.

 .. change::
     :tags: bug, reflection, postgresql
     :tickets: 12744

     Fixes bug that would mistakenly interpret a domain or enum type
     with name starting in ``interval`` as an ``INTERVAL`` type while
     reflecting a table.

 .. change::
     :tags: usecase, postgresql
     :tickets: 8664

     Added ``postgresql_ops`` key to the ``dialect_options`` entry in reflected
     dictionary. This maps names of columns used in the index to respective
     operator class, if distinct from the default one for column&#x27;s data type.
     Pull request courtesy Denis Laxalde.

     .. seealso::

         :ref:`postgresql_operator_classes`

 .. change::
     :tags: engine

     Improved validation of execution parameters passed to the
     :meth:`_engine.Connection.execute` and similar methods to
     provided a better error when tuples are passed in.
     Previously the execution would fail with a difficult to
     understand error message.

.. changelog::

2.0.41

:released: May 14, 2025

 .. change::
     :tags: usecase, postgresql
     :tickets: 10665

     Added support for ``postgresql_include`` keyword argument to
     :class:`_schema.UniqueConstraint` and :class:`_schema.PrimaryKeyConstraint`.
     Pull request courtesy Denis Laxalde.

     .. seealso::

         :ref:`postgresql_constraint_options`

 .. change::
     :tags: usecase, oracle
     :tickets: 12317, 12341

     Added new datatype :class:`_oracle.VECTOR` and accompanying DDL and DQL
     support to fully support this type for Oracle Database. This change
     includes the base :class:`_oracle.VECTOR` type that adds new type-specific
     methods ``l2_distance``, ``cosine_distance``, ``inner_product`` as well as
     new parameters ``oracle_vector`` for the :class:`.Index` construct,
     allowing vector indexes to be configured, and ``oracle_fetch_approximate``
     for the :meth:`.Select.fetch` clause.  Pull request courtesy Suraj Shaw.

     .. seealso::

         :ref:`oracle_vector_datatype`


 .. change::
     :tags: bug, platform
     :tickets: 12405

     Adjusted the test suite as well as the ORM&#x27;s method of scanning classes for
     annotations to work under current beta releases of Python 3.14 (currently
     3.14.0b1) as part of an ongoing effort to support the production release of
     this Python release.  Further changes to Python&#x27;s means of working with
     annotations is expected in subsequent beta releases for which SQLAlchemy&#x27;s
     test suite will need further adjustments.



 .. change::
     :tags: bug, mysql
     :tickets: 12488

     Fixed regression caused by the DEFAULT rendering changes in version 2.0.40
     via :ticket:`12425` where using lowercase ``on update`` in a MySQL server
     default would incorrectly apply parenthesis, leading to errors when MySQL
     interpreted the rendered DDL.  Pull request courtesy Alexander Ruehe.

 .. change::
     :tags: bug, sqlite
     :tickets: 12566

     Fixed and added test support for some SQLite SQL functions hardcoded into
     the compiler, most notably the ``localtimestamp`` function which rendered
     with incorrect internal quoting.

 .. change::
     :tags: bug, engine
     :tickets: 12579

     The error message that is emitted when a URL cannot be parsed no longer
     includes the URL itself within the error message.


 .. change::
     :tags: bug, typing
     :tickets: 12588

     Removed ``__getattr__()`` rule from ``sqlalchemy/__init__.py`` that
     appeared to be trying to correct for a previous typographical error in the
     imports. This rule interferes with type checking and is removed.


 .. change::
     :tags: bug, installation

     Removed the &quot;license classifier&quot; from setup.cfg for SQLAlchemy 2.0, which
     eliminates loud deprecation warnings when building the package.  SQLAlchemy
     2.1 will use a full :pep:`639` configuration in pyproject.toml while
     SQLAlchemy 2.0 remains using ``setup.cfg`` for setup.



.. changelog::

2.0.40

:released: March 27, 2025

 .. change::
     :tags: usecase, postgresql
     :tickets: 11595

     Added support for specifying a list of columns for ``SET NULL`` and ``SET
     DEFAULT`` actions of ``ON DELETE`` clause of foreign key definition on
     PostgreSQL.  Pull request courtesy Denis Laxalde.

     .. seealso::

         :ref:`postgresql_constraint_options`

 .. change::
     :tags: bug, orm
     :tickets: 12329

     Fixed regression which occurred as of 2.0.37 where the checked
     :class:`.ArgumentError` that&#x27;s raised when an inappropriate type or object
     is used inside of a :class:`.Mapped` annotation would raise ``TypeError``
     with &quot;boolean value of this clause is not defined&quot; if the object resolved
     into a SQL expression in a boolean context, for programs where future
     annotations mode was not enabled.  This case is now handled explicitly and
     a new error message has also been tailored for this case.  In addition, as
     there are at least half a dozen distinct error scenarios for interpretation
     of the :class:`.Mapped` construct, these scenarios have all been unified
     under a new subclass of :class:`.ArgumentError` called
     :class:`.MappedAnnotationError`, to provide some continuity between these
     different scenarios, even though specific messaging remains distinct.

 .. change::
     :tags: bug, mysql
     :tickets: 12332

     Support has been re-added for the MySQL-Connector/Python DBAPI using the
     ``mysql+mysqlconnector://`` URL scheme.   The DBAPI now works against
     modern MySQL versions as well as MariaDB versions (in the latter case it&#x27;s
     required to pass charset/collation explicitly).   Note however that
     server side cursor support is disabled due to unresolved issues with this
     driver.

 .. change::
     :tags: bug, sql
     :tickets: 12363

     Fixed issue in :class:`.CTE` constructs involving multiple DDL
     :class:`_sql.Insert` statements with multiple VALUES parameter sets where the
     bound parameter names generated for these parameter sets would conflict,
     generating a compile time error.


 .. change::
     :tags: bug, sqlite
     :tickets: 12425

     Expanded the rules for when to apply parenthesis to a server default in DDL
     to suit the general case of a default string that contains non-word
     characters such as spaces or operators and is not a string literal.

 .. change::
     :tags: bug, mysql
     :tickets: 12425

     Fixed issue in MySQL server default reflection where a default that has
     spaces would not be correctly reflected.  Additionally, expanded the rules
     for when to apply parenthesis to a server default in DDL to suit the
     general case of a default string that contains non-word characters such as
     spaces or operators and is not a string literal.


 .. change::
     :tags: usecase, postgresql
     :tickets: 12432

     When building a PostgreSQL ``ARRAY`` literal using
     :class:`_postgresql.array` with an empty ``clauses`` argument, the
     :paramref:`_postgresql.array.type_` parameter is now significant in that it
     will be used to render the resulting ``ARRAY[]`` SQL expression with a
     cast, such as ``ARRAY[]::INTEGER``. Pull request courtesy Denis Laxalde.

 .. change::
     :tags: sql, usecase
     :tickets: 12450

     Implemented support for the GROUPS frame specification in window functions
     by adding :paramref:`_sql.over.groups` option to :func:`_sql.over`
     and :meth:`.FunctionElement.over`. Pull request courtesy Kaan Dikmen.

 .. change::
     :tags: bug, sql
     :tickets: 12451

     Fixed regression caused by :ticket:`7471` leading to a SQL compilation
     issue where name disambiguation for two same-named FROM clauses with table
     aliasing in use at the same time would produce invalid SQL in the FROM
     clause with two &quot;AS&quot; clauses for the aliased table, due to double aliasing.

 .. change::
     :tags: bug, asyncio
     :tickets: 12471

     Fixed issue where :meth:`.AsyncSession.get_transaction` and
     :meth:`.AsyncSession.get_nested_transaction` would fail with
     ``NotImplementedError`` if the &quot;proxy transaction&quot; used by
     :class:`.AsyncSession` were garbage collected and needed regeneration.

 .. change::
     :tags: bug, orm
     :tickets: 12473

     Fixed regression in ORM Annotated Declarative class interpretation caused
     by ``typing_extension==4.13.0`` that introduced a different implementation
     for ``TypeAliasType`` while SQLAlchemy assumed that it would be equivalent
     to the ``typing`` version, leading to pep-695 type annotations not
     resolving to SQL types as expected.

.. changelog::

2.0.39

:released: March 11, 2025

 .. change::
     :tags: bug, postgresql
     :tickets: 11751

     Add SQL typing to reflection query used to retrieve a the structure
     of IDENTITY columns, adding explicit JSON typing to the query to suit
     unusual PostgreSQL driver configurations that don&#x27;t support JSON natively.

 .. change::
     :tags: bug, postgresql

     Fixed issue affecting PostgreSQL 17.3 and greater where reflection of
     domains with &quot;NOT NULL&quot; as part of their definition would include an
     invalid constraint entry in the data returned by
     :meth:`_postgresql.PGInspector.get_domains` corresponding to an additional
     &quot;NOT NULL&quot; constraint that isn&#x27;t a CHECK constraint; the existing
     ``&quot;nullable&quot;`` entry in the dictionary already indicates if the domain
     includes a &quot;not null&quot; constraint.   Note that such domains also cannot be
     reflected on PostgreSQL 17.0 through 17.2 due to a bug on the PostgreSQL
     side; if encountering errors in reflection of domains which include NOT
     NULL, upgrade to PostgreSQL server 17.3 or greater.

 .. change::
     :tags: typing, usecase
     :tickets: 11922

     Support generic types for compound selects (:func:`_sql.union`,
     :func:`_sql.union_all`, :meth:`_sql.Select.union`,
     :meth:`_sql.Select.union_all`, etc) returning the type of the first select.
     Pull request courtesy of Mingyu Park.

 .. change::
     :tags: bug, postgresql
     :tickets: 12060

     Fixed issue in PostgreSQL network types :class:`_postgresql.INET`,
     :class:`_postgresql.CIDR`, :class:`_postgresql.MACADDR`,
     :class:`_postgresql.MACADDR8` where sending string values to compare to
     these types would render an explicit CAST to VARCHAR, causing some SQL /
     driver combinations to fail.  Pull request courtesy Denis Laxalde.

 .. change::
     :tags: bug, orm
     :tickets: 12326

     Fixed bug where using DML returning such as :meth:`.Insert.returning` with
     an ORM model that has :func:`_orm.column_property` constructs that contain
     subqueries would fail with an internal error.

 .. change::
     :tags: bug, orm
     :tickets: 12328

     Fixed bug in ORM enabled UPDATE (and theoretically DELETE) where using a
     multi-table DML statement would not allow ORM mapped columns from mappers
     other than the primary UPDATE mapper to be named in the RETURNING clause;
     they would be omitted instead and cause a column not found exception.

 .. change::
     :tags: bug, asyncio
     :tickets: 12338

     Fixed bug where :meth:`_asyncio.AsyncResult.scalar`,
     :meth:`_asyncio.AsyncResult.scalar_one_or_none`, and
     :meth:`_asyncio.AsyncResult.scalar_one` would raise an ``AttributeError``
     due to a missing internal attribute.  Pull request courtesy Allen Ho.

 .. change::
     :tags: bug, orm
     :tickets: 12357

     Fixed issue where the &quot;is ORM&quot; flag of a :func:`.select` or other ORM
     statement would not be propagated to the ORM :class:`.Session` based on a
     multi-part operator expression alone, e.g. such as ``Cls.attr + Cls.attr +
     Cls.attr`` or similar, leading to ORM behaviors not taking place for such
     statements.

 .. change::
     :tags: bug, orm
     :tickets: 12364

     Fixed issue where using :func:`_orm.aliased` around a :class:`.CTE`
     construct could cause inappropriate &quot;duplicate CTE&quot; errors in cases where
     that aliased construct appeared multiple times in a single statement.

 .. change::
     :tags: bug, sqlite
     :tickets: 12368

     Fixed issue that omitted the comma between multiple SQLite table extension
     clauses, currently ``WITH ROWID`` and ``STRICT``, when both options
     :paramref:`.Table.sqlite_with_rowid` and  :paramref:`.Table.sqlite_strict`
     were configured at their non-default settings at the same time.  Pull
     request courtesy david-fed.

 .. change::
     :tags: bug, sql
     :tickets: 12382

     Added new parameters :paramref:`.AddConstraint.isolate_from_table` and
     :paramref:`.DropConstraint.isolate_from_table`, defaulting to True, which
     both document and allow to be controllable the long-standing behavior of
     these two constructs blocking the given constraint from being included
     inline within the &quot;CREATE TABLE&quot; sequence, under the assumption that
     separate add/drop directives were to be used.

 .. change::
     :tags: bug, postgresql
     :tickets: 12417

     Fixed compiler issue in the PostgreSQL dialect where incorrect keywords
     would be passed when using &quot;FOR UPDATE OF&quot; inside of a subquery.

.. changelog::

2.0.38

:released: February 6, 2025

 .. change::
     :tags: postgresql, usecase, asyncio
     :tickets: 12077

     Added an additional ``asyncio.shield()`` call within the connection
     terminate process of the asyncpg driver, to mitigate an issue where
     terminate would be prevented from completing under the anyio concurrency
     library.

 .. change::
     :tags: bug, dml, mariadb, mysql
     :tickets: 12117

     Fixed a bug where the MySQL statement compiler would not properly compile
     statements where :meth:`_mysql.Insert.on_duplicate_key_update` was passed
     values that included ORM-mapped attributes (e.g.
     :class:`InstrumentedAttribute` objects) as keys. Pull request courtesy of
     mingyu.

 .. change::
     :tags: bug, postgresql
     :tickets: 12159

     Adjusted the asyncpg connection wrapper so that the
     ``connection.transaction()`` call sent to asyncpg sends ``None`` for
     ``isolation_level`` if not otherwise set in the SQLAlchemy dialect/wrapper,
     thereby allowing asyncpg to make use of the server level setting for
     ``isolation_level`` in the absence of a client-level setting. Previously,
     this behavior of asyncpg was blocked by a hardcoded ``read_committed``.

 .. change::
     :tags: bug, sqlite, aiosqlite, asyncio, pool
     :tickets: 12285

     Changed default connection pool used by the ``aiosqlite`` dialect
     from :class:`.NullPool` to :class:`.AsyncAdaptedQueuePool`; this change
     should have been made when 2.0 was first released as the ``pysqlite``
     dialect was similarly changed to use :class:`.QueuePool` as detailed
     in :ref:`change_7490`.


 .. change::
     :tags: bug, engine
     :tickets: 12289

     Fixed event-related issue where invoking :meth:`.Engine.execution_options`
     on a :class:`.Engine` multiple times while making use of event-registering
     parameters such as ``isolation_level`` would lead to internal errors
     involving event registration.

 .. change::
     :tags: bug, sql
     :tickets: 12302

     Reorganized the internals by which the ``.c`` collection on a
     :class:`.FromClause` gets generated so that it is resilient against the
     collection being accessed in concurrent fashion.   An example is creating a
     :class:`.Alias` or :class:`.Subquery` and accessing it as a module level
     variable.  This impacts the Oracle dialect which uses such module-level
     global alias objects but is of general use as well.

 .. change::
     :tags: bug, sql
     :tickets: 12314

     Fixed SQL composition bug which impacted caching where using a ``None``
     value inside of an ``in_()`` expression would bypass the usual &quot;expanded
     bind parameter&quot; logic used by the IN construct, which allows proper caching
     to take place.


.. changelog::

2.0.37

:released: January 9, 2025

 .. change::
     :tags: usecase, mariadb
     :tickets: 10720

     Added sql types ``INET4`` and ``INET6`` in the MariaDB dialect.  Pull
     request courtesy Adam Žurek.

 .. change::
     :tags: bug, orm
     :tickets: 11370

     Fixed issue regarding ``Union`` types that would be present in the
     :paramref:`_orm.registry.type_annotation_map` of a :class:`_orm.registry`
     or declarative base class, where a :class:`.Mapped` element that included
     one of the subtypes present in that ``Union`` would be matched to that
     entry, potentially ignoring other entries that matched exactly.   The
     correct behavior now takes place such that an entry should only match in
     :paramref:`_orm.registry.type_annotation_map` exactly, as a ``Union`` type
     is a self-contained type. For example, an attribute with ``Mapped[float]``
     would previously match to a :paramref:`_orm.registry.type_annotation_map`
     entry ``Union[float, Decimal]``; this will no longer match and will now
     only match to an entry that states ``float``. Pull request courtesy Frazer
     McLean.

 .. change::
     :tags: bug, postgresql
     :tickets: 11724

     Fixes issue in :meth:`.Dialect.get_multi_indexes` in the PostgreSQL
     dialect, where an error would be thrown when attempting to use alembic with
     a vector index from the pgvecto.rs extension.

 .. change::
     :tags:  usecase, mysql, mariadb
     :tickets: 11764

     Added support for the ``LIMIT`` clause with ``DELETE`` for the MySQL and
     MariaDB dialects, to complement the already present option for
     ``UPDATE``. The :meth:`.Delete.with_dialect_options` method of the
     :func:`.delete` construct accepts parameters for ``mysql_limit`` and
     ``mariadb_limit``, allowing users to specify a limit on the number of rows
     deleted. Pull request courtesy of Pablo Nicolás Estevez.


 .. change::
     :tags:  bug, mysql, mariadb

     Added logic to ensure that the ``mysql_limit`` and ``mariadb_limit``
     parameters of :meth:`.Update.with_dialect_options` and
     :meth:`.Delete.with_dialect_options` when compiled to string will only
     compile if the parameter is passed as an integer; a ``ValueError`` is
     raised otherwise.

 .. change::
     :tags: bug, orm
     :tickets: 11944

     Fixed bug in how type unions were handled within
     :paramref:`_orm.registry.type_annotation_map` as well as
     :class:`._orm.Mapped` that made the lookup behavior of ``a | b`` different
     from that of ``Union[a, b]``.

 .. change::
     :tags: bug, orm


---

<sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

## 📋 Pull Request Information **Original PR:** https://github.com/jeffknupp/sandman2/pull/456 **Author:** [@pyup-bot](https://github.com/pyup-bot) **Created:** 2/23/2026 **Status:** 🔄 Open **Base:** `master` ← **Head:** `pyup-scheduled-update-2026-02-23` --- ### 📝 Commits (10+) - [`40ee0d7`](https://github.com/jeffknupp/sandman2/commit/40ee0d7b35e14f93e1901c780b4959268f53cf06) Update flask from 1.1.2 to 3.1.3 - [`dcb1605`](https://github.com/jeffknupp/sandman2/commit/dcb1605e45def67de3d7c4ad7852b837bf319ccb) Update flask-admin from 1.5.7 to 2.0.2 - [`1b38d3c`](https://github.com/jeffknupp/sandman2/commit/1b38d3cc736628f54e25ff0dce0df5141868f7c9) Update flask-sqlalchemy from 2.4.4 to 3.1.1 - [`ebacc4e`](https://github.com/jeffknupp/sandman2/commit/ebacc4e24853f53ee6063d72892da18939c085ce) Update sqlalchemy from 1.3.20 to 2.0.46 - [`af39fa2`](https://github.com/jeffknupp/sandman2/commit/af39fa25840a9eb6ab87331c365527db3911413e) Update wtforms from 2.3.3 to 3.2.1 - [`82e1660`](https://github.com/jeffknupp/sandman2/commit/82e16607941faf34dc9a14bf0d99431d2f787026) Update coverage from 5.3 to 7.13.4 - [`04c617d`](https://github.com/jeffknupp/sandman2/commit/04c617d4176b5924c08ee02a1f6c7cca08ca00d3) Update pytest from 6.2.0 to 9.0.2 - [`77a88f4`](https://github.com/jeffknupp/sandman2/commit/77a88f4adb4816e53bf28072cd0b9a0f7e6685c2) Update flask-cors from 3.0.9 to 6.0.2 - [`4af4b27`](https://github.com/jeffknupp/sandman2/commit/4af4b275753da900eeef027b3b70f0cd29d5552a) Update pytest-cov from 2.10.1 to 7.0.0 - [`5a3ab42`](https://github.com/jeffknupp/sandman2/commit/5a3ab42ab00ab7e804a0b2aaa072cd3d2bdd3d3f) Update pytest-flask from 1.1.0 to 1.3.0 ### 📊 Changes **1 file changed** (+15 additions, -15 deletions) <details> <summary>View changed files</summary> 📝 `requirements.txt` (+15 -15) </details> ### 📄 Description ### Update [Flask](https://pypi.org/project/Flask) from **1.1.2** to **3.1.3**. *The bot wasn't able to find a changelog for this release. [Got an idea?](https://github.com/pyupio/changelogs/issues/new)* <details> <summary>Links</summary> - PyPI: https://pypi.org/project/flask </details> ### Update [Flask-Admin](https://pypi.org/project/Flask-Admin) from **1.5.7** to **2.0.2**. <details> <summary>Changelog</summary> ### 2.0.2 ``` * Adds support for Python 3.14: https://github.com/pallets-eco/flask-admin/pull/2685 * Adds a MenuDivider item for bootstrap themes: https://github.com/pallets-eco/flask-admin/pull/2696 * Field errors are now shown in red text for bootstrap themes: https://github.com/pallets-eco/flask-admin/pull/2699 ``` ### 2.0.1 ``` * Fix documentation * Update arabic translations ``` ### 2.0.0rc2 ``` * Serbian translation updates ``` ### 2.0.0rc1 ``` Fixes: * SQLAlchemy boolean filters now convert "1" and "0" to Python booleans, which fixes a type coercion issue with psycopg(3). ``` ### 2.0.0a5 ``` New functionality: * Mongonengine support has been added back (no longer using `flask-mongoengine`): https://github.com/pallets-eco/flask-admin/pull/2611 * The default query for pymongo can be overridden: https://github.com/pallets-eco/flask-admin/pull/2661 * Flask async routes are supported: https://github.com/pallets-eco/flask-admin/pull/2659 Fixes: * Bootstrap menu icons should show up properly and not duplicated: https://github.com/pallets-eco/flask-admin/pull/2666 * Redis CLI commands are now case insensitive: https://github.com/pallets-eco/flask-admin/issues/2411 Misc: * Translations and docs have been updated * Various type hinting improvements and fixes ``` ### 2.0.0a4 ``` Breaking changes: * Azure Blob Storage SDK has been upgraded from the legacy version (v2) to the latest version (v12). AzureFileAdmin now accept `blob_service_client` rather than `connection_string` to give more flexibility with connection types. ``` ### 2.0.0a3 ``` Fixes: * Jinja templates can now be loaded in StrictUndefined mode. * Remove an implicit dependency on packaging ``` ### 2.0.0a2 ``` ------- Breaking changes: * Removed support for Python 3.8. * Use of the `boto` library has been replaced by `boto3`. S3FileAdmin and S3Storage now accept an `s3_client` parameter taking a `boto3.client('s3')` instance rather than `aws_access_key_id`, `aws_secret_access_key`, and `region` parameters. ``` ### 2.0.0a1 ``` ------- Fixes: * Fixes compatibility with WTForms 3.2+. * The `Apply` button for filters will show/hide correctly again * Fix `translations_path` attribute when Flask-Admin is used with Flask-Babel * Some translation updates. * Date fields no longer override `widget` if set in `form_args` * “Save and Continue Editing” button no longer discards the “return URL” (allowing to retain filters when switching back to the list) ``` ### 2.0.0a0 ``` Changes from v1.x Breaking changes: - Added support for Python 3.12 - Dropped support for Python 3.7 - Flask-BabelEx is no longer supported; the package is no longer maintained and Flask-Babel is recommended/active instead. - Flask-Mongoengine is no longer supported due to that package being unmaintained. - Bootstrap2 and Bootstrap3 themes are no longer available. - `Admin()` now takes a `theme` parameter that encapsulates all of the configuration options for theming the admin instance. This replaces the `template_mode` parameter. - All remaining Flask-Admin config has been namespaced under `FLASK_ADMIN_`. | Config variable name | What’s changed | |----|-----------------------------------------------| | FLASK_ADMIN_SWATCH | Removed; use `Theme(swatch=...)` instead | | FLASK_ADMIN_FLUID_LAYOUT | Removed; use `Theme(fluid=...)` instead | | MAPBOX_MAP_ID | Renamed to FLASK_ADMIN_MAPBOX_MAP_ID | | MAPBOX_SEARCH | Renamed to FLASK_ADMIN_MAPBOX_SEARCH | | MAPBOX_ACCESS_TOKEN | Renamed to FLASK_ADMIN_MAPBOX_ACCESS_TOKEN | | GOOGLE_MAPS_API_KEY | Renamed to FLASK_ADMIN_GOOGLE_MAPS_API_KEY | | DEFAULT_CENTER_LAT | Renamed to FLASK_ADMIN_DEFAULT_CENTER_LAT | | DEFAULT_CENTER_LONG | Renamed to FLASK_ADMIN_DEFAULT_CENTER_LONG | | ADMIN_RAISE_ON_INTEGRITY_ERROR | Renamed to FLASK_ADMIN_RAISE_ON_INTEGRITY_ERROR | | ADMIN_RAISE_ON_VIEW_EXCEPTION | Renamed to FLASK_ADMIN_RAISE_ON_VIEW_EXCEPTION | Title New features: - Flask-Admin now supports the `host_matching` mode of Flask apps. See documentation for how to configure this where needed. - Flask-Admin is now compatible with SQLAlchemy v2+, Flask v3+, WTForms v3+, and Pillow v10+. - Flask-Admin now declares its dependencies and supported dependency versions more cleanly, including using pip extras. If you use Flask-Admin with SQLAlchemy, for example, you should use `pip install flask-admin[sqlalchemy]` or list `flask-admin[sqlalchemy]` in your requirements.txt or pyproject.toml files. - Apps using content security policies to restrict the assets that can be loaded can now whitelist Flask-Admin’s assets by passing a `csp_nonce_generator` function to the Admin instance. See examples or documentation for how to configure this where needed. - `page_size_options` can now be configured on Admin models, to restrict the page sizes that users can select. These are now enforced properly and cannot be bypassed by URL hacking. And various smaller bug fixes and documentation updates. ``` ### 1.6.1 ``` * SQLAlchemy 2.x support * General updates and bug fixes * Dropped WTForms 1 support ``` ### 1.6.0 ``` * Dropped Python 2 support * WTForms 3.0 support * Various fixes ``` ### 1.5.8 ``` * SQLAlchemy 1.4.5+ compatibility fixes * Redis CLI fixes ``` </details> <details> <summary>Links</summary> - PyPI: https://pypi.org/project/flask-admin - Changelog: https://data.safetycli.com/changelogs/flask-admin/ </details> ### Update [Flask-SQLAlchemy](https://pypi.org/project/Flask-SQLAlchemy) from **2.4.4** to **3.1.1**. <details> <summary>Changelog</summary> ### 3.1.1 ``` ------------- Released 2023-09-11 - Deprecate the ``__version__`` attribute. Use feature detection, or ``importlib.metadata.version("flask-sqlalchemy")``, instead. :issue:`5230` ``` ### 3.1.0 ``` ------------- Released 2023-09-11 - Drop support for Python 3.7. :pr:`1251` - Add support for the SQLAlchemy 2.x API via ``model_class`` parameter. :issue:`1140` - Bump minimum version of SQLAlchemy to 2.0.16. - Remove previously deprecated code. - Pass extra keyword arguments from ``get_or_404`` to ``session.get``. :issue:`1149` - Fix bug with finding right bind key for clause statements. :issue:`1211` ``` ### 3.0.5 ``` ------------- Released 2023-06-21 - ``Pagination.next()`` enforces ``max_per_page``. :issue:`1201` - Improve type hint for ``get_or_404`` return value to be non-optional. :pr:`1226` ``` ### 3.0.4 ``` ------------- Released 2023-06-19 - Fix type hint for ``get_or_404`` return value. :pr:`1208` - Fix type hints for pyright (used by VS Code Pylance extension). :issue:`1205` ``` ### 3.0.3 ``` ------------- Released 2023-01-31 - Show helpful errors when mistakenly using multiple ``SQLAlchemy`` instances for the same app, or without calling ``init_app``. :pr:`1151` - Fix issue with getting the engine associated with a model that uses polymorphic table inheritance. :issue:`1155` ``` ### 3.0.2 ``` ------------- Released 2022-10-14 - Update compatibility with SQLAlchemy 2. :issue:`1122` ``` ### 3.0.1 ``` ------------- Released 2022-10-11 - Export typing information instead of using external typeshed definitions. :issue:`1112` - If default engine options are set, but ``SQLALCHEMY_DATABASE_URI`` is not set, an invalid default bind will not be configured. :issue:`1117` ``` ### 3.0.0 ``` ------------- Released 2022-10-04 - Drop support for Python 2, 3.4, 3.5, and 3.6. - Bump minimum version of Flask to 2.2. - Bump minimum version of SQLAlchemy to 1.4.18. - Remove previously deprecated code. - The session is scoped to the current app context instead of the thread. This requires that an app context is active. This ensures that the session is cleaned up after every request. - An active Flask application context is always required to access ``session`` and ``engine``, regardless of if an application was passed to the constructor. :issue:`508, 944` - Different bind keys use different SQLAlchemy ``MetaData`` registries, allowing tables in different databases to have the same name. Bind keys are stored and looked up on the resulting metadata rather than the model or table. - ``SQLALCHEMY_DATABASE_URI`` does not default to ``sqlite:///:memory:``. An error is raised if neither it nor ``SQLALCHEMY_BINDS`` define any engines. :pr:`731` - Configuring SQLite with a relative path is relative to ``app.instance_path`` instead of ``app.root_path``. The instance folder is created if necessary. :issue:`462` - Added ``get_or_404``, ``first_or_404``, ``one_or_404``, and ``paginate`` methods to the extension object. These use SQLAlchemy's preferred ``session.execute(select())`` pattern instead of the legacy query interface. :issue:`1088` - Setup methods that create the engines and session are renamed with a leading underscore. They are considered internal interfaces which may change at any time. - All parameters to ``SQLAlchemy`` except ``app`` are keyword-only. - Renamed the ``bind`` parameter to ``bind_key`` and removed the ``app`` parameter from various ``SQLAlchemy`` methods. - The extension object uses ``__getattr__`` to alias names from the SQLAlchemy package, rather than copying them as attributes. - The extension object is stored directly as ``app.extensions["sqlalchemy"]``. :issue:`698` - The session class can be customized by passing the ``class_`` key in the ``session_options`` parameter. :issue:`327` - ``SignallingSession`` is renamed to ``Session``. - ``Session.get_bind`` more closely matches the base implementation. - Model classes and the ``db`` instance are available without imports in ``flask shell``. :issue:`1089` - The ``CamelCase`` to ``snake_case`` table name converter handles more patterns correctly. If model that was already created in the database changed, either use Alembic to rename the table, or set ``__tablename__`` to keep the old name. :issue:`406` - ``Model`` ``repr`` distinguishes between transient and pending instances. :issue:`967` - A custom model class can implement ``__init_subclass__`` with class parameters. :issue:`1002` - ``db.Table`` is a subclass instead of a function. - The ``engine_options`` parameter is applied as defaults before per-engine configuration. - ``SQLALCHEMY_BINDS`` values can either be an engine URL, or a dict of engine options including URL, for each bind. ``SQLALCHEMY_DATABASE_URI`` and ``SQLALCHEMY_ENGINE_OPTIONS`` correspond to the ``None`` key and take precedence. :issue:`783` - Engines are created when calling ``init_app`` rather than the first time they are accessed. :issue:`698` - ``db.engines`` exposes the map of bind keys to engines for the current app. - ``get_engine``, ``get_tables_for_bind``, and ``get_binds`` are deprecated. - SQLite driver-level URIs that look like ``sqlite:///file:name.db?uri=true`` are supported. :issue:`998, 1045` - SQLite engines do not use ``NullPool`` if ``pool_size`` is 0. - MySQL engines use the "utf8mb4" charset by default. :issue:`875` - MySQL engines do not set ``pool_size`` to 10. - MySQL engines don't set a default for ``pool_recycle`` if not using a queue pool. :issue:`803` - ``Query`` is renamed from ``BaseQuery``. - Added ``Query.one_or_404``. - The query class is applied to ``backref`` in ``relationship``. :issue:`417` - Creating ``Pagination`` objects manually is no longer a public API. They should be created with ``db.paginate`` or ``query.paginate``. :issue:`1088` - ``Pagination.iter_pages`` and ``Query.paginate`` parameters are keyword-only. - ``Pagination`` is iterable, iterating over its items. :issue:`70` - Pagination count query is more efficient. - ``Pagination.iter_pages`` is more efficient. :issue:`622` - ``Pagination.iter_pages`` ``right_current`` parameter is inclusive. - Pagination ``per_page`` cannot be 0. :issue:`1091` - Pagination ``max_per_page`` defaults to 100. :issue:`1091` - Added ``Pagination.first`` and ``last`` properties, which give the number of the first and last item on the page. :issue:`567` - ``SQLALCHEMY_RECORD_QUERIES`` is disabled by default, and is not enabled automatically with ``app.debug`` or ``app.testing``. :issue:`1092` - ``get_debug_queries`` is renamed to ``get_recorded_queries`` to better match the config and functionality. - Recorded query info is a dataclass instead of a tuple. The ``context`` attribute is renamed to ``location``. Finding the location uses a more inclusive check. - ``SQLALCHEMY_TRACK_MODIFICATIONS`` is disabled by default. :pr:`727` - ``SQLALCHEMY_COMMIT_ON_TEARDOWN`` is deprecated. It can cause various design issues that are difficult to debug. Call ``db.session.commit()`` directly instead. :issue:`216` ``` ### 2.5.1 ``` ------------- Released 2021-03-18 - Fix compatibility with Python 2.7. ``` ### 2.5.0 ``` ------------- Released 2021-03-18 - Update to support SQLAlchemy 1.4. - SQLAlchemy ``URL`` objects are immutable. Some internal methods have changed to return a new URL instead of ``None``. :issue:`885` ``` </details> <details> <summary>Links</summary> - PyPI: https://pypi.org/project/flask-sqlalchemy - Changelog: https://data.safetycli.com/changelogs/flask-sqlalchemy/ - Docs: https://pythonhosted.org/Flask-SQLAlchemy/ </details> ### Update [SQLAlchemy](https://pypi.org/project/SQLAlchemy) from **1.3.20** to **2.0.46**. <details> <summary>Changelog</summary> ### 2.0.46 ``` :released: January 21, 2026 .. change:: :tags: bug, sqlite :tickets: 13039 Fixed issue in the aiosqlite driver where SQLAlchemy's setting of aiosqlite's worker thread to "daemon" stopped working because the aiosqlite architecture moved the location of the worker thread in version 0.22.0. This "daemon" flag is necessary so that a program is able to exit if the SQLite connection itself was not explicitly closed, which is particularly likely with SQLAlchemy as it maintains SQLite connections in a connection pool. While it's perfectly fine to call :meth:`.AsyncEngine.dispose` before program exit, this is not historically or technically necessary for any driver of any known backend, since a primary feature of relational databases is durability. The change also implements support for "terminate" with aiosqlite when using version version 0.22.1 or greater, which implements a sync ``.stop()`` method. .. change:: :tags: usecase, mssql :tickets: 13045 Added support for the ``IF EXISTS`` clause when dropping indexes on SQL Server 2016 (13.x) and later versions. The :paramref:`.DropIndex.if_exists` parameter is now honored by the SQL Server dialect, allowing conditional index drops that will not raise an error if the index does not exist. Pull request courtesy Edgar Ramírez Mondragón. .. change:: :tags: bug, postgresql :tickets: 13059 Fixed issue where PostgreSQL JSONB operators :meth:`_postgresql.JSONB.Comparator.path_match` and :meth:`_postgresql.JSONB.Comparator.path_exists` were applying incorrect ``VARCHAR`` casts to the right-hand side operand when used with newer PostgreSQL drivers such as psycopg. The operators now indicate the right-hand type as ``JSONPATH``, which currently results in no casting taking place, but is also compatible with explicit casts if the implementation were require it at a later point. .. change:: :tags: bug, postgresql :tickets: 13067 Fixed regression in PostgreSQL dialect where JSONB subscription syntax would generate incorrect SQL for :func:`.cast` expressions returning JSONB, causing syntax errors. The dialect now properly wraps cast expressions in parentheses when using the ``[]`` subscription syntax, generating ``(CAST(...))[index]`` instead of ``CAST(...)[index]`` to comply with PostgreSQL syntax requirements. This extends the fix from :ticket:`12778` which addressed the same issue for function calls. .. change:: :tags: bug, mariadb :tickets: 13070 Fixed the SQL compilation for the mariadb sequence "NOCYCLE" keyword that is to be emitted when the :paramref:`.Sequence.cycle` parameter is set to False on a :class:`.Sequence`. Pull request courtesy Diego Dupin. .. change:: :tags: bug, typing :tickets: 13075 Fixed typing issues where ORM mapped classes and aliased entities could not be used as keys in result row mappings or as join targets in select statements. Patterns such as ``row._mapping[User]``, ``row._mapping[aliased(User)]``, ``row._mapping[with_polymorphic(...)]`` (rejected by both mypy and Pylance), and ``.join(aliased(User))`` (rejected by Pylance) are documented and fully supported at runtime but were previously rejected by type checkers. The type definitions for :class:`._KeyType` and :class:`._FromClauseArgument` have been updated to accept these ORM entity types. .. change:: :tags: bug, postgresql Improved the foreign key reflection regular expression pattern used by the PostgreSQL dialect to be more permissive in matching identifier characters, allowing it to correctly handle unicode characters in table and column names. This change improves compatibility with PostgreSQL variants such as CockroachDB that may use different quoting patterns in combination with unicode characters in their identifiers. Pull request courtesy Gord Thompson. .. changelog:: ``` ### 2.0.45 ``` :released: December 9, 2025 .. change:: :tags: bug, typing :tickets: 12730 Fixed typing issue where :meth:`.Select.with_for_update` would not support lists of ORM entities or other FROM clauses in the :paramref:`.Select.with_for_update.of` parameter. Pull request courtesy Shamil. .. change:: :tags: bug, orm :tickets: 12858 Fixed issue where calling :meth:`.Mapper.add_property` within mapper event hooks such as :meth:`.MapperEvents.instrument_class`, :meth:`.MapperEvents.after_mapper_constructed`, or :meth:`.MapperEvents.before_mapper_configured` would raise an ``AttributeError`` because the mapper's internal property collections were not yet initialized. The :meth:`.Mapper.add_property` method now handles early-stage property additions correctly, allowing properties including column properties, deferred columns, and relationships to be added during mapper initialization events. Pull request courtesy G Allajmi. .. change:: :tags: bug, postgresql :tickets: 12867 Fixed issue where PostgreSQL dialect options such as ``postgresql_include`` on :class:`.PrimaryKeyConstraint` and :class:`.UniqueConstraint` were rendered in the wrong position when combined with constraint deferrability options like ``deferrable=True``. Pull request courtesy G Allajmi. .. change:: :tags: bug, sql :tickets: 12915 Some improvements to the :meth:`_sql.ClauseElement.params` method to replace bound parameters in a query were made, however the ultimate issue in :ticket:`12915` involving ORM :func:`_orm.aliased` cannot be fixed fully until 2.1, where the method is being rewritten to work without relying on Core cloned traversal. .. change:: :tags: bug, sqlite, reflection :tickets: 12924 A series of improvements have been made for reflection of CHECK constraints on SQLite. The reflection logic now correctly handles table names containing the strings "CHECK" or "CONSTRAINT", properly supports all four SQLite identifier quoting styles (double quotes, single quotes, brackets, and backticks) for constraint names, and accurately parses CHECK constraint expressions containing parentheses within string literals using balanced parenthesis matching with string context tracking. Big thanks to GruzdevAV for new test cases and implementation ideas. .. change:: :tags: bug, orm :tickets: 12952 Fixed issue in Python 3.14 where dataclass transformation would fail when a mapped class using :class:`.MappedAsDataclass` included a :func:`.relationship` referencing a class that was not available at runtime (e.g., within a ``TYPE_CHECKING`` block). This occurred when using Python 3.14's :pep:`649` deferred annotations feature, which is the default behavior without a ``from __future__ import annotations`` directive. .. change:: :tags: bug, sqlite :tickets: 12954 Fixed issue where SQLite dialect would fail to reflect constraint names that contained uppercase letters or other characters requiring quoting. The regular expressions used to parse primary key, foreign key, and unique constraint names from the ``CREATE TABLE`` statement have been updated to properly handle both quoted and unquoted constraint names. .. change:: :tags: bug, typing Fixed typing issue where :class:`.coalesce` would not return the correct return type when a nullable form of that argument were passed, even though this function is meant to select the non-null entry among possibly null arguments. Pull request courtesy Yannick PÉROUX. .. change:: :tags: usecase, mysql :tickets: 12964 Added support for MySQL 8.0.1 + ``FOR SHARE`` to be emitted for the :meth:`.Select.with_for_update` method, which offers compatibility with ``NOWAIT`` and ``SKIP LOCKED``. The new syntax is used only for MySQL when version 8.0.1 or higher is detected. Pull request courtesy JetDrag. .. change:: :tags: bug, sql :tickets: 12987 Fixed issue where using the :meth:`.ColumnOperators.in_` operator with a nested :class:`.CompoundSelect` statement (e.g. an ``INTERSECT`` of ``UNION`` queries) would raise a :class:`NotImplementedError` when the nested compound select was the first argument to the outer compound select. The ``_scalar_type()`` internal method now properly handles nested compound selects. .. change:: :tags: bug, postgresql :tickets: 13015 Fixed the structure of the SQL string used for the :ref:`engine_insertmanyvalues` feature when an explicit sequence with ``nextval()`` is used. The SQL function invocation for the sequence has been moved from being rendered inline within each tuple inside of VALUES to being rendered once in the SELECT that reads from VALUES. This change ensures the function is invoked in the correct order as rows are processed, rather than assuming PostgreSQL will execute inline function calls within VALUES in a particular order. While current PostgreSQL versions appear to handle the previous approach correctly, the database does not guarantee this behavior for future versions. .. change:: :tags: usecase, postgresql :tickets: 6511 Added support for reflection of collation in types for PostgreSQL. The ``collation`` will be set only if different from the default one for the type. Pull request courtesy Denis Laxalde. .. change:: :tags: bug, examples Fixed the "short_selects" performance example where the cache was being used in all the examples, making it impossible to compare performance with and without the cache. Less important comparisons like "lambdas" and "baked queries" have been removed. .. change:: :tags: change, tests A noxfile.py has been added to allow testing with nox. This is a direct port of 2.1's move to nox, however leaves the tox.ini file in place and retains all test documentation in terms of tox. Version 2.1 will move to nox fully, including deprecation warnings for tox and new testing documentation. .. changelog:: ``` ### 2.0.44 ``` :released: October 10, 2025 .. change:: :tags: bug, sql :tickets: 12271 Improved the implementation of :meth:`.UpdateBase.returning` to use more robust logic in setting up the ``.c`` collection of a derived statement such as a CTE. This fixes issues related to RETURNING clauses that feature expressions based on returned columns with or without qualifying labels. .. change:: :tags: usecase, asyncio :tickets: 12273 Generalize the terminate logic employed by the asyncpg dialect to reuse it in the aiomysql and asyncmy dialect implementation. .. change:: :tags: bug, mssql :tickets: 12798 Improved the base implementation of the asyncio cursor such that it includes the option for the underlying driver's cursor to be actively closed in those cases where it requires ``await`` in order to complete the close sequence, rather than relying on garbage collection to "close" it, when a plain :class:`.Result` is returned that does not use ``await`` for any of its methods. The previous approach of relying on gc was fine for MySQL and SQLite dialects but has caused problems with the aioodbc implementation on top of SQL Server. The new option is enabled for those dialects which have an "awaitable" ``cursor.close()``, which includes the aioodbc, aiomysql, and asyncmy dialects (aiosqlite is also modified for 2.1 only). .. change:: :tags: bug, ext :tickets: 12802 Fixed issue caused by an unwanted functional change while typing the :class:`.MutableList` class. This change also reverts all other functional changes done in the same change. .. change:: :tags: bug, typing :tickets: 12813 Fixed typing bug where the :meth:`.Session.execute` method advertised that it would return a :class:`.CursorResult` if given an insert/update/delete statement. This is not the general case as several flavors of ORM insert/update do not actually yield a :class:`.CursorResult` which cannot be differentiated at the typing overload level, so the method now yields :class:`.Result` in all cases. For those cases where :class:`.CursorResult` is known to be returned and the ``.rowcount`` attribute is required, please use ``typing.cast()``. .. change:: :tags: usecase, orm :tickets: 12829 The way ORM Annotated Declarative interprets Python :pep:`695` type aliases in ``Mapped[]`` annotations has been refined to expand the lookup scheme. A :pep:`695` type can now be resolved based on either its direct presence in :paramref:`_orm.registry.type_annotation_map` or its immediate resolved value, as long as a recursive lookup across multiple :pep:`695` types is not required for it to resolve. This change reverses part of the restrictions introduced in 2.0.37 as part of :ticket:`11955`, which deprecated (and disallowed in 2.1) the ability to resolve any :pep:`695` type that was not explicitly present in :paramref:`_orm.registry.type_annotation_map`. Recursive lookups of :pep:`695` types remains deprecated in 2.0 and disallowed in version 2.1, as do implicit lookups of ``NewType`` types without an entry in :paramref:`_orm.registry.type_annotation_map`. Additionally, new support has been added for generic :pep:`695` aliases that refer to :pep:`593` ``Annotated`` constructs containing :func:`_orm.mapped_column` configurations. See the sections below for examples. .. seealso:: :ref:`orm_declarative_type_map_pep695_types` :ref:`orm_declarative_mapped_column_generic_pep593` .. change:: :tags: bug, postgresql :tickets: 12847 Fixed issue where selecting an enum array column containing NULL values would fail to parse properly in the PostgreSQL dialect. The :func:`._split_enum_values` function now correctly handles NULL entries by converting them to Python ``None`` values. .. change:: :tags: bug, typing :tickets: 12855 Added new decorator :func:`_orm.mapped_as_dataclass`, which is a function based form of :meth:`_orm.registry.mapped_as_dataclass`; the method form :meth:`_orm.registry.mapped_as_dataclass` does not seem to be correctly recognized within the scope of :pep:`681` in recent mypy versions. .. change:: :tags: bug, sqlite :tickets: 12864 Fixed issue where SQLite table reflection would fail for tables using ``WITHOUT ROWID`` and/or ``STRICT`` table options when the table contained generated columns. The regular expression used to parse ``CREATE TABLE`` statements for generated column detection has been updated to properly handle these SQLite table options that appear after the column definitions. Pull request courtesy Tip ten Brink. .. change:: :tags: bug, postgresql :tickets: 12874 Fixed issue where the :func:`_sql.any_` and :func:`_sql.all_` aggregation operators would not correctly coerce the datatype of the compared value, in those cases where the compared value were not a simple int/str etc., such as a Python ``Enum`` or other custom value. This would lead to execution time errors for these values. This issue is essentially the same as :ticket:`6515` which was for the now-legacy :meth:`.ARRAY.any` and :meth:`.ARRAY.all` methods. .. change:: :tags: bug, engine :tickets: 12881 Implemented initial support for free-threaded Python by adding new tests and reworking the test harness to include Python 3.13t and Python 3.14t in test runs. Two concurrency issues have been identified and fixed: the first involves initialization of the ``.c`` collection on a ``FromClause``, a continuation of :ticket:`12302`, where an optional mutex under free-threading is added; the second involves synchronization of the pool "first_connect" event, which first received thread synchronization in :ticket:`2964`, however under free-threading the creation of the mutex itself runs under the same free-threading mutex. Support for free-threaded wheels on Pypi is implemented as well within the 2.1 series only. Initial pull request and test suite courtesy Lysandros Nikolaou. .. change:: :tags: bug, schema :tickets: 12884 Fixed issue where :meth:`_schema.MetaData.reflect` did not forward dialect-specific keyword arguments to the :class:`_engine.Inspector` methods, causing options like ``oracle_resolve_synonyms`` to be ignored during reflection. The method now ensures that all extra kwargs passed to :meth:`_schema.MetaData.reflect` are forwarded to :meth:`_engine.Inspector.get_table_names` and related reflection methods. Pull request courtesy Lukáš Kožušník. .. change:: :tags: bug, mssql :tickets: 12894 Fixed issue where the index reflection for SQL Server would not correctly return the order of the column inside an index when the order of the columns in the index did not match the order of the columns in the table. Pull request courtesy of Allen Chen. .. change:: :tags: bug, orm :tickets: 12905 Fixed a caching issue where :func:`_orm.with_loader_criteria` would incorrectly reuse cached bound parameter values when used with :class:`_sql.CompoundSelect` constructs such as :func:`_sql.union`. The issue was caused by the cache key for compound selects not including the execution options that are part of the :class:`_sql.Executable` base class, which :func:`_orm.with_loader_criteria` uses to apply its criteria dynamically. The fix ensures that compound selects and other executable constructs properly include execution options in their cache key traversal. .. change:: :tags: bug, mssql, reflection :tickets: 12907 Fixed issue in the MSSQL dialect's foreign key reflection query where duplicate rows could be returned when a foreign key column and its referenced primary key column have the same name, and both the referencing and referenced tables have indexes with the same name. This resulted in an "ForeignKeyConstraint with duplicate source column references are not supported" error when attempting to reflect such tables. The query has been corrected to exclude indexes on the child table when looking for unique indexes referenced by foreign keys. .. change:: :tags: bug, platform Unblocked automatic greenlet installation for Python 3.14 now that there are greenlet wheels on pypi for python 3.14. .. changelog:: ``` ### 2.0.43 ``` :released: August 11, 2025 .. change:: :tags: usecase, oracle :tickets: 12711 Extended :class:`_oracle.VECTOR` to support sparse vectors. This update introduces :class:`_oracle.VectorStorageType` to specify sparse or dense storage and added :class:`_oracle.SparseVector`. Pull request courtesy Suraj Shaw. .. change:: :tags: bug, orm :tickets: 12748 Fixed issue where using the ``post_update`` feature would apply incorrect "pre-fetched" values to the ORM objects after a multi-row UPDATE process completed. These "pre-fetched" values would come from any column that had an :paramref:`.Column.onupdate` callable or a version id generator used by :paramref:`.orm.Mapper.version_id_generator`; for a version id generator that delivered random identifiers like timestamps or UUIDs, this incorrect data would lead to a DELETE statement against those same rows to fail in the next step. .. change:: :tags: bug, postgresql :tickets: 12778 Fixed regression in PostgreSQL dialect where JSONB subscription syntax would generate incorrect SQL for JSONB-returning functions, causing syntax errors. The dialect now properly wraps function calls and expressions in parentheses when using the ``[]`` subscription syntax, generating ``(function_call)[index]`` instead of ``function_call[index]`` to comply with PostgreSQL syntax requirements. .. change:: :tags: usecase, engine :tickets: 12784 Added new parameter :paramref:`.create_engine.skip_autocommit_rollback` which provides for a per-dialect feature of preventing the DBAPI ``.rollback()`` from being called under any circumstances, if the connection is detected as being in "autocommit" mode. This improves upon a critical performance issue identified in MySQL dialects where the network overhead of the ``.rollback()`` call remains prohibitive even if autocommit mode is set. .. seealso:: :ref:`dbapi_autocommit_skip_rollback` .. change:: :tags: bug, orm :tickets: 12787 Fixed issue where :paramref:`_orm.mapped_column.use_existing_column` parameter in :func:`_orm.mapped_column` would not work when the :func:`_orm.mapped_column` is used inside of an ``Annotated`` type alias in polymorphic inheritance scenarios. The parameter is now properly recognized and processed during declarative mapping configuration. .. change:: :tags: bug, orm :tickets: 12790 Improved the implementation of the :func:`_orm.selectin_polymorphic` inheritance loader strategy to properly render the IN expressions using chunks of 500 records each, in the same manner as that of the :func:`_orm.selectinload` relationship loader strategy. Previously, the IN expression would be arbitrarily large, leading to failures on databases that have limits on the size of IN expressions including Oracle Database. .. changelog:: ``` ### 2.0.42 ``` :released: July 29, 2025 .. change:: :tags: usecase, orm :tickets: 10674 Added ``dataclass_metadata`` argument to all ORM attribute constructors that accept dataclasses parameters, e.g. :paramref:`.mapped_column.dataclass_metadata`, :paramref:`.relationship.dataclass_metadata`, etc. It's passed to the underlying dataclass ``metadata`` attribute of the dataclass field. Pull request courtesy Sigmund Lahn. .. change:: :tags: usecase, postgresql :tickets: 10927 Added support for PostgreSQL 14+ :class:`.JSONB` subscripting syntax. When connected to PostgreSQL 14 or later, JSONB columns now automatically use the native subscript notation ``jsonb_col['key']`` instead of the arrow operator ``jsonb_col -> 'key'`` for both read and write operations. This provides better compatibility with PostgreSQL's native JSONB subscripting feature while maintaining backward compatibility with older PostgreSQL versions. JSON columns continue to use the traditional arrow syntax regardless of PostgreSQL version. .. warning:: **For applications that have indexes against JSONB subscript expressions** This change caused an unintended side effect for indexes that were created against expressions that use subscript notation, e.g. ``Index("ix_entity_json_ab_text", data["a"]["b"].astext)``. If these indexes were generated with the older syntax e.g. ``((entity.data -> 'a') ->> 'b')``, they will not be used by the PostgreSQL query planner when a query is made using SQLAlchemy 2.0.42 or higher on PostgreSQL versions 14 or higher. This occurs because the new text will resemble ``(entity.data['a'] ->> 'b')`` which will fail to produce the exact textual syntax match required by the PostgreSQL query planner. Therefore, for users upgrading to SQLAlchemy 2.0.42 or higher, existing indexes that were created against :class:`.JSONB` expressions that use subscripting would need to be dropped and re-created in order for them to work with the new query syntax, e.g. an expression like ``((entity.data -> 'a') ->> 'b')`` would become ``(entity.data['a'] ->> 'b')``. .. seealso:: :ticket:`12868` - discussion of this issue .. change:: :tags: bug, orm :tickets: 12593 Implemented the :func:`_orm.defer`, :func:`_orm.undefer` and :func:`_orm.load_only` loader options to work for composite attributes, a use case that had never been supported previously. .. change:: :tags: bug, postgresql, reflection :tickets: 12600 Fixed regression caused by :ticket:`10665` where the newly modified constraint reflection query would fail on older versions of PostgreSQL such as version 9.6. Pull request courtesy Denis Laxalde. .. change:: :tags: bug, mysql :tickets: 12648 Fixed yet another regression caused by by the DEFAULT rendering changes in 2.0.40 :ticket:`12425`, similar to :ticket:`12488`, this time where using a CURRENT_TIMESTAMP function with a fractional seconds portion inside a textual default value would also fail to be recognized as a non-parenthesized server default. .. change:: :tags: bug, mssql :tickets: 12654 Reworked SQL Server column reflection to be based on the ``sys.columns`` table rather than ``information_schema.columns`` view. By correctly using the SQL Server ``object_id()`` function as a lead and joining to related tables on object_id rather than names, this repairs a variety of issues in SQL Server reflection, including: * Issue where reflected column comments would not correctly line up with the columns themselves in the case that the table had been ALTERed * Correctly targets tables with awkward names such as names with brackets, when reflecting not just the basic table / columns but also extended information including IDENTITY, computed columns, comments which did not work previously * Correctly targets IDENTITY, computed status from temporary tables which did not work previously .. change:: :tags: bug, sql :tickets: 12681 Fixed issue where :func:`.select` of a free-standing scalar expression that has a unary operator applied, such as negation, would not apply result processors to the selected column even though the correct type remains in place for the unary expression. .. change:: :tags: bug, sql :tickets: 12692 Hardening of the compiler's actions for UPDATE statements that access multiple tables to report more specifically when tables or aliases are referenced in the SET clause; on cases where the backend does not support secondary tables in the SET clause, an explicit error is raised, and on the MySQL or similar backends that support such a SET clause, more specific checking for not-properly-included tables is performed. Overall the change is preventing these erroneous forms of UPDATE statements from being compiled, whereas previously it was relied on the database to raise an error, which was not always guaranteed to happen, or to be non-ambiguous, due to cases where the parent table included the same column name as the secondary table column being updated. .. change:: :tags: bug, orm :tickets: 12692 Fixed bug where the ORM would pull in the wrong column into an UPDATE when a key name inside of the :meth:`.ValuesBase.values` method could be located from an ORM entity mentioned in the statement, but where that ORM entity was not the actual table that the statement was inserting or updating. An extra check for this edge case is added to avoid this problem. .. change:: :tags: bug, postgresql :tickets: 12728 Re-raise caught ``CancelledError`` in the terminate method of the asyncpg dialect to avoid possible hangs of the code execution. .. change:: :tags: usecase, sql :tickets: 12734 The :func:`_sql.values` construct gains a new method :meth:`_sql.Values.cte`, which allows creation of a named, explicit-columns :class:`.CTE` against an unnamed ``VALUES`` expression, producing a syntax that allows column-oriented selection from a ``VALUES`` construct on modern versions of PostgreSQL, SQLite, and MariaDB. .. change:: :tags: bug, reflection, postgresql :tickets: 12744 Fixes bug that would mistakenly interpret a domain or enum type with name starting in ``interval`` as an ``INTERVAL`` type while reflecting a table. .. change:: :tags: usecase, postgresql :tickets: 8664 Added ``postgresql_ops`` key to the ``dialect_options`` entry in reflected dictionary. This maps names of columns used in the index to respective operator class, if distinct from the default one for column's data type. Pull request courtesy Denis Laxalde. .. seealso:: :ref:`postgresql_operator_classes` .. change:: :tags: engine Improved validation of execution parameters passed to the :meth:`_engine.Connection.execute` and similar methods to provided a better error when tuples are passed in. Previously the execution would fail with a difficult to understand error message. .. changelog:: ``` ### 2.0.41 ``` :released: May 14, 2025 .. change:: :tags: usecase, postgresql :tickets: 10665 Added support for ``postgresql_include`` keyword argument to :class:`_schema.UniqueConstraint` and :class:`_schema.PrimaryKeyConstraint`. Pull request courtesy Denis Laxalde. .. seealso:: :ref:`postgresql_constraint_options` .. change:: :tags: usecase, oracle :tickets: 12317, 12341 Added new datatype :class:`_oracle.VECTOR` and accompanying DDL and DQL support to fully support this type for Oracle Database. This change includes the base :class:`_oracle.VECTOR` type that adds new type-specific methods ``l2_distance``, ``cosine_distance``, ``inner_product`` as well as new parameters ``oracle_vector`` for the :class:`.Index` construct, allowing vector indexes to be configured, and ``oracle_fetch_approximate`` for the :meth:`.Select.fetch` clause. Pull request courtesy Suraj Shaw. .. seealso:: :ref:`oracle_vector_datatype` .. change:: :tags: bug, platform :tickets: 12405 Adjusted the test suite as well as the ORM's method of scanning classes for annotations to work under current beta releases of Python 3.14 (currently 3.14.0b1) as part of an ongoing effort to support the production release of this Python release. Further changes to Python's means of working with annotations is expected in subsequent beta releases for which SQLAlchemy's test suite will need further adjustments. .. change:: :tags: bug, mysql :tickets: 12488 Fixed regression caused by the DEFAULT rendering changes in version 2.0.40 via :ticket:`12425` where using lowercase ``on update`` in a MySQL server default would incorrectly apply parenthesis, leading to errors when MySQL interpreted the rendered DDL. Pull request courtesy Alexander Ruehe. .. change:: :tags: bug, sqlite :tickets: 12566 Fixed and added test support for some SQLite SQL functions hardcoded into the compiler, most notably the ``localtimestamp`` function which rendered with incorrect internal quoting. .. change:: :tags: bug, engine :tickets: 12579 The error message that is emitted when a URL cannot be parsed no longer includes the URL itself within the error message. .. change:: :tags: bug, typing :tickets: 12588 Removed ``__getattr__()`` rule from ``sqlalchemy/__init__.py`` that appeared to be trying to correct for a previous typographical error in the imports. This rule interferes with type checking and is removed. .. change:: :tags: bug, installation Removed the "license classifier" from setup.cfg for SQLAlchemy 2.0, which eliminates loud deprecation warnings when building the package. SQLAlchemy 2.1 will use a full :pep:`639` configuration in pyproject.toml while SQLAlchemy 2.0 remains using ``setup.cfg`` for setup. .. changelog:: ``` ### 2.0.40 ``` :released: March 27, 2025 .. change:: :tags: usecase, postgresql :tickets: 11595 Added support for specifying a list of columns for ``SET NULL`` and ``SET DEFAULT`` actions of ``ON DELETE`` clause of foreign key definition on PostgreSQL. Pull request courtesy Denis Laxalde. .. seealso:: :ref:`postgresql_constraint_options` .. change:: :tags: bug, orm :tickets: 12329 Fixed regression which occurred as of 2.0.37 where the checked :class:`.ArgumentError` that's raised when an inappropriate type or object is used inside of a :class:`.Mapped` annotation would raise ``TypeError`` with "boolean value of this clause is not defined" if the object resolved into a SQL expression in a boolean context, for programs where future annotations mode was not enabled. This case is now handled explicitly and a new error message has also been tailored for this case. In addition, as there are at least half a dozen distinct error scenarios for interpretation of the :class:`.Mapped` construct, these scenarios have all been unified under a new subclass of :class:`.ArgumentError` called :class:`.MappedAnnotationError`, to provide some continuity between these different scenarios, even though specific messaging remains distinct. .. change:: :tags: bug, mysql :tickets: 12332 Support has been re-added for the MySQL-Connector/Python DBAPI using the ``mysql+mysqlconnector://`` URL scheme. The DBAPI now works against modern MySQL versions as well as MariaDB versions (in the latter case it's required to pass charset/collation explicitly). Note however that server side cursor support is disabled due to unresolved issues with this driver. .. change:: :tags: bug, sql :tickets: 12363 Fixed issue in :class:`.CTE` constructs involving multiple DDL :class:`_sql.Insert` statements with multiple VALUES parameter sets where the bound parameter names generated for these parameter sets would conflict, generating a compile time error. .. change:: :tags: bug, sqlite :tickets: 12425 Expanded the rules for when to apply parenthesis to a server default in DDL to suit the general case of a default string that contains non-word characters such as spaces or operators and is not a string literal. .. change:: :tags: bug, mysql :tickets: 12425 Fixed issue in MySQL server default reflection where a default that has spaces would not be correctly reflected. Additionally, expanded the rules for when to apply parenthesis to a server default in DDL to suit the general case of a default string that contains non-word characters such as spaces or operators and is not a string literal. .. change:: :tags: usecase, postgresql :tickets: 12432 When building a PostgreSQL ``ARRAY`` literal using :class:`_postgresql.array` with an empty ``clauses`` argument, the :paramref:`_postgresql.array.type_` parameter is now significant in that it will be used to render the resulting ``ARRAY[]`` SQL expression with a cast, such as ``ARRAY[]::INTEGER``. Pull request courtesy Denis Laxalde. .. change:: :tags: sql, usecase :tickets: 12450 Implemented support for the GROUPS frame specification in window functions by adding :paramref:`_sql.over.groups` option to :func:`_sql.over` and :meth:`.FunctionElement.over`. Pull request courtesy Kaan Dikmen. .. change:: :tags: bug, sql :tickets: 12451 Fixed regression caused by :ticket:`7471` leading to a SQL compilation issue where name disambiguation for two same-named FROM clauses with table aliasing in use at the same time would produce invalid SQL in the FROM clause with two "AS" clauses for the aliased table, due to double aliasing. .. change:: :tags: bug, asyncio :tickets: 12471 Fixed issue where :meth:`.AsyncSession.get_transaction` and :meth:`.AsyncSession.get_nested_transaction` would fail with ``NotImplementedError`` if the "proxy transaction" used by :class:`.AsyncSession` were garbage collected and needed regeneration. .. change:: :tags: bug, orm :tickets: 12473 Fixed regression in ORM Annotated Declarative class interpretation caused by ``typing_extension==4.13.0`` that introduced a different implementation for ``TypeAliasType`` while SQLAlchemy assumed that it would be equivalent to the ``typing`` version, leading to pep-695 type annotations not resolving to SQL types as expected. .. changelog:: ``` ### 2.0.39 ``` :released: March 11, 2025 .. change:: :tags: bug, postgresql :tickets: 11751 Add SQL typing to reflection query used to retrieve a the structure of IDENTITY columns, adding explicit JSON typing to the query to suit unusual PostgreSQL driver configurations that don't support JSON natively. .. change:: :tags: bug, postgresql Fixed issue affecting PostgreSQL 17.3 and greater where reflection of domains with "NOT NULL" as part of their definition would include an invalid constraint entry in the data returned by :meth:`_postgresql.PGInspector.get_domains` corresponding to an additional "NOT NULL" constraint that isn't a CHECK constraint; the existing ``"nullable"`` entry in the dictionary already indicates if the domain includes a "not null" constraint. Note that such domains also cannot be reflected on PostgreSQL 17.0 through 17.2 due to a bug on the PostgreSQL side; if encountering errors in reflection of domains which include NOT NULL, upgrade to PostgreSQL server 17.3 or greater. .. change:: :tags: typing, usecase :tickets: 11922 Support generic types for compound selects (:func:`_sql.union`, :func:`_sql.union_all`, :meth:`_sql.Select.union`, :meth:`_sql.Select.union_all`, etc) returning the type of the first select. Pull request courtesy of Mingyu Park. .. change:: :tags: bug, postgresql :tickets: 12060 Fixed issue in PostgreSQL network types :class:`_postgresql.INET`, :class:`_postgresql.CIDR`, :class:`_postgresql.MACADDR`, :class:`_postgresql.MACADDR8` where sending string values to compare to these types would render an explicit CAST to VARCHAR, causing some SQL / driver combinations to fail. Pull request courtesy Denis Laxalde. .. change:: :tags: bug, orm :tickets: 12326 Fixed bug where using DML returning such as :meth:`.Insert.returning` with an ORM model that has :func:`_orm.column_property` constructs that contain subqueries would fail with an internal error. .. change:: :tags: bug, orm :tickets: 12328 Fixed bug in ORM enabled UPDATE (and theoretically DELETE) where using a multi-table DML statement would not allow ORM mapped columns from mappers other than the primary UPDATE mapper to be named in the RETURNING clause; they would be omitted instead and cause a column not found exception. .. change:: :tags: bug, asyncio :tickets: 12338 Fixed bug where :meth:`_asyncio.AsyncResult.scalar`, :meth:`_asyncio.AsyncResult.scalar_one_or_none`, and :meth:`_asyncio.AsyncResult.scalar_one` would raise an ``AttributeError`` due to a missing internal attribute. Pull request courtesy Allen Ho. .. change:: :tags: bug, orm :tickets: 12357 Fixed issue where the "is ORM" flag of a :func:`.select` or other ORM statement would not be propagated to the ORM :class:`.Session` based on a multi-part operator expression alone, e.g. such as ``Cls.attr + Cls.attr + Cls.attr`` or similar, leading to ORM behaviors not taking place for such statements. .. change:: :tags: bug, orm :tickets: 12364 Fixed issue where using :func:`_orm.aliased` around a :class:`.CTE` construct could cause inappropriate "duplicate CTE" errors in cases where that aliased construct appeared multiple times in a single statement. .. change:: :tags: bug, sqlite :tickets: 12368 Fixed issue that omitted the comma between multiple SQLite table extension clauses, currently ``WITH ROWID`` and ``STRICT``, when both options :paramref:`.Table.sqlite_with_rowid` and :paramref:`.Table.sqlite_strict` were configured at their non-default settings at the same time. Pull request courtesy david-fed. .. change:: :tags: bug, sql :tickets: 12382 Added new parameters :paramref:`.AddConstraint.isolate_from_table` and :paramref:`.DropConstraint.isolate_from_table`, defaulting to True, which both document and allow to be controllable the long-standing behavior of these two constructs blocking the given constraint from being included inline within the "CREATE TABLE" sequence, under the assumption that separate add/drop directives were to be used. .. change:: :tags: bug, postgresql :tickets: 12417 Fixed compiler issue in the PostgreSQL dialect where incorrect keywords would be passed when using "FOR UPDATE OF" inside of a subquery. .. changelog:: ``` ### 2.0.38 ``` :released: February 6, 2025 .. change:: :tags: postgresql, usecase, asyncio :tickets: 12077 Added an additional ``asyncio.shield()`` call within the connection terminate process of the asyncpg driver, to mitigate an issue where terminate would be prevented from completing under the anyio concurrency library. .. change:: :tags: bug, dml, mariadb, mysql :tickets: 12117 Fixed a bug where the MySQL statement compiler would not properly compile statements where :meth:`_mysql.Insert.on_duplicate_key_update` was passed values that included ORM-mapped attributes (e.g. :class:`InstrumentedAttribute` objects) as keys. Pull request courtesy of mingyu. .. change:: :tags: bug, postgresql :tickets: 12159 Adjusted the asyncpg connection wrapper so that the ``connection.transaction()`` call sent to asyncpg sends ``None`` for ``isolation_level`` if not otherwise set in the SQLAlchemy dialect/wrapper, thereby allowing asyncpg to make use of the server level setting for ``isolation_level`` in the absence of a client-level setting. Previously, this behavior of asyncpg was blocked by a hardcoded ``read_committed``. .. change:: :tags: bug, sqlite, aiosqlite, asyncio, pool :tickets: 12285 Changed default connection pool used by the ``aiosqlite`` dialect from :class:`.NullPool` to :class:`.AsyncAdaptedQueuePool`; this change should have been made when 2.0 was first released as the ``pysqlite`` dialect was similarly changed to use :class:`.QueuePool` as detailed in :ref:`change_7490`. .. change:: :tags: bug, engine :tickets: 12289 Fixed event-related issue where invoking :meth:`.Engine.execution_options` on a :class:`.Engine` multiple times while making use of event-registering parameters such as ``isolation_level`` would lead to internal errors involving event registration. .. change:: :tags: bug, sql :tickets: 12302 Reorganized the internals by which the ``.c`` collection on a :class:`.FromClause` gets generated so that it is resilient against the collection being accessed in concurrent fashion. An example is creating a :class:`.Alias` or :class:`.Subquery` and accessing it as a module level variable. This impacts the Oracle dialect which uses such module-level global alias objects but is of general use as well. .. change:: :tags: bug, sql :tickets: 12314 Fixed SQL composition bug which impacted caching where using a ``None`` value inside of an ``in_()`` expression would bypass the usual "expanded bind parameter" logic used by the IN construct, which allows proper caching to take place. .. changelog:: ``` ### 2.0.37 ``` :released: January 9, 2025 .. change:: :tags: usecase, mariadb :tickets: 10720 Added sql types ``INET4`` and ``INET6`` in the MariaDB dialect. Pull request courtesy Adam Žurek. .. change:: :tags: bug, orm :tickets: 11370 Fixed issue regarding ``Union`` types that would be present in the :paramref:`_orm.registry.type_annotation_map` of a :class:`_orm.registry` or declarative base class, where a :class:`.Mapped` element that included one of the subtypes present in that ``Union`` would be matched to that entry, potentially ignoring other entries that matched exactly. The correct behavior now takes place such that an entry should only match in :paramref:`_orm.registry.type_annotation_map` exactly, as a ``Union`` type is a self-contained type. For example, an attribute with ``Mapped[float]`` would previously match to a :paramref:`_orm.registry.type_annotation_map` entry ``Union[float, Decimal]``; this will no longer match and will now only match to an entry that states ``float``. Pull request courtesy Frazer McLean. .. change:: :tags: bug, postgresql :tickets: 11724 Fixes issue in :meth:`.Dialect.get_multi_indexes` in the PostgreSQL dialect, where an error would be thrown when attempting to use alembic with a vector index from the pgvecto.rs extension. .. change:: :tags: usecase, mysql, mariadb :tickets: 11764 Added support for the ``LIMIT`` clause with ``DELETE`` for the MySQL and MariaDB dialects, to complement the already present option for ``UPDATE``. The :meth:`.Delete.with_dialect_options` method of the :func:`.delete` construct accepts parameters for ``mysql_limit`` and ``mariadb_limit``, allowing users to specify a limit on the number of rows deleted. Pull request courtesy of Pablo Nicolás Estevez. .. change:: :tags: bug, mysql, mariadb Added logic to ensure that the ``mysql_limit`` and ``mariadb_limit`` parameters of :meth:`.Update.with_dialect_options` and :meth:`.Delete.with_dialect_options` when compiled to string will only compile if the parameter is passed as an integer; a ``ValueError`` is raised otherwise. .. change:: :tags: bug, orm :tickets: 11944 Fixed bug in how type unions were handled within :paramref:`_orm.registry.type_annotation_map` as well as :class:`._orm.Mapped` that made the lookup behavior of ``a | b`` different from that of ``Union[a, b]``. .. change:: :tags: bug, orm --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>