Provide a relationship between two mapped classes. This corresponds to a parent-child or associative table relationship. The constructed class is an instance of :class:`.Relationship`. .. seealso:: :ref:`tutorial_orm_related_objects` - tutorial introduction to :func:`_
(
argument: Optional[_RelationshipArgumentType[Any]] = None,
secondary: Optional[_RelationshipSecondaryArgument] = None,
*,
uselist: Optional[bool] = None,
collection_class: Optional[
Union[Type[Collection[Any]], Callable[[], Collection[Any]]]
] = None,
primaryjoin: Optional[_RelationshipJoinConditionArgument] = None,
secondaryjoin: Optional[_RelationshipJoinConditionArgument] = None,
back_populates: Optional[str] = None,
order_by: _ORMOrderByArgument = False,
backref: Optional[ORMBackrefArgument] = None,
overlaps: Optional[str] = None,
post_update: bool = False,
cascade: str = "save-update, merge",
viewonly: bool = False,
init: Union[_NoArg, bool] = _NoArg.NO_ARG,
repr: Union[_NoArg, bool] = _NoArg.NO_ARG, # noqa: A002
default: Union[_NoArg, _T] = _NoArg.NO_ARG,
default_factory: Union[_NoArg, Callable[[], _T]] = _NoArg.NO_ARG,
compare: Union[_NoArg, bool] = _NoArg.NO_ARG,
kw_only: Union[_NoArg, bool] = _NoArg.NO_ARG,
hash: Union[_NoArg, bool, None] = _NoArg.NO_ARG, # noqa: A002
lazy: _LazyLoadArgumentType = "select",
passive_deletes: Union[Literal["all"], bool] = False,
passive_updates: bool = True,
active_history: bool = False,
enable_typechecks: bool = True,
foreign_keys: Optional[_ORMColCollectionArgument] = None,
remote_side: Optional[_ORMColCollectionArgument] = None,
join_depth: Optional[int] = None,
comparator_factory: Optional[
Type[RelationshipProperty.Comparator[Any]]
] = None,
single_parent: bool = False,
innerjoin: bool = False,
distinct_target_key: Optional[bool] = None,
load_on_pending: bool = False,
query_class: Optional[Type[Query[Any]]] = None,
info: Optional[_InfoType] = None,
omit_join: Literal[None, False] = None,
sync_backref: Optional[bool] = None,
dataclass_metadata: Union[_NoArg, Mapping[Any, Any], None] = _NoArg.NO_ARG,
**kw: Any,
)
| 1028 | |
| 1029 | |
| 1030 | def relationship( |
| 1031 | argument: Optional[_RelationshipArgumentType[Any]] = None, |
| 1032 | secondary: Optional[_RelationshipSecondaryArgument] = None, |
| 1033 | *, |
| 1034 | uselist: Optional[bool] = None, |
| 1035 | collection_class: Optional[ |
| 1036 | Union[Type[Collection[Any]], Callable[[], Collection[Any]]] |
| 1037 | ] = None, |
| 1038 | primaryjoin: Optional[_RelationshipJoinConditionArgument] = None, |
| 1039 | secondaryjoin: Optional[_RelationshipJoinConditionArgument] = None, |
| 1040 | back_populates: Optional[str] = None, |
| 1041 | order_by: _ORMOrderByArgument = False, |
| 1042 | backref: Optional[ORMBackrefArgument] = None, |
| 1043 | overlaps: Optional[str] = None, |
| 1044 | post_update: bool = False, |
| 1045 | cascade: str = "save-update, merge", |
| 1046 | viewonly: bool = False, |
| 1047 | init: Union[_NoArg, bool] = _NoArg.NO_ARG, |
| 1048 | repr: Union[_NoArg, bool] = _NoArg.NO_ARG, # noqa: A002 |
| 1049 | default: Union[_NoArg, _T] = _NoArg.NO_ARG, |
| 1050 | default_factory: Union[_NoArg, Callable[[], _T]] = _NoArg.NO_ARG, |
| 1051 | compare: Union[_NoArg, bool] = _NoArg.NO_ARG, |
| 1052 | kw_only: Union[_NoArg, bool] = _NoArg.NO_ARG, |
| 1053 | hash: Union[_NoArg, bool, None] = _NoArg.NO_ARG, # noqa: A002 |
| 1054 | lazy: _LazyLoadArgumentType = "select", |
| 1055 | passive_deletes: Union[Literal["all"], bool] = False, |
| 1056 | passive_updates: bool = True, |
| 1057 | active_history: bool = False, |
| 1058 | enable_typechecks: bool = True, |
| 1059 | foreign_keys: Optional[_ORMColCollectionArgument] = None, |
| 1060 | remote_side: Optional[_ORMColCollectionArgument] = None, |
| 1061 | join_depth: Optional[int] = None, |
| 1062 | comparator_factory: Optional[ |
| 1063 | Type[RelationshipProperty.Comparator[Any]] |
| 1064 | ] = None, |
| 1065 | single_parent: bool = False, |
| 1066 | innerjoin: bool = False, |
| 1067 | distinct_target_key: Optional[bool] = None, |
| 1068 | load_on_pending: bool = False, |
| 1069 | query_class: Optional[Type[Query[Any]]] = None, |
| 1070 | info: Optional[_InfoType] = None, |
| 1071 | omit_join: Literal[None, False] = None, |
| 1072 | sync_backref: Optional[bool] = None, |
| 1073 | dataclass_metadata: Union[_NoArg, Mapping[Any, Any], None] = _NoArg.NO_ARG, |
| 1074 | **kw: Any, |
| 1075 | ) -> _RelationshipDeclared[Any]: |
| 1076 | """Provide a relationship between two mapped classes. |
| 1077 | |
| 1078 | This corresponds to a parent-child or associative table relationship. |
| 1079 | The constructed class is an instance of :class:`.Relationship`. |
| 1080 | |
| 1081 | .. seealso:: |
| 1082 | |
| 1083 | :ref:`tutorial_orm_related_objects` - tutorial introduction |
| 1084 | to :func:`_orm.relationship` in the :ref:`unified_tutorial` |
| 1085 | |
| 1086 | :ref:`relationship_config_toplevel` - narrative documentation |
| 1087 |