sqlalchemy.orm.util.AliasedInsp

class documentation

class AliasedInsp(ORMEntityColumnsClauseRole, ORMFromClauseRole, sql_base.MemoizedHasCacheKey, InspectionAttr):

Provide an inspection interface for an .AliasedClass object.

The .AliasedInsp object is returned given an .AliasedClass using the _sa.inspect function:

from sqlalchemy import inspect
from sqlalchemy.orm import aliased

my_alias = aliased(MyMappedClass)
insp = inspect(my_alias)

Attributes on .AliasedInsp include:

entity - the .AliasedClass represented.
mapper - the _orm.Mapper mapping the underlying class.
selectable - the _expression.Alias construct which ultimately represents an aliased _schema.Table or _expression.Select construct.
name - the name of the alias. Also is used as the attribute name when returned in a result tuple from _query.Query.
with_polymorphic_mappers - collection of _orm.Mapper objects indicating all those mappers expressed in the select construct for the .AliasedClass.
polymorphic_on - an alternate column or SQL expression which will be used as the "discriminator" for a polymorphic load.

See Also

:ref:`inspection_toplevel`

Method	`__clause_element__`	Undocumented
Method	`__getstate__`	Undocumented
Method	`__init__`	Undocumented
Method	`__repr__`	Undocumented
Method	`__setstate__`	Undocumented
Method	`__str__`	Undocumented
Method	`_adapt_element`	Undocumented
Method	`_entity_for_mapper`	Undocumented
Method	`_memo`	Undocumented
Class Variable	`_cache_key_traversal`	Undocumented
Class Variable	`is_aliased_class`	always returns True
Instance Variable	`_adapt_on_names`	Undocumented
Instance Variable	`_adapter`	Undocumented
Instance Variable	`_base_alias`	Undocumented
Instance Variable	`_is_with_polymorphic`	Undocumented
Instance Variable	`_nest_adapters`	Undocumented
Instance Variable	`_target`	Undocumented
Instance Variable	`_use_mapper_path`	Undocumented
Instance Variable	`_weak_entity`	Undocumented
Instance Variable	`_with_polymorphic_entities`	Undocumented
Instance Variable	`local_table`	Undocumented
Instance Variable	`mapper`	Undocumented
Instance Variable	`name`	Undocumented
Instance Variable	`persist_selectable`	Undocumented
Instance Variable	`polymorphic_on`	Undocumented
Instance Variable	`represents_outer_join`	Undocumented
Instance Variable	`selectable`	Undocumented
Instance Variable	`with_polymorphic_mappers`	Undocumented
Property	`_all_column_expressions`	Undocumented
Property	`_get_clause`	Undocumented
Property	`_memoized_values`	Undocumented
Property	`_path_registry`	Undocumented
Property	`class_`	Return the mapped class ultimately represented by this `.AliasedInsp`.
Property	`entity`	Undocumented
Property	`entity_namespace`	Undocumented

Inherited from ORMEntityColumnsClauseRole:

Class Variable _role_name Undocumented

Inherited from ColumnsClauseRole (via ORMEntityColumnsClauseRole, ORMColumnsClauseRole):

Property _select_iterable Undocumented

Inherited from AllowsLambdaRole (via ORMEntityColumnsClauseRole, ORMColumnsClauseRole, ColumnsClauseRole):

Class Variable allows_lambda Undocumented

Inherited from UsesInspection (via ORMEntityColumnsClauseRole, ORMColumnsClauseRole, ColumnsClauseRole):

Class Variable	`_post_inspect`	Undocumented
Class Variable	`uses_inspection`	Undocumented

Inherited from SQLRole (via ORMEntityColumnsClauseRole, ORMColumnsClauseRole, ColumnsClauseRole, ColumnListRole):

Class Variable	`allows_lambda`	Undocumented
Class Variable	`uses_inspection`	Undocumented

Inherited from ORMFromClauseRole:

Class Variable _role_name Undocumented

Inherited from StrictFromClauseRole (via ORMFromClauseRole):

Property description Undocumented

Inherited from FromClauseRole (via ORMFromClauseRole, StrictFromClauseRole):

Class Variable	`_is_subquery`	Undocumented
Property	`_hide_froms`	Undocumented

Inherited from ColumnsClauseRole (via ORMFromClauseRole, StrictFromClauseRole, FromClauseRole):

Property _select_iterable Undocumented

Inherited from AllowsLambdaRole (via ORMFromClauseRole, StrictFromClauseRole, FromClauseRole, ColumnsClauseRole):

Class Variable allows_lambda Undocumented

Inherited from UsesInspection (via ORMFromClauseRole, StrictFromClauseRole, FromClauseRole, ColumnsClauseRole):

Class Variable	`_post_inspect`	Undocumented
Class Variable	`uses_inspection`	Undocumented

Inherited from SQLRole (via ORMFromClauseRole, StrictFromClauseRole, FromClauseRole, ColumnsClauseRole, ColumnListRole):

Class Variable	`allows_lambda`	Undocumented
Class Variable	`uses_inspection`	Undocumented

Inherited from AllowsLambdaRole (via ORMFromClauseRole, StrictFromClauseRole, FromClauseRole, JoinTargetRole):

Class Variable allows_lambda Undocumented

Inherited from UsesInspection (via ORMFromClauseRole, StrictFromClauseRole, FromClauseRole, JoinTargetRole):

Class Variable	`_post_inspect`	Undocumented
Class Variable	`uses_inspection`	Undocumented

Inherited from SQLRole (via ORMFromClauseRole, StrictFromClauseRole, FromClauseRole, JoinTargetRole, StructuralRole):

Class Variable	`allows_lambda`	Undocumented
Class Variable	`uses_inspection`	Undocumented

Inherited from MemoizedHasCacheKey:

Method _generate_cache_key return a cache key.

Inherited from HasCacheKey (via MemoizedHasCacheKey):

Class Variable	`inherit_cache`	Indicate if this `.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.
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 InspectionAttr:

Class Variable	`__slots__`	Undocumented
Class Variable	`_is_internal_proxy`	True if this object is an internal proxy object.
Class Variable	`is_attribute`	True if this object is a Python :term:`descriptor`.
Class Variable	`is_bundle`	True if this object is an instance of `.Bundle`.
Class Variable	`is_clause_element`	True if this object is an instance of `_expression.ClauseElement`.
Class Variable	`is_instance`	True if this object is an instance of `.InstanceState`.
Class Variable	`is_mapper`	True if this object is an instance of `_orm.Mapper`.
Class Variable	`is_property`	True if this object is an instance of `.MapperProperty`.
Class Variable	`is_selectable`	Return True if this object is an instance of `_expression.Selectable`.

@util.memoized_instancemethod
def __clause_element__(self):

Undocumented

def __getstate__(self):

Undocumented

def __init__(self, entity, inspected, selectable, name, with_polymorphic_mappers, polymorphic_on, _base_alias, _use_mapper_path, adapt_on_names, represents_outer_join, nest_adapters):

Undocumented

def __repr__(self):

Undocumented

def __setstate__(self, state):

Undocumented

def __str__(self):

Undocumented

def _adapt_element(self, elem, key=None):

Undocumented

def _entity_for_mapper(self, mapper):

Undocumented

def _memo(self, key, callable_, *args, **kw):

Undocumented

_cache_key_traversal =

Undocumented

is_aliased_class: bool =

overrides sqlalchemy.orm.base.InspectionAttr.is_aliased_class

always returns True

_adapt_on_names =

Undocumented

_adapter =

Undocumented

_base_alias =

Undocumented

_is_with_polymorphic: bool =

Undocumented

_nest_adapters =

Undocumented

_target =

Undocumented

_use_mapper_path =

Undocumented

_weak_entity =

Undocumented

_with_polymorphic_entities: list =

Undocumented

local_table =

Undocumented

mapper =

Undocumented

name =

Undocumented

persist_selectable =

Undocumented

polymorphic_on =

Undocumented

represents_outer_join =

Undocumented

selectable =

Undocumented

with_polymorphic_mappers =

Undocumented

@util.memoized_property
_all_column_expressions =

Undocumented

@util.memoized_property
_get_clause =

Undocumented

@util.memoized_property
_memoized_values =

Undocumented

@property
_path_registry =

Undocumented

@property
class_ =

Return the mapped class ultimately represented by this .AliasedInsp.

@property
entity =

Undocumented

@property
entity_namespace =

Undocumented