class documentation

class CachingEntityRegistry(AbstractEntityRegistry, dict):

View In Hierarchy

Undocumented

Method __getitem__ Undocumented
Method __missing__ Undocumented
Class Variable inherit​_cache Indicate if this .HasCacheKey instance should make use of the cache key generation scheme used by its immediate superclass.

Inherited from AbstractEntityRegistry:

Method __bool__ Undocumented
Method __init__ Undocumented
Class Variable __slots__ Undocumented
Class Variable has​_entity Undocumented
Instance Variable entity Undocumented
Instance Variable is​_aliased​_class Undocumented
Instance Variable key Undocumented
Instance Variable natural​_path Undocumented
Instance Variable parent Undocumented
Instance Variable path Undocumented
Property entity​_path Undocumented
Property mapper Undocumented

Inherited from PathRegistry (via AbstractEntityRegistry):

Class Method coerce Undocumented
Class Method deserialize Undocumented
Class Method deserialize​_context​_dict Undocumented
Class Method per​_mapper Undocumented
Class Method serialize​_context​_dict Undocumented
Class Method ​_deserialize​_path Undocumented
Class Method ​_serialize​_path Undocumented
Method __add__ Undocumented
Method __eq__ Undocumented
Method __hash__ Undocumented
Method __len__ Undocumented
Method __ne__ Undocumented
Method __reduce__ Undocumented
Method __repr__ Undocumented
Method contains Undocumented
Method contains​_mapper Undocumented
Method get Undocumented
Method pairs Undocumented
Method serialize Undocumented
Method set Undocumented
Method setdefault Undocumented
Method token Undocumented
Class Variable ​_cache​_key​_traversal Undocumented
Class Variable is​_root Undocumented
Class Variable is​_token Undocumented
Property ​_path​_for​_compare Undocumented
Property length Undocumented

Inherited from HasCacheKey (via AbstractEntityRegistry, 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 ​_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 __getitem__(self, entity):
def __missing__(self, key):

Undocumented

inherit_cache: bool =

Indicate if this .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.

See Also

:ref:`compilerext_caching` - General guideslines for setting the .HasCacheKey.inherit_cache attribute for third-party or user defined SQL constructs.