summaryrefslogtreecommitdiff
path: root/doc/build/orm/queryguide/_inheritance_setup.rst
blob: e429b179f25b008c69bae76a51e597400a94f683 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
:orphan:

============================================
Setup for ORM Queryguide: Joined Inheritance
============================================

This page illustrates the mappings and fixture data used by the
:ref:`joined_inheritance` examples in the :doc:`inheritance` document of
the :ref:`queryguide_toplevel`.

..  sourcecode:: python


    >>> from typing import List
    >>> from sqlalchemy import create_engine
    >>> from sqlalchemy import ForeignKey
    >>> from sqlalchemy.orm import DeclarativeBase
    >>> from sqlalchemy.orm import Mapped
    >>> from sqlalchemy.orm import mapped_column
    >>> from sqlalchemy.orm import relationship
    >>> from sqlalchemy.orm import Session
    >>>
    >>>
    >>> class Base(DeclarativeBase):
    ...     pass
    >>> class Company(Base):
    ...     __tablename__ = "company"
    ...     id: Mapped[int] = mapped_column(primary_key=True)
    ...     name: Mapped[str]
    ...     employees: Mapped[List["Employee"]] = relationship(back_populates="company")
    >>>
    >>> class Employee(Base):
    ...     __tablename__ = "employee"
    ...     id: Mapped[int] = mapped_column(primary_key=True)
    ...     name: Mapped[str]
    ...     type: Mapped[str]
    ...     company_id: Mapped[int] = mapped_column(ForeignKey("company.id"))
    ...     company: Mapped[Company] = relationship(back_populates="employees")
    ...
    ...     def __repr__(self):
    ...         return f"{self.__class__.__name__}({self.name!r})"
    ...
    ...     __mapper_args__ = {
    ...         "polymorphic_identity": "employee",
    ...         "polymorphic_on": "type",
    ...     }
    >>>
    >>> class Manager(Employee):
    ...     __tablename__ = "manager"
    ...     id: Mapped[int] = mapped_column(ForeignKey("employee.id"), primary_key=True)
    ...     manager_name: Mapped[str]
    ...     paperwork: Mapped[List["Paperwork"]] = relationship()
    ...     __mapper_args__ = {
    ...         "polymorphic_identity": "manager",
    ...     }
    >>> class Paperwork(Base):
    ...     __tablename__ = "paperwork"
    ...     id: Mapped[int] = mapped_column(primary_key=True)
    ...     manager_id: Mapped[int] = mapped_column(ForeignKey("manager.id"))
    ...     document_name: Mapped[str]
    ...
    ...     def __repr__(self):
    ...         return f"Paperwork({self.document_name!r})"
    >>>
    >>> class Engineer(Employee):
    ...     __tablename__ = "engineer"
    ...     id: Mapped[int] = mapped_column(ForeignKey("employee.id"), primary_key=True)
    ...     engineer_info: Mapped[str]
    ...     __mapper_args__ = {
    ...         "polymorphic_identity": "engineer",
    ...     }
    >>>
    >>> engine = create_engine("sqlite://", echo=True)
    >>>
    >>> Base.metadata.create_all(engine)
    BEGIN ...

    >>> conn = engine.connect()
    >>> from sqlalchemy.orm import Session
    >>> session = Session(conn)
    >>> session.add(
    ...     Company(
    ...         name="Krusty Krab",
    ...         employees=[
    ...             Manager(
    ...                 name="Mr. Krabs",
    ...                 manager_name="Eugene H. Krabs",
    ...                 paperwork=[
    ...                     Paperwork(document_name="Secret Recipes"),
    ...                     Paperwork(document_name="Krabby Patty Orders"),
    ...                 ],
    ...             ),
    ...             Engineer(name="SpongeBob", engineer_info="Krabby Patty Master"),
    ...             Engineer(
    ...                 name="Squidward",
    ...                 engineer_info="Senior Customer Engagement Engineer",
    ...             ),
    ...         ],
    ...     )
    ... )
    >>> session.commit()
    BEGIN ...