diff options
| author | ostr00000 <ostr00000@gmail.com> | 2023-02-27 18:18:19 -0500 |
|---|---|---|
| committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2023-02-28 19:04:59 -0500 |
| commit | a55f79a109008e79f740ab40e6a9fc597785cbbe (patch) | |
| tree | 5b346c4e46767ceb0ddd732edf7d85c173542771 /docs | |
| parent | b53ec0004a08c40a25a4dbf047c51cd140971a9c (diff) | |
| download | alembic-a55f79a109008e79f740ab40e6a9fc597785cbbe.tar.gz | |
add recursive_version_locations option for searching revision files
Recursive traversal of revision files in a particular revision directory is
now supported, by indicating ``recursive_version_locations = true`` in
alembic.ini. Pull request courtesy ostr00000.
Fixes: #760
Closes: #1182
Pull-request: https://github.com/sqlalchemy/alembic/pull/1182
Pull-request-sha: ecb0da48b459abd3f5e95390ec7030a7e3fcbc6d
Change-Id: I711ca2dbd35fb9a2acdbfd374bcac13043b0d129
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/build/tutorial.rst | 10 | ||||
| -rw-r--r-- | docs/build/unreleased/760.rst | 8 |
2 files changed, 18 insertions, 0 deletions
diff --git a/docs/build/tutorial.rst b/docs/build/tutorial.rst index 8540be1..8823a91 100644 --- a/docs/build/tutorial.rst +++ b/docs/build/tutorial.rst @@ -177,6 +177,11 @@ The file generated with the "generic" configuration looks like:: # version_path_separator = space version_path_separator = os # Use os.pathsep. Default configuration used for new projects. + # set to 'true' to search source files recursively + # in each "version_locations" directory + # new in Alembic version 1.10 + # recursive_version_locations = false + # the output encoding used when revision files # are written from script.py.mako # output_encoding = utf-8 @@ -332,6 +337,11 @@ This file contains the following features: It should be defined if multiple ``version_locations`` is used. See :ref:`multiple_bases` for examples. +* ``recursive_version_locations`` - when set to 'true', revision files + are searched recursively in each "version_locations" directory. + + .. versionadded:: 1.10 + * ``output_encoding`` - the encoding to use when Alembic writes the ``script.py.mako`` file into a new migration file. Defaults to ``'utf-8'``. diff --git a/docs/build/unreleased/760.rst b/docs/build/unreleased/760.rst new file mode 100644 index 0000000..5f46e10 --- /dev/null +++ b/docs/build/unreleased/760.rst @@ -0,0 +1,8 @@ +.. change:: + :tags: feature, revisioning + :tickets: 760 + + Recursive traversal of revision files in a particular revision directory is + now supported, by indicating ``recursive_version_locations = true`` in + alembic.ini. Pull request courtesy ostr00000. + |