diff options
| author | Chris Dary <umbrae@gmail.com> | 2021-09-24 15:47:08 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-09-24 15:47:08 -0400 |
| commit | d95e15cac59dc449f712f51183462a8688a51086 (patch) | |
| tree | a45940df32f7e9a4252abc618eff3f0b97812502 /alembic/templates | |
| parent | e96e5fa151dac59e287a20c738e877d9c9a504bf (diff) | |
| download | alembic-d95e15cac59dc449f712f51183462a8688a51086.tar.gz | |
MultiDB README: Add a bit more detail
Diffstat (limited to 'alembic/templates')
| -rw-r--r-- | alembic/templates/multidb/README | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/alembic/templates/multidb/README b/alembic/templates/multidb/README index 5db219f..f046ec9 100644 --- a/alembic/templates/multidb/README +++ b/alembic/templates/multidb/README @@ -1 +1,12 @@ -Rudimentary multi-database configuration.
\ No newline at end of file +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. |