通用模型位于 backend/common/model.py 文件中

主键

我们未提供自动主键模式，而是必须通过手动定义的方式进行主键声明

自增 ID

# 通用 Mapped 类型主键, 需手动添加，参考以下使用方式
# MappedBase -> id: Mapped[id_key]
# DataClassBase && Base -> id: Mapped[id_key] = mapped_column(init=False)
id_key = Annotated[
    int,
    mapped_column(
        BigInteger,
        primary_key=True,
        unique=True,
        index=True,
        autoincrement=True,
        sort_order=-999,
        comment='主键 ID',
    ),
]

雪花 ID

请移步至 切换主键

Mixin 类

Mixin 是一种面向对象编程概念, 使结构变得更加清晰

操作人

用于集成操作人信息到数据库表

注意

在 fba 中，并没有默认集成操作人员信息到各个数据库表，但是我们提供了非常简易的集成方式

请移步至 操作人

日期时间

用于集成日期时间到数据库表，已集成在 Base 基类中

class DateTimeMixin(MappedAsDataclass):
    """日期时间 Mixin 数据类"""

    created_time: Mapped[datetime] = mapped_column(
        TimeZone, init=False, default_factory=timezone.now, sort_order=999, comment='创建时间'
    )
    updated_time: Mapped[datetime | None] = mapped_column(
        TimeZone, init=False, onupdate=timezone.now, sort_order=999, comment='更新时间'
    )

数据类基类

声明性数据类基类，它将带有数据类集成，允许使用更高级配置，但未集成日期时间

了解 MappedAsDataclass

class DataClassBase(MappedAsDataclass, MappedBase):

    __abstract__ = True

Base 基类

声明性数据类基类，带有数据类和日期时间集成

class Base(DataClassBase, DateTimeMixin):

    __abstract__ = True