2.0.0

Released: January 26, 2023

orm

• [orm] [bug] Improved the notification of warnings that are emitted within the configure mappers or flush process, which are often invoked as part of a different operation, to add additional context to the message that indicates one of these operations as the source of the warning within operations that may not be obviously related.

  References: #7305

orm extensions

• [feature] [orm extensions] Added new option to horizontal sharding API _horizontal.set_shard_id which sets the effective shard identifier to query against, for both the primary query as well as for all secondary loaders including relationship eager loaders as well as relationship and column lazy loaders.

  References: #7226

• [usecase] [orm extensions] Added new feature to AutomapBase for autoload of classes across multiple schemas which may have overlapping names, by providing a AutomapBase.prepare.modulename_for_table parameter which allows customization of the __module__ attribute of newly generated classes, as well as a new collection AutomapBase.by_module, which stores a dot-separated namespace of module names linked to classes based on the __module__ attribute.

  Additionally, the AutomapBase.prepare() method may now be invoked any number of times, with or without reflection enabled; only newly added tables that were not previously mapped will be processed on each call. Previously, the MetaData.reflect() method would need to be called explicitly each time.

  References: #5145

sql

• [sql] [bug] Fixed stringify for a the CreateSchema DDL construct, which would fail with an AttributeError when stringified without a dialect.

  This change is also backported to: 1.4.47

  References: #7664

typing

• [typing] [bug] Added typing for the built-in generic functions that are available from the :data:_sql.func namespace, which accept a particular set of arguments and return a particular type, such as for _sql.count, _sql.current_timestamp, etc.

  Unknown interpreted text role "data".

  References: #9129

• [typing] [bug] Corrected the type passed for "lambda statements" so that a plain lambda is accepted by mypy, pyright, others without any errors about argument types. Additionally implemented typing for more of the public API for lambda statements and ensured StatementLambdaElement is part of the Executable hierarchy so it's typed as accepted by _engine.Connection.execute().

  References: #9120

• [typing] [bug] The _sql.ColumnOperators.in_() and _sql.ColumnOperators.not_in() methods are typed to include Iterable[Any] rather than Sequence[Any] for more flexibility in argument type.

  References: #9122

• [typing] [bug] The _sql.or_() and _sql.and_() from a typing perspective require the first argument to be present, however these functions still accept zero arguments which will emit a deprecation warning at runtime. Typing is also added to support sending the fixed literal False for _sql.or_() and True for _sql.and_() as the first argument only, however the documentation now indicates sending the _sql.false() and _sql.true() constructs in these cases as a more explicit approach.

  References: #9123

• [typing] [bug] Fixed typing issue where iterating over a _orm.Query object was not correctly typed.

  References: #9125

• [typing] [bug] Fixed typing issue where the object type when using _engine.Result as a context manager were not preserved, indicating _engine.Result in all cases rather than the specific _engine.Result sub-type. Pull request courtesy Martin Baláž.

  References: #9136

• [typing] [bug] Fixed issue where using the _orm.relationship.remote_side and similar parameters, passing an annotated declarative object typed as _orm.Mapped, would not be accepted by the type checker.

  References: #9150

• [typing] [bug] Added typing to legacy operators such as isnot(), notin_(), etc. which previously were referencing the newer operators but were not themselves typed.

  References: #9148

mssql

• [mssql] [bug] Fixed bug where a schema name given with brackets, but no dots inside the name, for parameters such as _schema.Table.schema would not be interpreted within the context of the SQL Server dialect's documented behavior of interpreting explicit brackets as token delimiters, first added in 1.2 for #2626, when referring to the schema name in reflection operations. The original assumption for #2626's behavior was that the special interpretation of brackets was only significant if dots were present, however in practice, the brackets are not included as part of the identifier name for all SQL rendering operations since these are not valid characters within regular or delimited identifiers. Pull request courtesy Shan.

  This change is also backported to: 1.4.47

  References: #9133

• [mssql] [bug] Fixed bug where a schema name given with brackets, but no dots inside the name, for parameters such as _schema.Table.schema would not be interpreted within the context of the SQL Server dialect's documented behavior of interpreting explicit brackets as token delimiters, first added in 1.2 for #2626, when referring to the schema name in reflection operations. The original assumption for #2626's behavior was that the special interpretation of brackets was only significant if dots were present, however in practice, the brackets are not included as part of the identifier name for all SQL rendering operations since these are not valid characters within regular or delimited identifiers. Pull request courtesy Shan.

  This change is also backported to: 1.4.47

  References: #9133

• [mssql] [bug] [regression] The newly added comment reflection and rendering capability of the MSSQL dialect, added in #7844, will now be disabled by default if it cannot be determined that an unsupported backend such as Azure Synapse may be in use; this backend does not support table and column comments and does not support the SQL Server routines in use to generate them as well as to reflect them. A new parameter supports_comments is added to the dialect which defaults to None, indicating that comment support should be auto-detected. When set to True or False, the comment support is either enabled or disabled unconditionally.

  References: #9142

oracle

• [oracle] [bug] Added _oracle.ROWID to reflected types as this type may be used in a "CREATE TABLE" statement.

  This change is also backported to: 1.4.47

  References: #5047