ORM Mapped Class Configuration¶
Detailed reference for ORM configuration, not including relationships, which are detailed at Relationship Configuration.
For a quick look at a typical ORM configuration, start with ORM Quick Start.
For an introduction to the concept of object relational mapping as implemented in SQLAlchemy, it’s first introduced in the SQLAlchemy 1.4 / 2.0 Tutorial at Defining Table Metadata with the ORM.
- ORM Mapped Class Overview
- Mapping Classes with Declarative
- Declarative Mapping Styles
- Table Configuration with Declarative
- Mapper Configuration with Declarative
- Composing Mapped Hierarchies with Mixins
- Augmenting the Base
- Mixing in Columns
- Mixing in Relationships
- Mixing in deferred(), column_property(), and other MapperProperty classes
- Controlling table inheritance with mixins
- Mixing in Columns in Inheritance Scenarios
- Combining Table/Mapper Arguments from Multiple Mixins
- Creating Indexes with Mixins
- Integration with dataclasses and attrs
- Mapping Columns and Expressions
- Mapping Class Inheritance Hierarchies
- Non-Traditional Mappings
- Configuring a Version Counter
- Class Mapping API
registrydeclarative_base()declarative_mixin()as_declarative()declared_attrhas_inherited_table()synonym_for()mapper()object_mapper()class_mapper()configure_mappers()clear_mappers()identity_key()polymorphic_union()reconstructor()MapperMapper.__init__()Mapper.add_properties()Mapper.add_property()Mapper.all_orm_descriptorsMapper.attrsMapper.base_mapperMapper.cMapper.cascade_iterator()Mapper.class_Mapper.class_managerMapper.column_attrsMapper.columnsMapper.common_parent()Mapper.compositesMapper.concreteMapper.configuredMapper.entityMapper.get_property()Mapper.get_property_by_column()Mapper.identity_key_from_instance()Mapper.identity_key_from_primary_key()Mapper.identity_key_from_row()Mapper.inheritsMapper.is_mapperMapper.is_sibling()Mapper.isa()Mapper.iterate_propertiesMapper.local_tableMapper.mapped_tableMapper.mapperMapper.non_primaryMapper.persist_selectableMapper.polymorphic_identityMapper.polymorphic_iterator()Mapper.polymorphic_mapMapper.polymorphic_onMapper.primary_keyMapper.primary_key_from_instance()Mapper.primary_mapper()Mapper.relationshipsMapper.selectableMapper.self_and_descendantsMapper.singleMapper.synonymsMapper.tablesMapper.validatorsMapper.with_polymorphic_mappers