:param sql: if True, use ``--sql`` mode
:param tag: an arbitrary "tag" that can be intercepted by custom
- ``env.py`` scripts via the :class:`.EnvironmentContext.get_tag_argument`
+ ``env.py`` scripts via the :meth:`.EnvironmentContext.get_tag_argument`
method.
"""
:param sql: if True, use ``--sql`` mode
:param tag: an arbitrary "tag" that can be intercepted by custom
- ``env.py`` scripts via the :class:`.EnvironmentContext.get_tag_argument`
+ ``env.py`` scripts via the :meth:`.EnvironmentContext.get_tag_argument`
method.
"""
.. _operation_objects:
+.. _alembic.operations.ops.toplevel:
Built-in Operation Objects
==============================
The built-in operation objects are listed below.
-.. _alembic.operations.ops.toplevel:
-
.. automodule:: alembic.operations.ops
:members:
.. change::
:tags: feature, runtime
- Added a new callback hook :paramref:`.EnvironmentContext.on_version_apply`,
+ Added a new callback hook
+ :paramref:`.EnvironmentContext.configure.on_version_apply`,
which allows user-defined code to be invoked each time an individual
upgrade, downgrade, or stamp operation proceeds against a database.
Pull request courtesy John Passaro.
itself would be invoked by the :meth:`.EnvironmentContext.run_migrations`
method.
-.. automodule:: alembic.operations
- :members: Operations, BatchOperations
+.. module:: alembic.operations
+
+.. autoclass:: Operations
+
+.. autoclass:: BatchOperations