class documentation

class ExtendedInternalTraversal(InternalTraversal):

Known subclasses: sqlalchemy.sql.traversals._CacheKey

View In Hierarchy

Defines additional symbols that are useful in caching applications.

Traversals for _expression.ClauseElement objects only need to use those symbols present in .InternalTraversal. However, for additional caching use cases within the ORM, symbols dealing with the .HasCacheKey class are added here.

Class Variable dp​_has​_cache​_key​_tuples Visit a list of tuples which contain .HasCacheKey objects.
Class Variable dp​_ignore Specify an object that should be ignored entirely.
Class Variable dp​_inspectable Visit an inspectable object where the return value is a .HasCacheKey object.
Class Variable dp​_inspectable​_list Visit a list of inspectable objects which upon inspection are HasCacheKey objects.
Class Variable dp​_multi Visit an object that may be a .HasCacheKey or may be a plain hashable object.
Class Variable dp​_multi​_list Visit a tuple containing elements that may be .HasCacheKey or may be a plain hashable object.

Inherited from InternalTraversal:

Method dispatch Given a method from .InternalTraversal, return the corresponding method on a subclass.
Class Variable dp​_annotations​_key Visit the _annotations_cache_key element.
Class Variable dp​_anon​_name Visit a potentially "anonymized" string value.
Class Variable dp​_boolean Visit a boolean value.
Class Variable dp​_clauseelement Visit a _expression.ClauseElement object.
Class Variable dp​_clauseelement​_list Visit a list of _expression.ClauseElement objects.
Class Variable dp​_clauseelement​_tuple Visit a tuple of _expression.ClauseElement objects.
Class Variable dp​_clauseelement​_tuples Visit a list of tuples which contain _expression.ClauseElement objects.
Class Variable dp​_dialect​_options Visit a dialect options structure.
Class Variable dp​_dml​_multi​_values Visit the values() multi-valued list of dictionaries of an _expression.Insert object.
Class Variable dp​_dml​_ordered​_values Visit the values() ordered tuple list of an _expression.Update object.
Class Variable dp​_dml​_values Visit the values() dictionary of a .ValuesBase (e.g. Insert or Update) object.
Class Variable dp​_fromclause​_canonical​_column​_collection Visit a _expression.FromClause object in the context of the columns attribute.
Class Variable dp​_fromclause​_ordered​_set Visit an ordered set of _expression.FromClause objects.
Class Variable dp​_has​_cache​_key Visit a .HasCacheKey object.
Class Variable dp​_has​_cache​_key​_list Visit a list of .HasCacheKey objects.
Class Variable dp​_named​_ddl​_element Visit a simple named DDL element.
Class Variable dp​_operator Visit an operator.
Class Variable dp​_plain​_dict Visit a dictionary with string keys.
Class Variable dp​_plain​_obj Visit a plain python object.
Class Variable dp​_prefix​_sequence Visit the sequence represented by _expression.HasPrefixes or _expression.HasSuffixes.
Class Variable dp​_propagate​_attrs Visit the propagate attrs dict. This hardcodes to the particular elements we care about right now.
Class Variable dp​_statement​_hint​_list Visit the _statement_hints collection of a _expression.Select object.
Class Variable dp​_string Visit a plain string value.
Class Variable dp​_string​_clauseelement​_dict Visit a dictionary of string keys to _expression.ClauseElement objects.
Class Variable dp​_string​_list Visit a list of strings.
Class Variable dp​_string​_multi​_dict Visit a dictionary of string keys to values which may either be plain immutable/hashable or .HasCacheKey objects.
Class Variable dp​_table​_hint​_list Visit the _hints collection of a _expression.Select object.
Class Variable dp​_type Visit a .TypeEngine object
Class Variable dp​_unknown​_structure Visit an unknown structure.
Method generate​_dispatch Undocumented
Method run​_generated​_dispatch Undocumented
Class Variable dp​_executable​_options Undocumented
Class Variable dp​_memoized​_select​_entities Undocumented
Class Variable dp​_setup​_join​_tuple Undocumented
Class Variable dp​_with​_context​_options Undocumented
dp_has_cache_key_tuples =
Visit a list of tuples which contain .HasCacheKey objects.
dp_ignore =

Specify an object that should be ignored entirely.

This currently applies function call argument caching where some arguments should not be considered to be part of a cache key.

dp_inspectable =
Visit an inspectable object where the return value is a .HasCacheKey object.
dp_inspectable_list =
Visit a list of inspectable objects which upon inspection are HasCacheKey objects.
dp_multi =
Visit an object that may be a .HasCacheKey or may be a plain hashable object.
dp_multi_list =
Visit a tuple containing elements that may be .HasCacheKey or may be a plain hashable object.