如何在SQLAlchemy声明式风格中控制数据库表的Schema？

在SQLAlchemy 2.0的声明式风格中，有几种方式可以控制表创建到指定的PostgreSQL Schema，而非默认的public：

方法1：为单个表指定Schema #

直接在对应的数据模型类中通过__table_args__参数指定目标Schema：

from sqlalchemy import Integer, String
from sqlalchemy.orm import DeclarativeBase
from sqlalchemy.orm import mapped_column


class Base(DeclarativeBase):
    pass


class User(Base):
    __tablename__ = "user"
    # 指定表所属的Schema
    __table_args__ = {"schema": "my_custom_schema"}

    id = mapped_column(Integer, primary_key=True)
    name = mapped_column(String(50), nullable=False)
    fullname = mapped_column(String)
    nickname = mapped_column(String(30))

方法2：为所有表设置默认Schema #

如果所有继承自Base的表都需要放到同一个Schema，可以在Base类的元数据中统一配置默认Schema：

from sqlalchemy import MetaData
from sqlalchemy.orm import DeclarativeBase

# 初始化元数据时指定默认Schema
class Base(DeclarativeBase):
    metadata = MetaData(schema="my_custom_schema")


# 后续定义的表默认都使用该Schema
class User(Base):
    __tablename__ = "user"
    id = mapped_column(Integer, primary_key=True)
    # ... 其他字段省略

如果个别表需要使用不同的Schema，只需在该表类中添加__table_args__覆盖即可。

注意事项 #

• 确保Schema已存在：PostgreSQL不会自动创建不存在的Schema，运行代码前需要先创建目标Schema，可通过以下方式实现：

  • 直接执行SQL：CREATE SCHEMA IF NOT EXISTS my_custom_schema;
  • 使用SQLAlchemy API创建：

    from sqlalchemy import create_engine
    
    engine = create_engine(db_url)
    with engine.connect() as conn:
        conn.execute("CREATE SCHEMA IF NOT EXISTS my_custom_schema;")
        conn.commit()
    

• 创建表的代码无需额外修改：无论使用哪种方式，原有的表创建代码Base.metadata.create_all(engine)都可以正常工作，SQLAlchemy会自动将表创建到指定的Schema中。

内容的提问来源于stack exchange，提问作者user2138149