diff options
| author | Mike Bayer <mike_mp@zzzcomputing.com> | 2011-11-15 00:36:56 -0500 |
|---|---|---|
| committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2011-11-15 00:36:56 -0500 |
| commit | 905632c70da9252bed652ab8fbd03160abbc041e (patch) | |
| tree | 51e6eadfe5cf79cafb5ea59dba90a872c34d52c7 /docs/build/ops.rst | |
| parent | dfba9c719f2328e8e0cd6277c362c4d780e14ef3 (diff) | |
| download | alembic-905632c70da9252bed652ab8fbd03160abbc041e.tar.gz | |
docs docs docs docs
Diffstat (limited to 'docs/build/ops.rst')
| -rw-r--r-- | docs/build/ops.rst | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/build/ops.rst b/docs/build/ops.rst index 27781a9..92338a5 100644 --- a/docs/build/ops.rst +++ b/docs/build/ops.rst @@ -6,5 +6,16 @@ Operation Reference This file provides documentation on Alembic migration directives. +The directives here are used within user-defined migration files, +within the ``upgrade()`` and ``downgrade()`` functions, as well as +any functions further invoked by those. + +The functions here all require that a :class:`.Context` has been +configured within the ``env.py`` script. Under normal circumstances +this is always the case, as the migration scripts are invoked via +the :func:`.context.run_migrations` function which ultimately +is derived from the :class:`.Context` object. + + .. automodule:: alembic.op :members: |