sqlalchemy.orm.path_registry.RootRegistry

class documentation

class RootRegistry(CreatesToken): (source)

View In Hierarchy

Root registry, defers to mappers so that paths are maintained per-root-mapper.

Class Variable __slots__ Undocumented
Class Variable has_entity 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_aliased_class Undocumented
Class Variable is_root Undocumented
Class Variable is_unnatural Undocumented
Class Variable natural_path Undocumented
Class Variable path Undocumented
Method _getitem Undocumented
Method _truncate_recursive Undocumented

Inherited from CreatesToken:

Method token Undocumented

Inherited from PathRegistry (via CreatesToken):

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_property Undocumented
Class Variable is_token Undocumented
Class Variable parent 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 CreatesToken, 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
__slots__: tuple = (source)
overrides sqlalchemy.orm.path_registry.CreatesToken.__slots__

Undocumented

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

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_aliased_class: bool = (source)
overrides sqlalchemy.orm.path_registry.CreatesToken.is_aliased_class

Undocumented

is_root: bool = (source)
overrides sqlalchemy.orm.path_registry.CreatesToken.is_root

Undocumented

is_unnatural: bool = (source)

Undocumented

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

Undocumented

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

Undocumented

def _getitem(self, entity: Any) -> Union[TokenRegistry, AbstractEntityRegistry]: (source)

Undocumented

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

Undocumented