REDROOM

Navigation

Breadcrumbs

Create

Edit File Size: 1.37 KB

/proc/thread-self/root/opt/alt/python37/share/doc/alt-python37-alembic/docs/build/api/runtime.rst

Text Base64

.. _alembic.runtime.environment.toplevel:

=======================
Runtime Objects
=======================

The "runtime" of Alembic involves the :class:`.EnvironmentContext`
and :class:`.MigrationContext` objects.   These are the objects that are
in play once the ``env.py`` script is loaded up by a command and
a migration operation proceeds.

The Environment Context
=======================

The :class:`.EnvironmentContext` class provides most of the
API used within an ``env.py`` script.  Within ``env.py``,
the instantated :class:`.EnvironmentContext` is made available
via a special *proxy module* called ``alembic.context``.   That is,
you can import ``alembic.context`` like a regular Python module,
and each name you call upon it is ultimately routed towards the
current :class:`.EnvironmentContext` in use.

In particular, the key method used within ``env.py`` is :meth:`.EnvironmentContext.configure`,
which establishes all the details about how the database will be accessed.

.. automodule:: alembic.runtime.environment
    :members: EnvironmentContext

.. _alembic.runtime.migration.toplevel:

The Migration Context
=====================

The :class:`.MigrationContext` handles the actual work to be performed
against a database backend as migration operations proceed.  It is generally
not exposed to the end-user.

.. automodule:: alembic.runtime.migration
    :members: MigrationContext

Exit & Reset Text mode: syntax highlighting auto-detects file type.

Name	Size	Perms	Modified	Actions
api_overview.png	121.06 KB	lrw-r--r--	2015-10-16 19:18:36	Edit Download recursive recursive
autogenerate.rst	24.64 KB	lrw-r--r--	2015-10-16 19:18:36	Edit Download recursive recursive
commands.rst	1.68 KB	lrw-r--r--	2015-10-16 19:18:36	Edit Download recursive recursive
config.rst	1.20 KB	lrw-r--r--	2015-10-16 19:18:36	Edit Download recursive recursive
ddl.rst	1.06 KB	lrw-r--r--	2015-10-16 19:18:36	Edit Download recursive recursive
index.rst	1013 B	lrw-r--r--	2015-10-16 19:18:36	Edit Download recursive recursive
operations.rst	6.61 KB	lrw-r--r--	2015-10-16 19:18:36	Edit Download recursive recursive
overview.rst	3.33 KB	lrw-r--r--	2015-10-16 19:18:36	Edit Download recursive recursive
runtime.rst	1.37 KB	lrw-r--r--	2015-10-16 19:18:36	Edit Download recursive recursive
script.rst	450 B	lrw-r--r--	2015-10-16 19:18:36	Edit Download recursive recursive

Directory Contents