ORM Mapped Class Konfiguration

Detaillierte Referenz für die ORM-Konfiguration, ohne Beziehungen, die unter Relationship Configuration detailliert sind.

Für einen schnellen Überblick über eine typische ORM-Konfiguration, beginnen Sie mit ORM Quick Start.

Für eine Einführung in das Konzept des objektrelationalen Mappings, wie es in SQLAlchemy implementiert ist, wird es zuerst im SQLAlchemy Unified Tutorial unter Using ORM Declarative Forms to Define Table Metadata vorgestellt.

• Übersicht über ORM-gemappte Klassen
  • ORM Mapping Stile
    • Deklarative Zuordnung
    • Imperative Zuordnung
  • Wesentliche Komponenten der Mapped Class
    • Die abzubildende Klasse
    • Die Tabelle oder ein anderes FROM-Klausel-Objekt
    • Das Eigenschaften-Dictionary
    • Andere Mapper-Konfigurationsparameter
  • Verhalten der Mapped Class
    • Standardkonstruktor
    • Beibehaltung von nicht gemapptem Zustand über Ladevorgänge hinweg
    • Laufende Introspektion von Mapped Classes, Instanzen und Mappern
      • Inspektion von Mapper-Objekten
      • Inspektion zugeordneter Instanzen
• Klassen mit Deklarativität zuordnen
  • Deklarative Mapping-Stile
    • Verwendung einer deklarativen Basisklasse
    • Deklaratives Mapping mit einem Dekorator (keine deklarative Basis)
  • Tabellenkonfiguration mit Deklarativ
    • Deklarative Tabelle mit mapped_column()
      • Verwendung von annotierter deklarativer Tabelle (typspezifische annotierte Formen für mapped_column())
      • Zugriff auf Tabelle und Metadaten
      • Deklarative Tabellenkonfiguration
      • Expliziter Schemaname mit deklarativer Tabelle
      • Festlegen von Lade- und Persistenzoptionen für deklarativ zugeordnete Spalten
      • Explizites Benennen von deklarativ zugeordnete Spalten
      • Anhängen zusätzlicher Spalten an eine bestehende deklarativ gemappte Klasse
    • Deklarativ mit imperativer Tabelle (a.k.a. Hybride Deklarativ)
      • Alternative Attributnamen für die Zuordnung von Tabellenspalten
      • Anwenden von Lade-, Persistenz- und Zuordnungsoptionen für imperative Tabellenspalten
    • Deklarative Zuordnung mit gespiegelten Tabellen
      • Verwendung von DeferredReflection
      • Verwendung von Automap
      • Automatisierung von Spaltenbenennungsschemata aus gespiegelten Tabellen
      • Zuordnung zu einem expliziten Satz von Primärschlüsselspalten
      • Zuordnung einer Teilmenge von Tabellenspalten
  • Mapper-Konfiguration mit Deklarativ
    • Definition von Mapped Properties mit Deklarativ
    • Mapper-Konfigurationsoptionen mit Deklarativ
      • Dynamisches Erstellen von Mapper-Argumenten
    • Andere Deklarative Mapping-Direktiven
      • __declare_last__()
      • __declare_first__()
      • metadata
      • __abstract__
      • __table_cls__
  • Zusammensetzen von gemappten Hierarchien mit Mixins
    • Erweiterung der Basis
    • Mischen von Spalten
    • Mischen von Beziehungen
    • Mischen von _orm.column_property() und anderen _orm.MapperProperty Klassen
    • Verwendung von Mixins und Basisklassen mit Mapped Inheritance Mustern
      • Verwendung von _orm.declared_attr() mit vererbenden Table und Mapper Argumenten
      • Verwendung von _orm.declared_attr() zur Generierung tabellenspezifischer, vererbender Spalten
    • Kombination von Tabellen-/Mapper-Argumenten aus mehreren Mixins
    • Erstellung von Indizes und Constraints mit Benennungskonventionen bei Mixins
• Integration mit dataclasses und attrs
  • Deklaratives Dataclass Mapping
    • Konfiguration von Klassenmerkmalen
    • Attributkonfiguration
      • Spaltendefaults
      • Integration mit Annotated
    • Verwendung von Mixins und abstrakten Oberklassen
    • Beziehungskonfiguration
    • Verwendung von Nicht-Mapped Dataclass Feldern
    • Integration mit alternativen Dataclass-Anbietern wie Pydantic
  • Anwenden von ORM-Mappings auf eine bestehende Dataclass (Legacy-Dataclass-Verwendung)
    • Mapping von vorbestehenden Dataclasses mit Deklarativ und Imperativ Table
    • Mapping von vorbestehenden Dataclasses mit deklarativen Feldern
      • Verwendung von Deklarativen Mixins mit vorbestehenden Dataclasses
    • Mapping von vorbestehenden Dataclasses mit imperativen Mapping
  • Anwenden von ORM-Mappings auf eine bestehende attrs-Klasse
    • Mapping von attrs mit deklarativem „Imperativ Table“
    • Mapping von attrs mit imperativen Mapping
• SQL-Ausdrücke als gemappte Attribute
  • Verwendung eines Hybrids
  • Verwendung von column_property
    • Hinzufügen von column_property() zu einer bestehenden deklarativ abgebildeten Klasse
    • Zusammensetzung aus Spalteneigenschaften zur Zuordnungszeit
    • Verwendung von Spaltenverzögerung mit column_property()
  • Verwendung eines einfachen Deskriptors
  • SQL-Ausdrücke zur Abfragezeit als gemappte Attribute
• Ändern des Attributverhaltens
  • Einfache Validatoren
    • validates()
  • Verwendung von benutzerdefinierten Datentypen auf Core-Ebene
  • Verwendung von Deskriptoren und Hybriden
  • Synonyme
    • synonym()
  • Operatoranpassung
• Zusammengesetzte Spaltentypen
  • Arbeiten mit Mapped Composite Column Types
  • Andere Mapping-Formen für Composites
    • Spalten direkt mappen, dann an Composite übergeben
    • Spalten direkt mappen, Attributnamen an Composite übergeben
    • Imperatives Mapping und imperative Tabelle
  • Verwendung von Legacy Nicht-Dataclasses
  • Verfolgung von In-Place-Mutationen bei Composites
  • Neudefinition von Vergleichsoperationen für Composites
  • Verschachtelte Composites
  • Composite API
    • composite()
• Abbildung von Klassenhierarchien
  • Joined Table Inheritance
    • Beziehungen mit Joined Inheritance
    • Laden von Joined Inheritance Mappings
  • Single Table Inheritance
    • Auflösung von Spaltenkonflikten mit use_existing_column
    • Beziehungen mit Single Table Inheritance
    • Erstellen tieferer Hierarchien mit polymorphic_abstract
    • Laden von Single Inheritance Mappings
  • Concrete Table Inheritance
    • Konfiguration des Concrete Polymorphic Ladens
    • Abstrakte Concrete Klassen
    • Klassische und semi-klassische Concrete Polymorphic Konfiguration
    • Beziehungen mit Concrete Inheritance
    • Laden von Concrete Inheritance Mappings
• Nicht-traditionelle Zuordnungen
  • Mapping einer Klasse gegen mehrere Tabellen
  • Abbilden einer Klasse gegen beliebige Subqueries
  • Mehrere Mapper für eine Klasse
• Konfigurieren eines Versionszählers
  • Einfache Versionszählung
  • Benutzerdefinierte Versionszähler / Typen
  • Serverseitige Versionszähler
  • Programmatische oder bedingte Versionszähler
• Klassen-Mapping-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