ORM 映射类配置

ORM 配置的详细参考，不包括关系，关系详情请参阅 关系配置。

快速查看典型的 ORM 配置，请从 ORM 快速入门 开始。

对于 SQLAlchemy 中实现的对象关系映射概念的介绍，首次在 SQLAlchemy 统一教程 的 使用 ORM 声明式形式定义表元数据 中介绍。

• ORM 映射类概述
  • ORM 映射风格
    • 声明式映射
    • 命令式映射
  • 映射类的基本组件
    • 要映射的类
    • 表，或其他 from 子句对象
    • 属性字典
    • 其他映射器配置参数
  • 映射类行为
    • 默认构造函数
    • 在加载时维护非映射状态
    • 映射类、实例和映射器的运行时自省
      • 检查映射器对象
      • 检查映射实例
• 使用声明式映射类
  • 声明式映射风格
    • 使用声明式基类
    • 使用装饰器的声明式映射（无声明式基类）
  • 使用声明式配置表
    • 使用 mapped_column() 的声明式表
      • 使用注解声明式表（mapped_column() 的类型注解形式）
      • 访问表和元数据
      • 声明式表配置
      • 使用声明式表显式架构名称
      • 为声明式映射列设置加载和持久化选项
      • 显式命名声明式映射列
      • 将其他列附加到现有的声明式映射类
    • 声明式与命令式表（又名混合声明式）
      • 用于映射表列的备用属性名称
      • 为命令式表列应用加载、持久化和映射选项
    • 使用反射表声明式映射
      • 使用 DeferredReflection
      • 使用 Automap
      • 从反射表自动化列命名方案
      • 映射到显式主键列集
      • 映射表列的子集
  • 使用声明式配置映射器
    • 使用声明式定义映射属性
    • 使用声明式的映射器配置选项
      • 动态构造映射器参数
    • 其他声明式映射指令
      • __declare_last__()
      • __declare_first__()
      • metadata
      • __abstract__
      • __table_cls__
  • 使用 Mixin 组合映射层次结构
    • 扩充基类
    • 混入列
    • 混入关系
    • 混入 _orm.column_property() 和其他 _orm.MapperProperty 类
    • 将 Mixin 和基类与映射继承模式一起使用
      • 将 _orm.declared_attr() 与继承的 Table 和 Mapper 参数一起使用
      • 使用 _orm.declared_attr() 生成特定于表的继承列
    • 从多个 Mixin 组合 Table/Mapper 参数
    • 使用 Mixin 上的命名约定创建索引和约束
• 与 dataclasses 和 attrs 集成
  • 声明式 Dataclass 映射
    • 类级别功能配置
    • 属性配置
      • 列默认值
      • 与 Annotated 集成
    • 使用 mixin 和抽象超类
    • 关系配置
    • 使用非映射 Dataclass 字段
    • 与备用 Dataclass 提供程序（如 Pydantic）集成
  • 将 ORM 映射应用于现有 dataclass（旧式 dataclass 用法）
    • 使用声明式与命令式表映射预先存在的 dataclass
    • 使用声明式风格字段映射预先存在的 dataclass
      • 将声明式 Mixin 与预先存在的 dataclass 一起使用
    • 使用命令式映射映射预先存在的 dataclass
  • 将 ORM 映射应用于现有 attrs 类
    • 使用声明式“命令式表”映射 attrs
    • 使用命令式映射映射 attrs
• SQL 表达式作为映射属性
  • 使用 Hybrid
  • 使用 column_property
    • 将 column_property() 添加到现有的声明式映射类
    • 在映射时从列属性组合
    • 将列延迟与 column_property() 一起使用
  • 使用普通描述符
  • 查询时 SQL 表达式作为映射属性
• 更改属性行为
  • 简单验证器
    • validates()
  • 在核心级别使用自定义数据类型
  • 使用描述符和 Hybrid
  • 同义词
    • synonym()
  • 运算符自定义
• 组合列类型
  • 使用映射的组合列类型
  • 复合对象的其他映射形式
    • 直接映射列，然后传递给复合对象
    • 直接映射列，将属性名称传递给复合对象
    • 命令式映射和命令式表
  • 使用旧式非 Dataclass
  • 跟踪复合对象的就地突变
  • 重新定义复合对象的比较操作
  • 嵌套复合对象
  • 复合 API
    • composite()
• 映射类继承层次结构
  • 连接表继承
    • 与连接表继承的关系
    • 加载连接表继承映射
  • 单表继承
    • 使用 use_existing_column 解决列冲突
    • 与单表继承的关系
    • 使用 polymorphic_abstract 构建更深层次的层次结构
    • 加载单表继承映射
  • 具体表继承
    • 具体多态加载配置
    • 抽象具体类
    • 经典和半经典具体多态配置
    • 与具体表继承的关系
    • 加载具体表继承映射
• 非传统映射
  • 将类映射到多个表
  • 将类映射到任意子查询
  • 一个类的多个映射器
• 配置版本计数器
  • 简单版本计数
  • 自定义版本计数器/类型
  • 服务器端版本计数器
  • 程序化或条件版本计数器
• 类映射 API
  • registry
    • registry.__init__()
    • registry.as_declarative_base()
    • registry.configure()
    • registry.dispose()
    • registry.generate_base()
    • registry.map_declaratively()
    • registry.map_imperatively()
    • registry.mapped()
    • registry.mapped_as_dataclass()
    • registry.mappers
    • registry.update_type_annotation_map()
  • add_mapped_attribute()
  • column_property()
  • declarative_base()
  • declarative_mixin()
  • as_declarative()
  • mapped_column()
  • declared_attr
    • declared_attr.cascading
    • declared_attr.directive
  • DeclarativeBase
    • DeclarativeBase.__mapper__
    • DeclarativeBase.__mapper_args__
    • DeclarativeBase.__table__
    • DeclarativeBase.__table_args__
    • DeclarativeBase.__tablename__
    • DeclarativeBase.metadata
    • DeclarativeBase.registry
  • DeclarativeBaseNoMeta
    • DeclarativeBaseNoMeta.__mapper__
    • DeclarativeBaseNoMeta.__mapper_args__
    • DeclarativeBaseNoMeta.__table__
    • DeclarativeBaseNoMeta.__table_args__
    • DeclarativeBaseNoMeta.__tablename__
    • DeclarativeBaseNoMeta.metadata
    • DeclarativeBaseNoMeta.registry
  • has_inherited_table()
  • synonym_for()
  • object_mapper()
  • class_mapper()
  • configure_mappers()
  • clear_mappers()
  • identity_key()
  • polymorphic_union()
  • orm_insert_sentinel()
  • reconstructor()
  • Mapper
    • Mapper.__init__()
    • Mapper.add_properties()
    • Mapper.add_property()
    • Mapper.all_orm_descriptors
    • Mapper.attrs
    • Mapper.base_mapper
    • Mapper.c
    • Mapper.cascade_iterator()
    • Mapper.class_
    • Mapper.class_manager
    • Mapper.column_attrs
    • Mapper.columns
    • Mapper.common_parent()
    • Mapper.composites
    • Mapper.concrete
    • Mapper.configured
    • Mapper.entity
    • Mapper.get_property()
    • Mapper.get_property_by_column()
    • Mapper.identity_key_from_instance()
    • Mapper.identity_key_from_primary_key()
    • Mapper.identity_key_from_row()
    • Mapper.inherits
    • Mapper.is_mapper
    • Mapper.is_sibling()
    • Mapper.isa()
    • Mapper.iterate_properties
    • Mapper.local_table
    • Mapper.mapped_table
    • Mapper.mapper
    • Mapper.non_primary
    • Mapper.persist_selectable
    • Mapper.polymorphic_identity
    • Mapper.polymorphic_iterator()
    • Mapper.polymorphic_map
    • Mapper.polymorphic_on
    • Mapper.primary_key
    • Mapper.primary_key_from_instance()
    • Mapper.primary_mapper()
    • Mapper.relationships
    • Mapper.selectable
    • Mapper.self_and_descendants
    • Mapper.single
    • Mapper.synonyms
    • Mapper.tables
    • Mapper.validators
    • Mapper.with_polymorphic_mappers
  • MappedAsDataclass
  • MappedClassProtocol