class AliasOption(interfaces.LoaderOption): (source)
Undocumented
Method | __init__ |
Return a :class:`.MapperOption` that will indicate to the :class:`_query.Query` that the main table has been aliased. |
Method | process |
Apply a modification to a given :class:`.ORMCompileState`. |
Class Variable | inherit |
Indicate if this :class:`.HasCacheKey` instance should make use of the cache key generation scheme used by its immediate superclass. |
Inherited from LoaderOption
:
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
(via LoaderOption
):
Class Variable | _is |
Undocumented |
Inherited from HasCacheKey
(via LoaderOption
, CompileStateOption
):
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 LoaderOption
, 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 LoaderOption
, CompileStateOption
, HasCacheKey
, ORMOption
):
Class Variable | __visit |
Undocumented |
Method | _clone |
Create a shallow copy of this ExecutableOption. |
Inherited from HasCopyInternals
(via LoaderOption
, CompileStateOption
, HasCacheKey
, ORMOption
, ExecutableOption
):
Method | _copy |
Reassign internal elements to be clones of themselves. |
Inherited from HasTraverseInternals
(via LoaderOption
, 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 |
def __init__(self, alias:
Union[ Alias, Subquery]
):
(source)
¶
Return a :class:`.MapperOption` that will indicate to the :class:`_query.Query` that the main table has been aliased.
Apply a modification to a given :class:`.ORMCompileState`. This method is part of the implementation of a particular :class:`.CompileStateOption` and is only invoked internally when an ORM query is compiled.
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.