sqlalchemy.orm.path_registry.PropRegistry

class documentation

class PropRegistry(PathRegistry): (source)

View In Hierarchy

Undocumented

Method __init__ Undocumented
Class Variable __slots__ Undocumented
Class Variable inherit_cache Indicate if this :class:`.HasCacheKey` instance should make use of the cache key generation scheme used by its immediate superclass.
Class Variable is_property Undocumented
Instance Variable entity Undocumented
Instance Variable has_entity Undocumented
Instance Variable is_unnatural Undocumented
Instance Variable mapper Undocumented
Instance Variable natural_path Undocumented
Instance Variable parent Undocumented
Instance Variable path Undocumented
Instance Variable prop Undocumented
Property entity_path Undocumented
Method _getitem Undocumented
Method _truncate_recursive Undocumented
Instance Variable _default_path_loader_key Undocumented
Instance Variable _loader_key Undocumented
Instance Variable _wildcard_path_loader_key Undocumented

Inherited from PathRegistry:

Class Method coerce Undocumented
Class Method deserialize Undocumented
Class Method per_mapper Undocumented
Method __add__ Undocumented
Method __eq__ Undocumented
Method __getitem__ Undocumented
Method __hash__ Undocumented
Method __len__ Undocumented
Method __ne__ Undocumented
Method __reduce__ Undocumented
Method __repr__ Undocumented
Method __str__ Undocumented
Method contains Undocumented
Method contains_mapper Undocumented
Method get Undocumented
Method pairs Undocumented
Method serialize Undocumented
Method set Undocumented
Method setdefault Undocumented
Class Variable is_entity Undocumented
Class Variable is_root Undocumented
Class Variable is_token Undocumented
Class Variable root Undocumented
Property length Undocumented
Class Method _deserialize_path Undocumented
Class Method _serialize_path Undocumented
Class Variable _cache_key_traversal Undocumented
Property _path_for_compare Undocumented

Inherited from HasCacheKey (via PathRegistry):

Class Method _generate_cache_attrs generate cache key dispatcher for a new class.
Class Method _generate_cache_key_for_object Undocumented
Method _gen_cache_key return an optional cache key.
Method _generate_cache_key return a cache key.
Class Variable _generated_cache_key_traversal Undocumented
Class Variable _hierarchy_supports_caching 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_has_cache_key Undocumented
def __init__(self, parent: AbstractEntityRegistry, prop: MapperProperty[Any]): (source)

Undocumented

__slots__: tuple[str, ...] = (source)
overrides sqlalchemy.orm.path_registry.PathRegistry.__slots__

Undocumented

inherit_cache: bool = (source)
overrides sqlalchemy.sql.cache_key.HasCacheKey.inherit_cache

Indicate if this :class:`.HasCacheKey` instance should make use of the cache key generation scheme used by its immediate superclass. The attribute defaults to ``None``, which indicates that a construct has not yet taken into account whether or not its appropriate for it to participate in caching; this is functionally equivalent to setting the value to ``False``, except that a warning is also emitted. This flag can be set to ``True`` on a particular class, if the SQL that corresponds to the object does not change based on attributes which are local to this class, and not its superclass. .. seealso:: :ref:`compilerext_caching` - General guideslines for setting the :attr:`.HasCacheKey.inherit_cache` attribute for third-party or user defined SQL constructs.

is_property: bool = (source)
overrides sqlalchemy.orm.path_registry.PathRegistry.is_property

Undocumented

entity = (source)

Undocumented

has_entity = (source)
overrides sqlalchemy.orm.path_registry.PathRegistry.has_entity

Undocumented

is_unnatural: bool = (source)

Undocumented

mapper = (source)

Undocumented

natural_path = (source)
overrides sqlalchemy.orm.path_registry.PathRegistry.natural_path

Undocumented

parent = (source)
overrides sqlalchemy.orm.path_registry.PathRegistry.parent

Undocumented

path = (source)
overrides sqlalchemy.orm.path_registry.PathRegistry.path

Undocumented

prop = (source)

Undocumented

@property
entity_path: AbstractEntityRegistry = (source)

Undocumented

def _getitem(self, entity: Union[int, slice, _InternalEntityType[Any]]) -> Union[AbstractEntityRegistry, _PathElementType, _PathRepresentation]: (source)

Undocumented

def _truncate_recursive(self) -> PropRegistry: (source)

Undocumented

_default_path_loader_key = (source)

Undocumented

_loader_key = (source)

Undocumented

_wildcard_path_loader_key = (source)

Undocumented