1# orm/__init__.py
2# Copyright (C) 2005-2024 the SQLAlchemy authors and contributors
3# <see AUTHORS file>
4#
5# This module is part of SQLAlchemy and is released under
6# the MIT License: https://www.opensource.org/licenses/mit-license.php
7
8"""
9Functional constructs for ORM configuration.
10
11See the SQLAlchemy object relational tutorial and mapper configuration
12documentation for an overview of how this module is used.
13
14"""
15
16from __future__ import annotations
17
18from typing import Any
19
20from . import exc as exc
21from . import mapper as mapperlib
22from . import strategy_options as strategy_options
23from ._orm_constructors import _mapper_fn as mapper
24from ._orm_constructors import aliased as aliased
25from ._orm_constructors import backref as backref
26from ._orm_constructors import clear_mappers as clear_mappers
27from ._orm_constructors import column_property as column_property
28from ._orm_constructors import composite as composite
29from ._orm_constructors import contains_alias as contains_alias
30from ._orm_constructors import create_session as create_session
31from ._orm_constructors import deferred as deferred
32from ._orm_constructors import dynamic_loader as dynamic_loader
33from ._orm_constructors import join as join
34from ._orm_constructors import mapped_column as mapped_column
35from ._orm_constructors import orm_insert_sentinel as orm_insert_sentinel
36from ._orm_constructors import outerjoin as outerjoin
37from ._orm_constructors import query_expression as query_expression
38from ._orm_constructors import relationship as relationship
39from ._orm_constructors import synonym as synonym
40from ._orm_constructors import with_loader_criteria as with_loader_criteria
41from ._orm_constructors import with_polymorphic as with_polymorphic
42from .attributes import AttributeEventToken as AttributeEventToken
43from .attributes import InstrumentedAttribute as InstrumentedAttribute
44from .attributes import QueryableAttribute as QueryableAttribute
45from .base import class_mapper as class_mapper
46from .base import DynamicMapped as DynamicMapped
47from .base import InspectionAttrExtensionType as InspectionAttrExtensionType
48from .base import LoaderCallableStatus as LoaderCallableStatus
49from .base import Mapped as Mapped
50from .base import NotExtension as NotExtension
51from .base import ORMDescriptor as ORMDescriptor
52from .base import PassiveFlag as PassiveFlag
53from .base import SQLORMExpression as SQLORMExpression
54from .base import WriteOnlyMapped as WriteOnlyMapped
55from .context import FromStatement as FromStatement
56from .context import QueryContext as QueryContext
57from .decl_api import add_mapped_attribute as add_mapped_attribute
58from .decl_api import as_declarative as as_declarative
59from .decl_api import declarative_base as declarative_base
60from .decl_api import declarative_mixin as declarative_mixin
61from .decl_api import DeclarativeBase as DeclarativeBase
62from .decl_api import DeclarativeBaseNoMeta as DeclarativeBaseNoMeta
63from .decl_api import DeclarativeMeta as DeclarativeMeta
64from .decl_api import declared_attr as declared_attr
65from .decl_api import has_inherited_table as has_inherited_table
66from .decl_api import MappedAsDataclass as MappedAsDataclass
67from .decl_api import registry as registry
68from .decl_api import synonym_for as synonym_for
69from .decl_base import MappedClassProtocol as MappedClassProtocol
70from .descriptor_props import Composite as Composite
71from .descriptor_props import CompositeProperty as CompositeProperty
72from .descriptor_props import Synonym as Synonym
73from .descriptor_props import SynonymProperty as SynonymProperty
74from .dynamic import AppenderQuery as AppenderQuery
75from .events import AttributeEvents as AttributeEvents
76from .events import InstanceEvents as InstanceEvents
77from .events import InstrumentationEvents as InstrumentationEvents
78from .events import MapperEvents as MapperEvents
79from .events import QueryEvents as QueryEvents
80from .events import SessionEvents as SessionEvents
81from .identity import IdentityMap as IdentityMap
82from .instrumentation import ClassManager as ClassManager
83from .interfaces import EXT_CONTINUE as EXT_CONTINUE
84from .interfaces import EXT_SKIP as EXT_SKIP
85from .interfaces import EXT_STOP as EXT_STOP
86from .interfaces import InspectionAttr as InspectionAttr
87from .interfaces import InspectionAttrInfo as InspectionAttrInfo
88from .interfaces import MANYTOMANY as MANYTOMANY
89from .interfaces import MANYTOONE as MANYTOONE
90from .interfaces import MapperProperty as MapperProperty
91from .interfaces import NO_KEY as NO_KEY
92from .interfaces import NO_VALUE as NO_VALUE
93from .interfaces import ONETOMANY as ONETOMANY
94from .interfaces import PropComparator as PropComparator
95from .interfaces import RelationshipDirection as RelationshipDirection
96from .interfaces import UserDefinedOption as UserDefinedOption
97from .loading import merge_frozen_result as merge_frozen_result
98from .loading import merge_result as merge_result
99from .mapped_collection import attribute_keyed_dict as attribute_keyed_dict
100from .mapped_collection import (
101 attribute_mapped_collection as attribute_mapped_collection,
102)
103from .mapped_collection import column_keyed_dict as column_keyed_dict
104from .mapped_collection import (
105 column_mapped_collection as column_mapped_collection,
106)
107from .mapped_collection import keyfunc_mapping as keyfunc_mapping
108from .mapped_collection import KeyFuncDict as KeyFuncDict
109from .mapped_collection import mapped_collection as mapped_collection
110from .mapped_collection import MappedCollection as MappedCollection
111from .mapper import configure_mappers as configure_mappers
112from .mapper import Mapper as Mapper
113from .mapper import reconstructor as reconstructor
114from .mapper import validates as validates
115from .properties import ColumnProperty as ColumnProperty
116from .properties import MappedColumn as MappedColumn
117from .properties import MappedSQLExpression as MappedSQLExpression
118from .query import AliasOption as AliasOption
119from .query import Query as Query
120from .relationships import foreign as foreign
121from .relationships import Relationship as Relationship
122from .relationships import RelationshipProperty as RelationshipProperty
123from .relationships import remote as remote
124from .scoping import QueryPropertyDescriptor as QueryPropertyDescriptor
125from .scoping import scoped_session as scoped_session
126from .session import close_all_sessions as close_all_sessions
127from .session import make_transient as make_transient
128from .session import make_transient_to_detached as make_transient_to_detached
129from .session import object_session as object_session
130from .session import ORMExecuteState as ORMExecuteState
131from .session import Session as Session
132from .session import sessionmaker as sessionmaker
133from .session import SessionTransaction as SessionTransaction
134from .session import SessionTransactionOrigin as SessionTransactionOrigin
135from .state import AttributeState as AttributeState
136from .state import InstanceState as InstanceState
137from .strategy_options import contains_eager as contains_eager
138from .strategy_options import defaultload as defaultload
139from .strategy_options import defer as defer
140from .strategy_options import immediateload as immediateload
141from .strategy_options import joinedload as joinedload
142from .strategy_options import lazyload as lazyload
143from .strategy_options import Load as Load
144from .strategy_options import load_only as load_only
145from .strategy_options import noload as noload
146from .strategy_options import raiseload as raiseload
147from .strategy_options import selectin_polymorphic as selectin_polymorphic
148from .strategy_options import selectinload as selectinload
149from .strategy_options import subqueryload as subqueryload
150from .strategy_options import undefer as undefer
151from .strategy_options import undefer_group as undefer_group
152from .strategy_options import with_expression as with_expression
153from .unitofwork import UOWTransaction as UOWTransaction
154from .util import Bundle as Bundle
155from .util import CascadeOptions as CascadeOptions
156from .util import LoaderCriteriaOption as LoaderCriteriaOption
157from .util import object_mapper as object_mapper
158from .util import polymorphic_union as polymorphic_union
159from .util import was_deleted as was_deleted
160from .util import with_parent as with_parent
161from .writeonly import WriteOnlyCollection as WriteOnlyCollection
162from .. import util as _sa_util
163
164
165def __go(lcls: Any) -> None:
166 _sa_util.preloaded.import_prefix("sqlalchemy.orm")
167 _sa_util.preloaded.import_prefix("sqlalchemy.ext")
168
169
170__go(locals())