- update to 1.12.0
* Added new feature to the "code formatter" function which allows standalone
executable tools to be run against code, without going through the Python
interpreter. Known as the `exec` runner, it complements the existing
`console_scripts` runner by allowing non-Python tools such as `ruff` to
be used.
* Change the default value of `.EnvironmentContext.configure.compare_type` to `True`.
As Alembic's autogenerate for types was dramatically improved in
version 1.4 released in 2020, the type comparison feature is now much
more reliable so is now enabled by default.
* Fixed issue where the `ForeignKeyConstraint.match` parameter would not be
rendered in autogenerated migrations.
* Fixed issue where the `revision_environment` directive in `alembic.ini`
was ignored by the `alembic merge` command, leading to issues when other
configurational elements depend upon `env.py` being invoked within the
command.
* Added support for `op.drop_constraint()` to support PostgreSQL
`ExcludeConstraint` objects, as well as other constraint-like objects
that may be present in third party dialects, by resolving the `type_`
parameter to be `None` for this case. Autogenerate has also been
enhanced to exclude the `type_` parameter from rendering within this
command when `type_` is `None`.
OBS-URL: https://build.opensuse.org/request/show/1113500
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-alembic?expand=0&rev=150
* As Alembic 1.11.0 is considered a major release (Alembic does
not use semver, nor does its parent project SQLAlchemy;
this has been `clarified <versioning_scheme>` in the documentation),
* 🎫`1130` modified calling signatures for most
operations to consider all optional keyword parameters to
be keyword-only arguments, to match what was always documented
and generated by autogenerate. However, two of these
changes were identified as possibly problematic without a
more formal deprecation warning being emitted which were the
``table_name`` parameter to :meth:`.Operations.drop_index`,
which was generated positionally by autogenerate prior to
version 0.6.3 released in 2014, and
``type_`` in :meth:`.Operations.drop_constraint` and
:meth:`.BatchOperations.drop_constraint`, which was
documented positionally in one example in the batch documentation.
* Fixed typing use of :class:`~sqlalchemy.schema.Column` and
other generic SQLAlchemy classes.
* Restored the output type of :meth:`.Config.get_section` to
include ``Dict[str, str]`` as a potential return type, which
had been changed to immutable ``Mapping[str, str]``.
When a section is returned and the default is not used,
a mutable dictionary is returned.
* Added placeholder classes for :class:`~.sqla.Computed` and
* :class:`~.sqla.Identity` when older 1.x SQLAlchemy versions
are in use, namely prior to SQLAlchemy 1.3.11 when the
:class:`~.sqla.Computed` construct was introduced.
Previously these were set to None, however this
could cause issues with certain codepaths that were using
``isinstance()`` such as one within "batch mode".
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-alembic?expand=0&rev=146
* Added support for autogenerate comparison of indexes on
PostgreSQL which include SQL sort option, such as
``ASC`` or ``NULLS FIRST``.
* Fixed various typing issues observed with pyright, including
issues involving the combination of :class:`.Function` and
:meth:`.MigrationContext.begin_transaction`.
* Fixed error raised by alembic when running autogenerate after
removing a function based index.
* Fixed regression where Alembic would not run with older
SQLAlchemy 1.3 versions prior to 1.3.24 due to a
missing symbol. Workarounds have been applied for older
1.3 versions.
* Fixed issue regarding PostgreSQL :class:`.ExcludeConstraint`,
where constraint elements which made use of :func:`.literal_column`
could not be rendered for autogenerate. Additionally, using SQLAlchemy
2.0.5 or greater, :func:`.text()` constructs are also supported within
PostgreSQL :class:`.ExcludeConstraint` objects for autogenerate render.
* Fixed issue in index detection where autogenerate change
detection would consider indexes with the same columns but with
different order as equal, while in general they are not equivalent
in how a database will use them.
* Recursive traversal of revision files in a particular
revision directory is now supported, by indicating
``recursive_version_locations = true`` in alembic.ini.
* Fixed issue where indexes on SQLite which include SQL
expressions would not compare correctly, generating false
positives under autogenerate. These indexes are now skipped,
generating a warning, in the same way that
expression-based indexes on PostgreSQL are skipped and
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-alembic?expand=0&rev=142
* Fixed typing definitions for :meth:`.EnvironmentContext.get_x_argument`.
Typing stubs are now generated for overloaded proxied methods such as
* Fixed regression caused by 🎫`1145` where the string transformations
applied to server defaults caused expressions such as ``(getdate())`` to no
longer compare as equivalent on SQL Server, others.
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-alembic?expand=0&rev=138
.. change::
🎟️ 1145
Fixed issue where server default compare would not work for string defaults
that contained backslashes, due to mis-rendering of these values when
comparing their contents.
.. change::
:tags: bug, oracle
Implemented basic server default comparison for the Oracle backend;
previously, Oracle's formatting of reflected defaults prevented any
matches from occurring.
.. change::
:tags: bug, sqlite
Adjusted SQLite's compare server default implementation to better handle
defaults with or without parens around them, from both the reflected and
the local metadata side.
.. change::
:tags: bug, mssql
Adjusted SQL Server's compare server default implementation to better
handle defaults with or without parens around them, from both the reflected
and the local metadata side.
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-alembic?expand=0&rev=135
- Update to 1.9.0:
feature
* Added new Alembic command alembic check. This performs the widely requested feature of running an “autogenerate” comparison
between the current database and the MetaData that’s currently set up for autogenerate, returning an error code if the two do not match,
based on current autogenerate settings. Pull request courtesy Nathan Louie.
See also Running Alembic Check to test for new upgrade operations
References: #724
bug
* Fixed issue in tox.ini file where changes in the tox 4.0 series to the format of “passenv” caused tox to not function correctly,
in particular raising an error as of tox 4.0.6.
* Fixed typing issue where revision.process_revision_directives was not fully typed; additionally ensured all Callable and Dict arguments
to EnvironmentContext.configure() include parameters in the typing declaration.
Additionally updated the codebase for Mypy 0.990 compliance.
References: #1110
OBS-URL: https://build.opensuse.org/request/show/1056256
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-alembic?expand=0&rev=134
* Fixed bug where the SQLite implementation of
:meth:`.Operations.rename_table` would render an explicit schema name for
both the old and new table name, which while is the standard ALTER syntax,
is not accepted by SQLite's syntax which doesn't support a rename across
schemas. In particular, the syntax issue would prevent batch mode from
working for SQLite databases that made use of attached databases (which are
treated as "schemas" in SQLAlchemy).
* Added an error raise for the condition where
:meth:`.Operations.batch_alter_table` is used in ``--sql`` mode, where the
operation requires table reflection, as is the case when running against
SQLite without giving it a fixed ``Table`` object. Previously the operation
would fail with an internal error. To get a "move and copy" batch
operation as a SQL script without connecting to a database,
a ``Table`` object should be passed to the
:paramref:`.Operations.batch_alter_table.copy_from` parameter so that
reflection may be skipped.
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-alembic?expand=0&rev=132
* Fixed issue where using :meth:`.Operations.create_table` in conjunction
with a :class:`.CheckConstraint` that referred to table-bound
:class:`.Column` objects rather than string expressions would be added to
the parent table potentially multiple times, resulting in an incorrect DDL
sequence. Pull request courtesy Nicolas CANIART.
* The ``logging.fileConfig()`` line in ``env.py`` templates, which is used
to setup Python logging for the migration run, is now conditional on
:attr:`.Config.config_file_name` not being ``None``. Otherwise, the line
is skipped as there is no default logging configuration present.
* Fixed bug where an :meth:`.Operations.alter_column` operation would change
a "NOT NULL" column to "NULL" by emitting an ALTER COLUMN statement that
did not specify "NOT NULL". (In the absence of "NOT NULL" T-SQL was
implicitly assuming "NULL"). An :meth:`.Operations.alter_column` operation
that specifies :paramref:`.Operations.alter_column.type` should also
specify include either :paramref:`.Operations.alter_column.nullable` or
:paramref:`.Operations.alter_column.existing_nullable` to inform Alembic as
to whether the emitted DDL should include "NULL" or "NOT NULL"; a warning
is now emitted if this is missing under this scenario.
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-alembic?expand=0&rev=128
* Add a new command alembic ensure_version, which will ensure that the Alembic
version table is present in the target database, but does not alter its
contents.
* Fixed regression where usage of a with_variant() datatype in conjunction with
the existing_type option of op.alter_column() under batch mode would lead to an
internal exception.
* Implemented support for recognizing and rendering SQLAlchemy “variant” types
going forward into SQLAlchemy 2.0, where the architecture of “variant”
datatypes will be changing.
* Added a rule to the MySQL impl so that the translation between JSON / LONGTEXT
is accommodated by autogenerate, treating LONGTEXT from the server as
equivalent to an existing JSON in the model.
* Removed a warning raised by SQLAlchemy when dropping constraints on MSSQL
regarding statement caching.
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-alembic?expand=0&rev=127
* Fixed a regression that prevented the use of post write hooks on python
version lower than 3.9
* Added missing attributes from context stubs.
* Fixed issue where registration of custom ops was prone to failure due to
the registration process running exec() on generated code that as of the
1.7 series includes pep-484 annotations, which in the case of end user code
would result in name resolution errors when the exec occurs
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-alembic?expand=0&rev=124
* feature
+ [feature] [autogenerate] Fix the documentation regarding the
default command-line argument position of the revision script
filename within the post-write hook arguments. Implement a
REVISION_SCRIPT_FILENAME token, enabling the position to be
changed. Switch from str.split() to shlex.split() for more
robust command-line argument parsing.
+ [feature] Implement a .cwd (current working directory) suboption
for post-write hooks (of type console_scripts). This is useful
for tools like pre-commit, which rely on the working directory
to locate the necessary config files. Add pre-commit as an
example to the documentation. Minor change: rename some
variables from ticket #819 to improve readability.
* bug
+ [bug] [autogenerate] Refactored the implementation of
MigrateOperation constructs such as CreateIndexOp,
CreateTableOp, etc. so that they no longer rely upon maintaining
a persistent version of each schema object internally; instead,
the state variables of each operation object will be used to
produce the corresponding construct when the operation is
invoked. The rationale is so that environments which m
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-alembic?expand=0&rev=121
* Fixed regression caused by SQLAlchemy 1.4 where the "alembic current"
command would fail due to changes in the ``URL`` object.
* Add async template to Alembic to bootstrap environments that use
async DBAPI. Updated the cookbook to include a migration guide
on how to adapt an existing enviroment for use with DBAPI drivers.
* Fixed bug in versioning model where a downgrade across a revision with a
dependency on another branch, yet an ancestor is also dependent on that
branch, would produce an erroneous state in the alembic_version table,
making upgrades impossible without manually repairing the table.
* Changed the default ordering of "CREATE" and "DROP" statements indexes and
unique constraints within the autogenerate process, so that for example in
an upgrade() operation, a particular index or constraint that is to be
replaced such as for a casing convention change will not produce any naming
conflicts.
* Fixed issue where autogenerate rendering of ``op.alter_column()`` would
fail to include MySQL ``existing_nullable=False`` if the column were part
of a primary key constraint within the table metadata.
* Added support for rendering of "identity" elements on
:class:`.Column` objects, supported in SQLAlchemy via
the :class:`.Identity` element introduced in version 1.4.
* Adding columns with identity is supported on PostgreSQL,
MSSQL and Oracle. Changing the identity options or removing
it is supported only on PostgreSQL and Oracle.
* To accommodate SQLAlchemy 1.4 and 2.0, the migration model now no longer
assumes that the SQLAlchemy Connection will autocommit an individual
operation.
* Modified the ``add_column()`` operation such that the ``Column`` object in
use is shallow copied to a new instance if that ``Column`` is already
attached to a ``table()`` or ``Table``.
* Added rendering for the ``Table.prefixes`` element to autogenerate so that
the rendered Python code includes these directives.
* Alembic 1.5.0 now supports **Python 2.7 and Python 3.6 and above**, as well
as **SQLAlchemy 1.3.0 and above**.
* Add ``__main__.py`` file to alembic package to support invocation
with ``python -m alembic``.
* Removed deprecated ``--head_only`` option to the ``alembic current``
command
- Drop pytest_depr_from_parent.patch, pytest plugin no longer used.
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-alembic?expand=0&rev=117
* bugs
+ Reverted the name change of the “revisions” argument to
command.stamp() to “revision” as apparently applications are
calling upon this argument as a keyword name. Pull request
courtesy Thomas Bechtold. Special translations are also added
to the command line interface so that it is still known
as “revisions” in the CLI.
References: #601
+ Removed the “test requirements” from “setup.py test”, as
this command now only emits a removal error in any case
and these requirements are unused.
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-alembic?expand=0&rev=96
* Fixed issue where server default comparison on the PostgreSQL dialect would
fail for a blank string on Python 3.7 only, due to a change in regular
expression behavior in Python 3.7.
* Removed use of deprecated ``force`` parameter for SQLAlchemy quoting
functions as this parameter will be removed in a future release.
Pull request courtesy Parth Shandilya(ParthS007).
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-alembic?expand=0&rev=84
+ Render autogenerate=True if present Fixed issue where
"autoincrement=True" would not render for a column that specified
it, since as of SQLAlchemy 1.1 this is no longer the default value
for "autoincrement".
+ Make call to declarative_base clear in example.
+ Use external impl for type rendering The render_type() method of
DefaultImpl was hardcoded to only work for SQLAlchemy types.
+ Implement native boolean check constraint flag in test suite
+ Use repr for drop_constraint schema
+ Add recipe for generating Python code for existing tables
* The ScriptDirectory system that loads migration files from a
* [feature] Added -r argument to alembic history command, allows specification of [start]:[end] to view a slice of history.
* [feature] Source base is now in-place for Python 2.6 through 3.3,
without the need for 2to3.
+ added Operations.create_primary_key() operation, will genenerate an
+ Explicit error message describing the case when downgrade --sql
+ [feature] New config argument
is run, to support script.py.mako templates with
to the template context when running the
MySQL. CHECK and undefined raise an error.
identifiers, i.e. "alembic upgrade +2",
"alembic downgrade -1". Courtesy
+ [bug] Fixed bug whereby directories inside of
on Pypy, would mistakenly be interpreted as
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-alembic?expand=0&rev=65
