diff options
| author | Mike Bayer <mike_mp@zzzcomputing.com> | 2022-02-04 11:51:30 -0500 |
|---|---|---|
| committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2022-02-04 11:53:10 -0500 |
| commit | 7b942708427f89a277e9e55ac538103717094da3 (patch) | |
| tree | be82ce8f78f8cf5fa4ce7f6483ab940cc395f99c /docs/build/tutorial.rst | |
| parent | 32dc8a49cfd560c3291f00acaddf317d0264fed3 (diff) | |
| download | alembic-7b942708427f89a277e9e55ac538103717094da3.tar.gz | |
clarify default configuration behavior
alembic does not by default read other sections
besides ``[alembic]``, however the generated ``env.py``
file by default contains instructions to also read logging
directives. clarify that if the configuration file is
customized to not have logging directives, env.py also
needs to be customized.
Change-Id: I4804ce54b78b68c2d72ba4bcc7c1ecaf93a09103
Fixes: #985
Diffstat (limited to 'docs/build/tutorial.rst')
| -rw-r--r-- | docs/build/tutorial.rst | 17 |
1 files changed, 13 insertions, 4 deletions
diff --git a/docs/build/tutorial.rst b/docs/build/tutorial.rst index fffd074..83b31ec 100644 --- a/docs/build/tutorial.rst +++ b/docs/build/tutorial.rst @@ -235,10 +235,19 @@ with the path to the Alembic script location. This file contains the following features: -* ``[alembic]`` - this is the section read by Alembic to determine configuration. Alembic - itself does not directly read any other areas of the file. The name "alembic" can - be customized using the ``--name`` commandline flag; see :ref:`multiple_environments` - for a basic example of this. +* ``[alembic]`` - this is the section read by Alembic to determine configuration. Alembic's + core implementation does not directly read any other areas of the file, not + including additional directives that may be consumed from the + end-user-customizable ``env.py`` file (see note below). The name "alembic" + can be customized using the ``--name`` commandline flag; see + :ref:`multiple_environments` for a basic example of this. + + .. note:: The default ``env.py`` file included with Alembic's environment + templates will also read from the logging sections ``[logging]``, + ``[handlers]`` etc. If the configuration file in use does not contain + logging directives, please remove the ``fileConfig()`` directive within + the generated ``env.py`` file to prevent it from attempting to configure + logging. * ``script_location`` - this is the location of the Alembic environment. It is normally specified as a filesystem location, either relative or absolute. If the location is |