Classe « Mapper »

Informations générales

Héritage

                    builtins.object
                        Generic
                    builtins.object
                        EventTarget
                builtins.object
                    Generic
                        Inspectable
                    builtins.object
                        Identified
                    builtins.object
                        InspectionAttr
                builtins.object
                    HasMemoized
                builtins.object
                    HasCacheKey
                        MemoizedHasCacheKey
        builtins.object
            SQLRole
        builtins.object
            Generic
                TypedColumnsClauseRole
    builtins.object
        SQLRole
            ColumnListRole
        builtins.object
            UsesInspection
        builtins.object
            AllowsLambdaRole
                ColumnsClauseRole
                    ORMColumnsClauseRole
                        ORMEntityColumnsClauseRole
builtins.object
    SQLRole
        StructuralRole
    builtins.object
        UsesInspection
    builtins.object
        AllowsLambdaRole
            JoinTargetRole
builtins.object
    SQLRole
        ColumnListRole
    builtins.object
        UsesInspection
    builtins.object
        AllowsLambdaRole
            ColumnsClauseRole
                FromClauseRole
                    StrictFromClauseRole
                        ORMFromClauseRole
                            Mapper

Définition

class Mapper(ORMFromClauseRole, ORMEntityColumnsClauseRole, MemoizedHasCacheKey, InspectionAttr, Identified, Inspectable, EventTarget, Generic):

help(Mapper)

Defines an association between a Python class and a database table or
other relational structure, so that ORM operations against the class may
proceed.

The :class:`_orm.Mapper` object is instantiated using mapping methods
present on the :class:`_orm.registry` object.  For information
about instantiating new :class:`_orm.Mapper` objects, see
:ref:`orm_mapping_classes_toplevel`.

Constructeur(s)

Signature du constructeur	Description
__init__(self, class_: 'Type[_O]', local_table: 'Optional[FromClause]' = None, properties: 'Optional[Mapping[str, MapperProperty[Any]]]' = None, primary_key: 'Optional[Iterable[_ORMColumnExprArgument[Any]]]' = None, non_primary: 'bool' = False, inherits: 'Optional[Union[Mapper[Any], Type[Any]]]' = None, inherit_condition: 'Optional[_ColumnExpressionArgument[bool]]' = None, inherit_foreign_keys: 'Optional[Sequence[_ORMColumnExprArgument[Any]]]' = None, always_refresh: 'bool' = False, version_id_col: 'Optional[_ORMColumnExprArgument[Any]]' = None, version_id_generator: 'Optional[Union[Literal[False], Callable[[Any], Any]]]' = None, polymorphic_on: 'Optional[Union[_ORMColumnExprArgument[Any], str, MapperProperty[Any]]]' = None, _polymorphic_map: 'Optional[Dict[Any, Mapper[Any]]]' = None, polymorphic_identity: 'Optional[Any]' = None, concrete: 'bool' = False, with_polymorphic: 'Optional[_WithPolymorphicArg]' = None, polymorphic_abstract: 'bool' = False, polymorphic_load: "Optional[Literal['selectin', 'inline']]" = None, allow_partial_pks: 'bool' = True, batch: 'bool' = True, column_prefix: 'Optional[str]' = None, include_properties: 'Optional[Sequence[str]]' = None, exclude_properties: 'Optional[Sequence[str]]' = None, passive_updates: 'bool' = True, passive_deletes: 'bool' = False, confirm_deleted_rows: 'bool' = True, eager_defaults: "Literal[True, False, 'auto']" = 'auto', legacy_is_orphan: 'bool' = False, _compiled_cache_size: 'int' = 100)	Direct constructor for a new :class:`_orm.Mapper` object. _{[extrait de __init__.__doc__]}

__init__(self, class_: 'Type[_O]', local_table: 'Optional[FromClause]' = None, properties: 'Optional[Mapping[str, MapperProperty[Any]]]' = None, primary_key: 'Optional[Iterable[_ORMColumnExprArgument[Any]]]' = None, non_primary: 'bool' = False, inherits: 'Optional[Union[Mapper[Any], Type[Any]]]' = None, inherit_condition: 'Optional[_ColumnExpressionArgument[bool]]' = None, inherit_foreign_keys: 'Optional[Sequence[_ORMColumnExprArgument[Any]]]' = None, always_refresh: 'bool' = False, version_id_col: 'Optional[_ORMColumnExprArgument[Any]]' = None, version_id_generator: 'Optional[Union[Literal[False], Callable[[Any], Any]]]' = None, polymorphic_on: 'Optional[Union[_ORMColumnExprArgument[Any], str, MapperProperty[Any]]]' = None, _polymorphic_map: 'Optional[Dict[Any, Mapper[Any]]]' = None, polymorphic_identity: 'Optional[Any]' = None, concrete: 'bool' = False, with_polymorphic: 'Optional[_WithPolymorphicArg]' = None, polymorphic_abstract: 'bool' = False, polymorphic_load: "Optional[Literal['selectin', 'inline']]" = None, allow_partial_pks: 'bool' = True, batch: 'bool' = True, column_prefix: 'Optional[str]' = None, include_properties: 'Optional[Sequence[str]]' = None, exclude_properties: 'Optional[Sequence[str]]' = None, passive_updates: 'bool' = True, passive_deletes: 'bool' = False, confirm_deleted_rows: 'bool' = True, eager_defaults: "Literal[True, False, 'auto']" = 'auto', legacy_is_orphan: 'bool' = False, _compiled_cache_size: 'int' = 100)

Direct constructor for a new :class:`_orm.Mapper` object. _{[extrait de __init__.__doc__]}

Liste des attributs statiques

Nom de l'attribut	Valeur
all_orm_descriptors
allows_lambda
attrs
column_attrs
composites
configured
dispatch
extension_type
inherit_cache
is_aliased_class
is_attribute
is_bundle
is_clause_element
is_instance
is_mapper
is_property
is_selectable
logger
logging_name
mapped_table
relationships
represents_outer_join
select_identity_token
self_and_descendants
synonyms
uses_inspection
with_polymorphic_mappers

Liste des propriétés

Nom de la propriété	Description
entity	Part of the inspection API. _{[extrait de entity.__doc__]}
entity_namespace
iterate_properties	return an iterator of all MapperProperty objects. _{[extrait de iterate_properties.__doc__]}
mapper	Part of the inspection API. _{[extrait de mapper.__doc__]}
primary_base_mapper
selectable	The :class:`_schema.FromClause` construct this _{[extrait de selectable.__doc__]}

Liste des opérateurs

Opérateurs hérités de la classe object

__eq__, __ge__, __gt__, __le__, __lt__, __ne__

Liste des méthodes

Toutes les méthodes Méthodes d'instance Méthodes statiques

Signature de la méthode	Description
__class_getitem__	Parameterizes a generic class. _{[extrait de __class_getitem__.__doc__]}
__clause_element__(self)
__repr__(self) -> 'str'
__str__(self) -> 'str'
add_properties(self, dict_of_properties)	Add the given dictionary of properties to this mapper, _{[extrait de add_properties.__doc__]}
add_property(self, key: 'str', prop: 'Union[Column[Any], MapperProperty[Any]]') -> 'None'	Add an individual MapperProperty to this mapper. _{[extrait de add_property.__doc__]}
cascade_iterator(self, type_: 'str', state: 'InstanceState[_O]', halt_on: 'Optional[Callable[[InstanceState[Any]], bool]]' = None) -> 'Iterator[Tuple[object, Mapper[Any], InstanceState[Any], _InstanceDict]]'	Iterate each element and its mapper in an object graph, _{[extrait de cascade_iterator.__doc__]}
common_parent(self, other: 'Mapper[Any]') -> 'bool'	Return true if the given mapper shares a _{[extrait de common_parent.__doc__]}
get_property(self, key: 'str', _configure_mappers: 'bool' = False) -> 'MapperProperty[Any]'	return a MapperProperty associated with the given key. _{[extrait de get_property.__doc__]}
get_property_by_column(self, column: 'ColumnElement[_T]') -> 'MapperProperty[_T]'	Given a :class:`_schema.Column` object, return the _{[extrait de get_property_by_column.__doc__]}
has_property(self, key: 'str') -> 'bool'
identity_key_from_instance(self, instance: '_O') -> '_IdentityKeyType[_O]'	Return the identity key for the given instance, based on _{[extrait de identity_key_from_instance.__doc__]}
identity_key_from_primary_key(self, primary_key: 'Tuple[Any, ...]', identity_token: 'Optional[Any]' = None) -> '_IdentityKeyType[_O]'	Return an identity-map key for use in storing/retrieving an _{[extrait de identity_key_from_primary_key.__doc__]}
identity_key_from_row(self, row: 'Optional[Union[Row[Any], RowMapping]]', identity_token: 'Optional[Any]' = None, adapter: 'Optional[ORMAdapter]' = None) -> '_IdentityKeyType[_O]'	Return an identity-map key for use in storing/retrieving an _{[extrait de identity_key_from_row.__doc__]}
is_sibling(self, other: 'Mapper[Any]') -> 'bool'	return true if the other mapper is an inheriting sibling to this _{[extrait de is_sibling.__doc__]}
isa(self, other: 'Mapper[Any]') -> 'bool'	Return True if the this mapper inherits from the given mapper. _{[extrait de isa.__doc__]}
iterate_to_root(self) -> 'Iterator[Mapper[Any]]'
polymorphic_iterator(self) -> 'Iterator[Mapper[Any]]'	Iterate through the collection including this mapper and _{[extrait de polymorphic_iterator.__doc__]}
primary_key_from_instance(self, instance: '_O') -> 'Tuple[Any, ...]'	Return the list of primary key values for the given _{[extrait de primary_key_from_instance.__doc__]}
primary_mapper(self) -> 'Mapper[Any]'	Return the primary mapper corresponding to this mapper's class key _{[extrait de primary_mapper.__doc__]}