python - 对多个 Postgres 模式的 Alembic 支持

Question

如何使用 Alembic 的 --autogenerate 迁移 多个 在 SQL Alchemy 模型中未硬编码的 Postgres 架构？ (SQLAlchemy support of Postgres Schemas 的镜像问题，但对于 Alembic)。

特别是，我们使用 Postgres 架构来分隔共享同一组表的不同客户端。此外，在客户端之间存在一个包含共享内容的模式。 SQL Alchemy 模型不知道模式，模式是在运行时使用 session.execute("SET search_path TO client1,shared") 设置的。

默认的 --autogenerate 根本没有帮助，因为它正在检测模型中不存在的多个模式并最终删除模式并重新创建默认模式中的每个表.

不过，我真的很想使用 --autogenerate，通过适当的管道来正确设置模式。关于 Alembic 的 API 是否/如何执行此操作的任何建议？

Answer 1

来自 issue 409 ，可以最轻松地使用 translated schema names 将应用程序应用于升级/降级操作的特定租户模式，这也是您通常为 Multi-Tenancy 执行主应用程序的方式。

进入 env.py:

def run_migrations_online():

    connectable = engine_from_config(
        config.get_section(config.config_ini_section),
        prefix='sqlalchemy.',
        poolclass=pool.NullPool)

    with connectable.connect() as connection:
        for tenant_schema_name in all_my_tenant_names:
             conn = connection.execution_options(schema_translate_map={None: tenant_schema_name}

            logger.info("Migrating tenant schema %s" % tenant_schema_name)
            context.configure(
                connection=conn,
                target_metadata=target_metadata
            )

            # to do each tenant in its own transaction.
            # move this up to do all tenants in one giant transaction
            with context.begin_transaction():
                context.run_migrations()

上面会将“无”架构名称翻译成给定的租户名称。如果应用程序与具有全局表的默认模式共享基于租户的模式，那么您将使用诸如“tenant_schema”之类的标记作为符号:

for tenant_schema_name in all_my_tenant_names:
     conn = connection.execution_options(schema_translate_map={"tenant_schema": tenant_schema_name}

并且在迁移文件中引用“tenant_schema”，其中实际的特定于租户的架构名称所在:

def upgrade():
    op.alter_column("some_table", "some_column", <migration options>, schema="tenant_schema")

对于“自动生成”的情况，@nick-retallack 提供的解决方案有一些您可以为此使用的更多部分，即使用 include_schemas 以便自动生成仅查看代表最新的“样本”模式租户特定模式的版本。

为了设置 env.py 为正确的命令使用正确的系统，可以使用用户定义的选项控制行为 migration_context.get_x_argument() .