summaryrefslogtreecommitdiff
path: root/docs/build/branches.rst
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2017-01-23 14:24:31 -0500
committerMike Bayer <mike_mp@zzzcomputing.com>2017-01-23 14:24:31 -0500
commita4302416a66253f03013528701c17f251835ef8a (patch)
tree9f128143aeff3b83828a1f8190195de4b43eccdf /docs/build/branches.rst
parent376837484acc80a6cbc1cda9125935c05a94ee0f (diff)
downloadalembic-a4302416a66253f03013528701c17f251835ef8a.tar.gz
- add a new section "Run Multiple Alembic Environments from one .ini file",
clarify what the --name flag does and how this differs from "multiple bases". Change-Id: If65a8a11802db18bc2f42ffea360c70cbc9113bb
Diffstat (limited to 'docs/build/branches.rst')
-rw-r--r--docs/build/branches.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/build/branches.rst b/docs/build/branches.rst
index acc0789..e69db1b 100644
--- a/docs/build/branches.rst
+++ b/docs/build/branches.rst
@@ -509,6 +509,13 @@ before the head::
Working with Multiple Bases
---------------------------
+.. note:: The multiple base feature is intended to allow for multiple Alembic
+ versioning lineages which **share the same alembic_version table**. This is
+ so that individual revisions within the lineages can have cross-dependencies
+ on each other. For the simpler case where one project has multiple,
+ **completely independent** revision lineages that refer to **separate**
+ alembic_version tables, see the example in :ref:`multiple_environments`.
+
We've seen in the previous section that ``alembic upgrade`` is fine
if we have multiple heads, ``alembic revision`` allows us to tell it which
"head" we'd like to associate our new revision file with, and branch labels