sqlalchemy.orm.strategy_options._AttributeStrategyLoad

class documentation

class _AttributeStrategyLoad(_LoadElement): (source)

View In Hierarchy

Loader strategies against specific relationship or column paths. e.g.:: joinedload(User.addresses) defer(Order.name) selectinload(User.orders).lazyload(Order.items)

Method __getstate__ Undocumented
Method __setstate__ Undocumented
Class Variable __slots__ Undocumented
Class Variable __visit_name__ Undocumented
Class Variable is_class_strategy Undocumented
Class Variable is_token_strategy Undocumented
Method _generate_extra_criteria Apply the current bound parameters in a QueryContext to the immediate "extra_criteria" stored with this Load object.
Method _init_path Apply ORM attributes and/or wildcard to an existing path, producing a new path.
Method _prepare_for_compile_state implemented by subclasses.
Method _set_of_type_info Undocumented
Class Variable _traverse_internals Undocumented
Instance Variable _extra_criteria Undocumented
Instance Variable _of_type Undocumented
Instance Variable _path_with_polymorphic_path Undocumented

Inherited from _LoadElement:

Class Method create Create a new :class:`._LoadElement` object.
Method __eq__ Undocumented
Method __hash__ Undocumented
Method __init__ Undocumented
Method process_compile_state populate ORMCompileState.attributes with loader state for this _LoadElement.
Class Variable local_opts Undocumented
Class Variable path Undocumented
Class Variable propagate_to_loaders Undocumented
Class Variable strategy Undocumented
Property is_opts_only 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_effective_path_for_current_path 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_path_from 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_for_no_match Undocumented
Method _recurse Undocumented
Method _update_opts Undocumented
Class Variable _cache_key_traversal Undocumented
Class Variable _reconcile_to_other Undocumented

Inherited from HasCacheKey (via _LoadElement):

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 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

Inherited from HasShallowCopy (via _LoadElement, HasCacheKey):

Class Method _generate_shallow_copy Undocumented
Class Method _generate_shallow_from_dict Undocumented
Class Method _generate_shallow_to_dict Undocumented
Method _generated_shallow_copy_traversal Undocumented
Method _generated_shallow_from_dict_traversal Undocumented
Method _generated_shallow_to_dict_traversal Undocumented
Method _shallow_copy_to Undocumented
Method _shallow_from_dict Undocumented
Method _shallow_to_dict Undocumented

Inherited from HasTraverseInternals (via _LoadElement, HasCacheKey, HasShallowCopy):

Method get_children Return immediate child :class:`.visitors.HasTraverseInternals` elements of this :class:`.visitors.HasTraverseInternals`.
Class Variable _is_immutable Undocumented

Inherited from Visitable (via _LoadElement, HasCacheKey, HasShallowCopy, HasTraverseInternals):

Method __class_getitem__ Undocumented
Method __init_subclass__ Undocumented
Class Method _generate_compiler_dispatch Undocumented
Method _compiler_dispatch Undocumented
Class Variable _original_compiler_dispatch Undocumented
def __getstate__(self): (source)
overrides sqlalchemy.orm.strategy_options._LoadElement.__getstate__

Undocumented

def __setstate__(self, state): (source)
overrides sqlalchemy.orm.strategy_options._LoadElement.__setstate__

Undocumented

__slots__: tuple[str, ...] = (source)
overrides sqlalchemy.orm.strategy_options._LoadElement.__slots__

Undocumented

__visit_name__: str = (source)
overrides sqlalchemy.orm.strategy_options._LoadElement.__visit_name__

Undocumented

is_class_strategy: bool = (source)
overrides sqlalchemy.orm.strategy_options._LoadElement.is_class_strategy

Undocumented

is_token_strategy: bool = (source)
overrides sqlalchemy.orm.strategy_options._LoadElement.is_token_strategy

Undocumented

def _generate_extra_criteria(self, context): (source)

Apply the current bound parameters in a QueryContext to the immediate "extra_criteria" stored with this Load object. Load objects are typically pulled from the cached version of the statement from a QueryContext. The statement currently being executed will have new values (and keys) for bound parameters in the extra criteria which need to be applied by loader strategies when they handle this criteria for a result set.

def _init_path(self, path, attr, wildcard_key, attr_group, raiseerr): (source)
overrides sqlalchemy.orm.strategy_options._LoadElement._init_path

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.

def _prepare_for_compile_state(self, parent_loader, compile_state, mapper_entities, reconciled_lead_entity, raiseerr): (source)
overrides sqlalchemy.orm.strategy_options._LoadElement._prepare_for_compile_state

implemented by subclasses.

def _set_of_type_info(self, context, current_path): (source)

Undocumented

_traverse_internals = (source)
overrides sqlalchemy.orm.strategy_options._LoadElement._traverse_internals

Undocumented

_extra_criteria = (source)
overrides sqlalchemy.orm.strategy_options._LoadElement._extra_criteria

Undocumented

_of_type = (source)

Undocumented

_path_with_polymorphic_path = (source)

Undocumented