class SynonymProperty(DescriptorProperty[
Known subclasses: sqlalchemy.orm.descriptor_props.Synonym
Denote an attribute name as a synonym to a mapped property, in that the attribute will mirror the value and expression behavior of another attribute. :class:`.Synonym` is constructed using the :func:`_orm.synonym` function. .. seealso:: :ref:`synonyms` - Overview of synonyms
Method | __init__ |
Undocumented |
Method | get |
Undocumented |
Method | set |
Set the parent mapper that references this MapperProperty. |
Instance Variable | comparator |
Undocumented |
Instance Variable | descriptor |
Undocumented |
Instance Variable | doc |
optional documentation string |
Instance Variable | map |
Undocumented |
Instance Variable | name |
Undocumented |
Instance Variable | parent |
the :class:`.Mapper` managing this property. |
Property | uses |
Undocumented |
Method | _comparator |
Undocumented |
Property | _proxied |
Undocumented |
Inherited from DescriptorProperty
:
Method | instrument |
Hook called by the Mapper to the property to initiate instrumentation of the class attribute managed by this MapperProperty. |
Class Variable | _links |
True if this MapperProperty refers to a mapped entity. |
Inherited from MapperProperty
(via DescriptorProperty
):
Method | __repr__ |
Undocumented |
Method | cascade |
Iterate through instances related to the given instance for a particular 'cascade', starting with this MapperProperty. |
Method | create |
Produce row processing functions and append to the given set of populators lists. |
Method | do |
Perform subclass-specific initialization post-mapper-creation steps. |
Method | init |
Called after all mappers are created to assemble relationships between mappers and perform other post-mapper-creation initialization steps. |
Method | merge |
Merge the attribute represented by this ``MapperProperty`` from source to destination object. |
Method | post |
Perform instrumentation adjustments that need to occur after init() has completed. |
Method | setup |
Called by Query for the purposes of constructing a SQL statement. |
Class Variable | __slots__ |
Undocumented |
Class Variable | cascade |
Undocumented |
Class Variable | comparator |
The :class:`_orm.PropComparator` instance that implements SQL expression construction on behalf of this mapped attribute. |
Class Variable | info |
Info dictionary associated with the object, allowing user-defined data to be associated with this :class:`.InspectionAttr`. |
Class Variable | is |
Part of the InspectionAttr interface; states this object is a mapper property. |
Class Variable | key |
name of class attribute |
Property | class |
Return the class-bound descriptor corresponding to this :class:`.MapperProperty`. |
Method | _memoized |
Info dictionary associated with the object, allowing user-defined data to be associated with this :class:`.InspectionAttr`. |
Class Variable | _cache |
Undocumented |
Class Variable | _is |
Undocumented |
Instance Variable | _attribute |
behavioral options for ORM-enabled Python attributes |
Instance Variable | _configure |
Undocumented |
Instance Variable | _configure |
Undocumented |
Instance Variable | _has |
Undocumented |
Inherited from HasCacheKey
(via DescriptorProperty
, MapperProperty
):
Class Variable | inherit |
Indicate if this :class:`.HasCacheKey` instance should make use of the cache key generation scheme used by its immediate superclass. |
Class Method | _generate |
generate cache key dispatcher for a new class. |
Class Method | _generate |
Undocumented |
Method | _gen |
return an optional cache key. |
Method | _generate |
return a cache key. |
Class Variable | _generated |
Undocumented |
Class Variable | _hierarchy |
private attribute which may be set to False to prevent the inherit_cache warning from being emitted for a hierarchy of subclasses. |
Class Variable | _is |
Undocumented |
Inherited from TypingOnly
(via DescriptorProperty
, MapperProperty
, HasCacheKey
, _DCAttributeOptions
, _MappedAttribute
):
Method | __init |
Undocumented |
Inherited from InspectionAttr
(via DescriptorProperty
, MapperProperty
, HasCacheKey
, _DCAttributeOptions
, _MappedAttribute
, TypingOnly
, InspectionAttrInfo
):
Class Variable | is |
True if this object is an instance of :class:`.AliasedClass`. |
Class Variable | is |
True if this object is a Python :term:`descriptor`. |
Class Variable | is |
True if this object is an instance of :class:`.Bundle`. |
Class Variable | is |
True if this object is an instance of :class:`_expression.ClauseElement`. |
Class Variable | is |
True if this object is an instance of :class:`.InstanceState`. |
Class Variable | is |
True if this object is an instance of :class:`_orm.Mapper`. |
Class Variable | is |
Return True if this object is an instance of :class:`_expression.Selectable`. |
Class Variable | _is |
True if this object is an internal proxy object. |
Inherited from MemoizedSlots
(via DescriptorProperty
, MapperProperty
, HasCacheKey
, _DCAttributeOptions
, _MappedAttribute
, TypingOnly
, InspectionAttrInfo
, InspectionAttr
):
Method | __getattr__ |
Undocumented |
Method | _fallback |
Undocumented |
str
, map_column: Optional[ bool]
= None, descriptor: Optional[ Any]
= None, comparator_factory: Optional[ Type[ PropComparator[ _T]]]
= None, attribute_options: Optional[ _AttributeOptions]
= None, info: Optional[ _InfoType]
= None, doc: Optional[ str]
= None):
(source)
¶
Undocumented
InstanceState[ Any]
, dict_: _InstanceDict
, passive: PassiveFlag
= PassiveFlag.PASSIVE_OFF) -> History
:
(source)
¶
Undocumented
def set_parent(self, parent:
Mapper[ Any]
, init: bool
):
(source)
¶
Set the parent mapper that references this MapperProperty. This method is overridden by some subclasses to perform extra setup when the mapper is first known.
_proxied_object:
Union[ MapperProperty[ _T], SQLORMOperations[ _T]]
=
(source)
¶
Undocumented