summaryrefslogtreecommitdiffhomepage
path: root/libs/alembic/templates/multidb/README
diff options
context:
space:
mode:
Diffstat (limited to 'libs/alembic/templates/multidb/README')
-rw-r--r--libs/alembic/templates/multidb/README12
1 files changed, 12 insertions, 0 deletions
diff --git a/libs/alembic/templates/multidb/README b/libs/alembic/templates/multidb/README
new file mode 100644
index 000000000..f046ec914
--- /dev/null
+++ b/libs/alembic/templates/multidb/README
@@ -0,0 +1,12 @@
+Rudimentary multi-database configuration.
+
+Multi-DB isn't vastly different from generic. The primary difference is that it
+will run the migrations N times (depending on how many databases you have
+configured), providing one engine name and associated context for each run.
+
+That engine name will then allow the migration to restrict what runs within it to
+just the appropriate migrations for that engine. You can see this behavior within
+the mako template.
+
+In the provided configuration, you'll need to have `databases` provided in
+alembic's config, and an `sqlalchemy.url` provided for each engine name.