class LoaderOption(CompileStateOption): (source)
Known subclasses: sqlalchemy.orm.query.AliasOption
, sqlalchemy.orm.strategy_options._AbstractLoad
Describe a loader modification to an ORM statement at compilation time. .. versionadded:: 1.4
Method | process |
Apply a modification to a given :class:`.ORMCompileState`, given entities that were replaced by with_only_columns() or with_entities(). |
Class Variable | __slots__ |
Undocumented |
Inherited from CompileStateOption
:
Method | process |
Apply a modification to a given :class:`.ORMCompileState`. |
Class Variable | _is |
Undocumented |
Inherited from HasCacheKey
(via CompileStateOption
):
Class Variable | inherit |
Indicate if this :class:`.HasCacheKey` instance should make use of the cache key generation scheme used by its immediate superclass. |
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 ORMOption
(via CompileStateOption
, HasCacheKey
):
Class Variable | propagate |
if True, indicate this option should be carried along to "secondary" SELECT statements that occur for relationship lazy loaders as well as attribute load / refresh operations. |
Method | _adapt |
adapt this option to the "uncached" version of itself in a loader strategy context. |
Class Variable | _is |
Undocumented |
Class Variable | _is |
Undocumented |
Class Variable | _is |
Undocumented |
Class Variable | _is |
Undocumented |
Class Variable | _is |
Undocumented |
Inherited from ExecutableOption
(via CompileStateOption
, HasCacheKey
, ORMOption
):
Class Variable | __visit |
Undocumented |
Method | _clone |
Create a shallow copy of this ExecutableOption. |
Inherited from HasCopyInternals
(via CompileStateOption
, HasCacheKey
, ORMOption
, ExecutableOption
):
Method | _copy |
Reassign internal elements to be clones of themselves. |
Inherited from HasTraverseInternals
(via CompileStateOption
, HasCacheKey
, ORMOption
, ExecutableOption
, HasCopyInternals
):
Method | get |
Return immediate child :class:`.visitors.HasTraverseInternals` elements of this :class:`.visitors.HasTraverseInternals`. |
Class Variable | _is |
Undocumented |
Class Variable | _traverse |
Undocumented |
ORMCompileState
, mapper_entities: Sequence[ _MapperEntity]
):
(source)
¶
sqlalchemy.orm.strategy_options._AbstractLoad
Apply a modification to a given :class:`.ORMCompileState`, given entities that were replaced by with_only_columns() or with_entities(). This method is part of the implementation of a particular :class:`.CompileStateOption` and is only invoked internally when an ORM query is compiled. .. versionadded:: 1.4.19