Multi schema postgres migrations using alembic
Project description
alembic-multischema
This module provides the ability to act on multiple postgres schemas at once when using alembic.
Functions:
perSchema(**kwargs)
Used to decorate the upgrade() and downgrade() functions in a migration. When upgrade or downgrade are decorated with perSchema() the decorated function will be called for a list of schemas in the current database.
kwargs:
- schemas A list of schema names to run the function against. If omitted perSchema() will automatically generate a list of non-system schemas from the current database by using getAllNonSystemSchemas()
- exclude A list of schema names to exclude from running the function against
getAllSchemas()
Returns a list of all schemas in the current database.
kwargs:
- exclude A list of schema names to exclude from running the function against
getAllNonSystemSchemas()
Returns a list of schemas in the current database, omitting information_schema and pg_catalog.
kwargs:
- exclude A list of schema names to exclude from running the function against
Example Usage:
"""CreateUsersTable
Revision ID: a6a219646b55
Revises:
Create Date: 2019-10-16 14:43:11.347575
"""
from alembic import op
import sqlalchemy as sa
from sqlalchemy.sql import text
from almebic_multischema import perSchema
# revision identifiers, used by Alembic.
revision = 'a6a219646b55'
down_revision = None
branch_labels = None
depends_on = None
@perSchema(schemas=["public", "foo", "bar"])
def upgrade():
users = text(
"""CREATE TABLE users
(
id serial PRIMARY KEY,
firstname VARCHAR (50) UNIQUE,
lastname VARCHAR (50)
);
""")
op.execute(users)
@perSchema(schemas=["public", "foo", "bar"])
def downgrade():
op.execute(text("DROP TABLE users"))
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
File details
Details for the file alembic_multischema-0.0.7-py2.py3-none-any.whl
.
File metadata
- Download URL: alembic_multischema-0.0.7-py2.py3-none-any.whl
- Upload date:
- Size: 6.8 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.8.0 tqdm/4.36.1 CPython/2.7.16
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9ebfb586cf3e2787f371c669395ce221136f744d39a31f8fa1f84b49bc95a19f |
|
MD5 | 694067edf6420804084f214ac2df9be5 |
|
BLAKE2b-256 | 508cf61a98a9fe8889dd54b16cbfdc1c62cd8801c5936009cea51fee0baec426 |