sqlalchemy.orm.query.AliasOption

class documentation

class AliasOption(interfaces.LoaderOption):

Undocumented

Method	`__init__`	Return a `.MapperOption` that will indicate to the `_query.Query` that the main table has been aliased.
Method	`process_compile_state`	Apply a modification to a given `.CompileState`.
Class Variable	`inherit_cache`	Indicate if this `.HasCacheKey` instance should make use of the cache key generation scheme used by its immediate superclass.

Inherited from LoaderOption:

Method process_compile_state_replaced_entities Apply a modification to a given .CompileState, given entities that were replaced by with_only_columns() or with_entities().

Inherited from CompileStateOption (via LoaderOption):

Class Variable _is_compile_state Undocumented

Inherited from HasCacheKey (via LoaderOption, CompileStateOption):

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	`__slots__`	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 ORMOption (via LoaderOption, CompileStateOption):

Class Variable	`__slots__`	Undocumented
Class Variable	`_is_criteria_option`	Undocumented
Class Variable	`_is_legacy_option`	Undocumented
Class Variable	`_is_strategy_option`	Undocumented
Class Variable	`propagate_to_loaders`	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.

Inherited from ExecutableOption (via LoaderOption, CompileStateOption, ORMOption):

Method	`_clone`	Create a shallow copy of this ExecutableOption.
Class Variable	`__visit_name__`	Undocumented
Class Variable	`_is_has_cache_key`	Undocumented

Inherited from HasCopyInternals (via LoaderOption, CompileStateOption, ORMOption, ExecutableOption):

Method _copy_internals Reassign internal elements to be clones of themselves.

@util.deprecated('1.4', 'The :class:`.AliasOption` is not necessary for entities to be matched up to a query that is established via :meth:`.Query.from_statement` and now does nothing.')
def __init__(self, alias):

Return a .MapperOption that will indicate to the _query.Query that the main table has been aliased.

def process_compile_state(self, compile_state):

overrides sqlalchemy.orm.interfaces.LoaderOption.process_compile_state

Apply a modification to a given .CompileState.

inherit_cache: bool =

overrides sqlalchemy.sql.traversals.HasCacheKey.inherit_cache

Indicate if this .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.