class _TokenStrategyLoad(_LoadElement): (source)
Loader strategies against wildcard attributes e.g.:: raiseload('*') Load(User).lazyload('*') defer('*') load_only(User.name, User.email) # will create a defer('*') joinedload(User.addresses).raiseload('*')
Class Variable | __visit |
Undocumented |
Class Variable | inherit |
Indicate if this :class:`.HasCacheKey` instance should make use of the cache key generation scheme used by its immediate superclass. |
Class Variable | is |
Undocumented |
Class Variable | is |
Undocumented |
Method | _init |
Apply ORM attributes and/or wildcard to an existing path, producing a new path. |
Method | _prepare |
implemented by subclasses. |
Inherited from _LoadElement
:
Class Method | create |
Create a new :class:`._LoadElement` object. |
Method | __eq__ |
Undocumented |
Method | __getstate__ |
Undocumented |
Method | __hash__ |
Undocumented |
Method | __init__ |
Undocumented |
Method | __setstate__ |
Undocumented |
Method | process |
populate ORMCompileState.attributes with loader state for this _LoadElement. |
Class Variable | __slots__ |
Undocumented |
Class Variable | local |
Undocumented |
Class Variable | path |
Undocumented |
Class Variable | propagate |
Undocumented |
Class Variable | strategy |
Undocumented |
Property | is |
Undocumented |
Static Method | _reconcile |
define behavior for when two Load objects are to be put into the context.attributes under the same key. |
Method | _adjust |
receives the 'current_path' entry from an :class:`.ORMCompileState` instance, which is set during lazy loads and secondary loader strategy loads, and adjusts the given path to be relative to the current_path. |
Method | _clone |
Create a shallow copy |
Method | _prepend |
adjust the path of this :class:`._LoadElement` to be a subpath of that of the given parent :class:`_orm.Load` object's path. |
Method | _raise |
Undocumented |
Method | _recurse |
Undocumented |
Method | _update |
Undocumented |
Class Variable | _cache |
Undocumented |
Class Variable | _extra |
Undocumented |
Class Variable | _reconcile |
Undocumented |
Class Variable | _traverse |
Undocumented |
Inherited from HasCacheKey
(via _LoadElement
):
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 HasShallowCopy
(via _LoadElement
, HasCacheKey
):
Class Method | _generate |
Undocumented |
Class Method | _generate |
Undocumented |
Class Method | _generate |
Undocumented |
Method | _generated |
Undocumented |
Method | _generated |
Undocumented |
Method | _generated |
Undocumented |
Method | _shallow |
Undocumented |
Method | _shallow |
Undocumented |
Method | _shallow |
Undocumented |
Inherited from HasTraverseInternals
(via _LoadElement
, HasCacheKey
, HasShallowCopy
):
Method | get |
Return immediate child :class:`.visitors.HasTraverseInternals` elements of this :class:`.visitors.HasTraverseInternals`. |
Class Variable | _is |
Undocumented |
Inherited from Visitable
(via _LoadElement
, HasCacheKey
, HasShallowCopy
, HasTraverseInternals
):
Method | __class |
Undocumented |
Method | __init |
Undocumented |
Class Method | _generate |
Undocumented |
Method | _compiler |
Undocumented |
Class Variable | _original |
Undocumented |
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.
Apply ORM attributes and/or wildcard to an existing path, producing a new path. This method is used within the :meth:`.create` method to initialize a :class:`._LoadElement` object.