sqlalchemy.orm.util.AliasedInsp

class documentation

class AliasedInsp(ORMEntityColumnsClauseRole[_O], ORMFromClauseRole, HasCacheKey, InspectionAttr, MemoizedSlots, inspection.Inspectable['AliasedInsp[_O]'], Generic[_O]): (source)

View In Hierarchy

Provide an inspection interface for an :class:`.AliasedClass` object. The :class:`.AliasedInsp` object is returned given an :class:`.AliasedClass` using the :func:`_sa.inspect` function:: from sqlalchemy import inspect from sqlalchemy.orm import aliased my_alias = aliased(MyMappedClass) insp = inspect(my_alias) Attributes on :class:`.AliasedInsp` include: * ``entity`` - the :class:`.AliasedClass` represented. * ``mapper`` - the :class:`_orm.Mapper` mapping the underlying class. * ``selectable`` - the :class:`_expression.Alias` construct which ultimately represents an aliased :class:`_schema.Table` or :class:`_expression.Select` construct. * ``name`` - the name of the alias. Also is used as the attribute name when returned in a result tuple from :class:`_query.Query`. * ``with_polymorphic_mappers`` - collection of :class:`_orm.Mapper` objects indicating all those mappers expressed in the select construct for the :class:`.AliasedClass`. * ``polymorphic_on`` - an alternate column or SQL expression which will be used as the "discriminator" for a polymorphic load. .. seealso:: :ref:`inspection_toplevel`

Method __getstate__ Undocumented
Method __init__ Undocumented
Method __repr__ Undocumented
Method __setstate__ Undocumented
Method __str__ Undocumented
Class Variable __slots__ Undocumented
Class Variable is_aliased_class always returns True
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 class_ Return the mapped class ultimately represented by this :class:`.AliasedInsp`.
Property entity Undocumented
Property entity_namespace Undocumented
Class Method _alias_factory Undocumented
Class Method _with_polymorphic_factory Undocumented
Method _adapt_element Undocumented
Method _entity_for_mapper Undocumented
Method _memo Undocumented
Method _memoized_attr__all_column_expressions Undocumented
Method _memoized_attr__get_clause Undocumented
Method _memoized_attr__memoized_values Undocumented
Method _memoized_method___clause_element__ Undocumented
Method _merge_with Undocumented
Method _orm_adapt_element Undocumented
Class Variable _cache_key_traversal Undocumented
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 the thing referred towards by the AliasedClass/AliasedInsp.
Instance Variable _use_mapper_path Undocumented
Instance Variable _weak_entity the AliasedClass that refers to this AliasedInsp
Instance Variable _with_polymorphic_entities Undocumented
Property _path_registry Undocumented

Inherited from ORMEntityColumnsClauseRole:

Class Variable _role_name Undocumented

Inherited from FromClauseRole (via ORMEntityColumnsClauseRole, ORMColumnsClauseRole, ORMFromClauseRole, StrictFromClauseRole):

Class Variable named_with_column Undocumented
Class Variable _is_subquery Undocumented

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

Property _select_iterable Undocumented

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

Class Variable allows_lambda Undocumented

Inherited from UsesInspection (via ORMEntityColumnsClauseRole, ORMColumnsClauseRole, ORMFromClauseRole, StrictFromClauseRole, FromClauseRole, ColumnsClauseRole, JoinTargetRole, AllowsLambdaRole):

Class Variable uses_inspection Undocumented
Class Variable _post_inspect Undocumented

Inherited from HasCacheKey (via ORMEntityColumnsClauseRole, ORMColumnsClauseRole, ORMFromClauseRole, StrictFromClauseRole, FromClauseRole, ColumnsClauseRole, JoinTargetRole, AllowsLambdaRole, UsesInspection, ColumnListRole, TypedColumnsClauseRole, StructuralRole):

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 InspectionAttr (via ORMEntityColumnsClauseRole, ORMColumnsClauseRole, ORMFromClauseRole, StrictFromClauseRole, FromClauseRole, ColumnsClauseRole, JoinTargetRole, AllowsLambdaRole, UsesInspection, ColumnListRole, TypedColumnsClauseRole, StructuralRole, HasCacheKey):

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 :class:`.Bundle`.
Class Variable is_clause_element True if this object is an instance of :class:`_expression.ClauseElement`.
Class Variable is_instance True if this object is an instance of :class:`.InstanceState`.
Class Variable is_mapper True if this object is an instance of :class:`_orm.Mapper`.
Class Variable is_property True if this object is an instance of :class:`.MapperProperty`.
Class Variable is_selectable Return True if this object is an instance of :class:`_expression.Selectable`.
Class Variable _is_internal_proxy True if this object is an internal proxy object.

Inherited from MemoizedSlots (via ORMEntityColumnsClauseRole, ORMColumnsClauseRole, ORMFromClauseRole, StrictFromClauseRole, FromClauseRole, ColumnsClauseRole, JoinTargetRole, AllowsLambdaRole, UsesInspection, ColumnListRole, TypedColumnsClauseRole, StructuralRole, HasCacheKey, InspectionAttr):

Method __getattr__ Undocumented
Method _fallback_getattr Undocumented
def __getstate__(self) -> Dict[str, Any]: (source)

Undocumented

def __init__(self, entity: AliasedClass[_O], inspected: _InternalEntityType[_O], selectable: FromClause, name: Optional[str], with_polymorphic_mappers: Optional[Sequence[Mapper[Any]]], polymorphic_on: Optional[ColumnElement[Any]], _base_alias: Optional[AliasedInsp[Any]], _use_mapper_path: bool, adapt_on_names: bool, represents_outer_join: bool, nest_adapters: bool): (source)

Undocumented

def __repr__(self): (source)

Undocumented

def __setstate__(self, state: Dict[str, Any]): (source)

Undocumented

def __str__(self): (source)

Undocumented

__slots__: tuple[str, ...] = (source)
overrides sqlalchemy.orm.interfaces.ORMEntityColumnsClauseRole.__slots__

Undocumented

is_aliased_class: bool = (source)
overrides sqlalchemy.orm.base.InspectionAttr.is_aliased_class

always returns True

local_table = (source)

Undocumented

mapper = (source)

Undocumented

name = (source)

Undocumented

persist_selectable = (source)

Undocumented

polymorphic_on = (source)

Undocumented

represents_outer_join = (source)

Undocumented

selectable = (source)

Undocumented

with_polymorphic_mappers = (source)

Undocumented

@property
class_: Type[_O] = (source)

Return the mapped class ultimately represented by this :class:`.AliasedInsp`.

@property
entity: AliasedClass[_O] = (source)

Undocumented

@property
entity_namespace: AliasedClass[_O] = (source)

Undocumented

@classmethod
def _alias_factory(cls, element: Union[_EntityType[_O], FromClause], alias: Optional[Union[Alias, Subquery]] = None, name: Optional[str] = None, flat: bool = False, adapt_on_names: bool = False) -> Union[AliasedClass[_O], FromClause]: (source)

Undocumented

@classmethod
def _with_polymorphic_factory(cls, base: Union[Type[_O], Mapper[_O]], classes: Union[Literal['*'], Iterable[_EntityType[Any]]], selectable: Union[Literal[False, None], FromClause] = False, flat: bool = False, polymorphic_on: Optional[ColumnElement[Any]] = None, aliased: bool = False, innerjoin: bool = False, adapt_on_names: bool = False, _use_mapper_path: bool = False) -> AliasedClass[_O]: (source)

Undocumented

def _adapt_element(self, expr: _ORMCOLEXPR, key: Optional[str] = None) -> _ORMCOLEXPR: (source)

Undocumented

def _entity_for_mapper(self, mapper): (source)

Undocumented

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

Undocumented

def _memoized_attr__all_column_expressions(self): (source)

Undocumented

def _memoized_attr__get_clause(self): (source)

Undocumented

def _memoized_attr__memoized_values(self): (source)

Undocumented

def _memoized_method___clause_element__(self) -> FromClause: (source)

Undocumented

def _merge_with(self, other: AliasedInsp[_O]) -> AliasedInsp[_O]: (source)

Undocumented

def _orm_adapt_element(self, obj: _CE, key: Optional[str] = None) -> _CE: (source)

Undocumented

_cache_key_traversal = (source)

Undocumented

_adapt_on_names = (source)

Undocumented

_adapter = (source)

Undocumented

_base_alias = (source)

Undocumented

_is_with_polymorphic: bool = (source)

Undocumented

_nest_adapters = (source)

Undocumented

_target = (source)

the thing referred towards by the AliasedClass/AliasedInsp. In the vast majority of cases, this is the mapped class. However it may also be another AliasedClass (alias of alias).

_use_mapper_path = (source)

Undocumented

_weak_entity = (source)

the AliasedClass that refers to this AliasedInsp

_with_polymorphic_entities: list = (source)

Undocumented

@property
_path_registry: PathRegistry = (source)

Undocumented