Mapping Classes with Declarative

The Declarative mapping style is the primary style of mapping that is used with SQLAlchemy. See the section Declarative Mapping for the top level introduction.

• Declarative Mapping Styles
  • Using a Declarative Base Class
  • Declarative Mapping using a Decorator (no declarative base)
• Table Configuration with Declarative
  • Declarative Table with mapped_column()
    • Using Annotated Declarative Table (Type Annotated Forms for mapped_column())
    • Accessing Table and Metadata
    • Declarative Table Configuration
    • Explicit Schema Name with Declarative Table
    • Setting Load and Persistence Options for Declarative Mapped Columns
    • Naming Declarative Mapped Columns Explicitly
    • Appending additional columns to an existing Declarative mapped class
  • Declarative with Imperative Table (a.k.a. Hybrid Declarative)
    • Alternate Attribute Names for Mapping Table Columns
    • Applying Load, Persistence and Mapping Options for Imperative Table Columns
  • Mapping Declaratively with Reflected Tables
    • Using DeferredReflection
    • Using Automap
    • Automating Column Naming Schemes from Reflected Tables
    • Mapping to an Explicit Set of Primary Key Columns
    • Mapping a Subset of Table Columns
• Mapper Configuration with Declarative
  • Defining Mapped Properties with Declarative
  • Mapper Configuration Options with Declarative
    • Constructing mapper arguments dynamically
  • Other Declarative Mapping Directives
    • __declare_last__()
    • __declare_first__()
    • metadata
    • __abstract__
    • __table_cls__
• Composing Mapped Hierarchies with Mixins
  • Augmenting the Base
  • Mixing in Columns
  • Mixing in Relationships
  • Mixing in _orm.column_property() and other _orm.MapperProperty classes
  • Using Mixins and Base Classes with Mapped Inheritance Patterns
    • Using _orm.declared_attr() with inheriting Table and Mapper arguments
    • Using _orm.declared_attr() to generate table-specific inheriting columns
  • Combining Table/Mapper Arguments from Multiple Mixins
  • Creating Indexes and Constraints with Naming Conventions on Mixins