sqlalchemy.sql.expression.AliasedReturnsRows

class documentation

class AliasedReturnsRows(NoInit, FromClause):

Known subclasses: sqlalchemy.sql.expression.Alias, sqlalchemy.sql.expression.Lateral, sqlalchemy.sql.expression.Subquery, sqlalchemy.sql.expression.TableSample, sqlalchemy.sql.selectable.CTE

View In Hierarchy

Base class of aliases against tables, subqueries, and other selectables.

Method	`is_derived_from`	Return `True` if this `_expression.FromClause` is 'derived' from the given `FromClause`.
Class Method	`_construct`	Undocumented
Class Method	`_factory`	Base factory method. Subclasses need to provide this.
Method	`_copy_internals`	Reassign internal elements to be clones of themselves.
Method	`_init`	Undocumented
Method	`_populate_column_collection`	Called on subclasses to establish the .c collection.
Method	`_refresh_for_new_column`	Given a column added to the .c collection of an underlying selectable, produce the local version of that column, assuming this selectable ultimately should proxy this column.
Class Variable	`_is_from_container`	Undocumented
Class Variable	`_supports_derived_columns`	Undocumented
Class Variable	`_traverse_internals`	Undocumented
Class Variable	`named_with_column`	Undocumented
Instance Variable	`_orig_name`	Undocumented
Instance Variable	`element`	Undocumented
Instance Variable	`name`	Undocumented
Property	`_from_objects`	Undocumented
Property	`bind`	Undocumented
Property	`description`	A brief description of this `_expression.FromClause`.
Property	`original`	Legacy for dialects that are referring to Alias.original.

Inherited from NoInit:

Method __init__ Undocumented

Inherited from FromClause:

Method	`alias`	Return an alias of this `_expression.FromClause`.
Method	`join`	Return a `_expression.Join` from this `_expression.FromClause` to another `FromClause`.
Method	`outerjoin`	No summary
Method	`select`	Return a SELECT of this `_expression.FromClause`.
Method	`table_valued`	Return a `_sql.TableValuedColumn` object for this `_expression.FromClause`.
Method	`tablesample`	Return a TABLESAMPLE alias of this `_expression.FromClause`.
Class Variable	`c`	Undocumented
Class Variable	`schema`	Define the 'schema' attribute for this `_expression.FromClause`.
Instance Variable	`foreign_keys`	Return the collection of `_schema.ForeignKey` marker objects which this FromClause references.
Instance Variable	`primary_key`	Return the iterable collection of `_schema.Column` objects which comprise the primary key of this `_selectable.FromClause`.
Method	`_anonymous_fromclause`	Undocumented
Method	`_generate_fromclause_column_proxies`	Undocumented
Method	`_init_collections`	Undocumented
Method	`_is_lexical_equivalent`	Return `True` if this `_expression.FromClause` and the other represent the same lexical identity.
Method	`_reset_column_collection`	Reset the attributes linked to the `FromClause.c` attribute.
Class Variable	`__visit_name__`	Undocumented
Class Variable	`_hide_froms`	Undocumented
Class Variable	`_is_from_clause`	Undocumented
Class Variable	`_is_join`	Undocumented
Class Variable	`_select_iterable`	Undocumented
Class Variable	`_use_schema_map`	Undocumented
Class Variable	`is_selectable`	Undocumented
Instance Variable	`_columns`	Undocumented
Property	`_cols_populated`	Undocumented
Property	`columns`	A named-based collection of `_expression.ColumnElement` objects maintained by this `_expression.FromClause`.
Property	`entity_namespace`	Return a namespace used for name-based access in SQL expressions.
Property	`exported_columns`	A `_expression.ColumnCollection` that represents the "exported" columns of this `_expression.Selectable`.

Inherited from FromClauseRole (via FromClause, AnonymizedFromClauseRole, StrictFromClauseRole):

Class Variable	`_is_subquery`	Undocumented
Class Variable	`_role_name`	Undocumented

Inherited from AllowsLambdaRole (via FromClause, AnonymizedFromClauseRole, StrictFromClauseRole, FromClauseRole, ColumnsClauseRole):

Class Variable allows_lambda Undocumented

Inherited from UsesInspection (via FromClause, AnonymizedFromClauseRole, StrictFromClauseRole, FromClauseRole, ColumnsClauseRole):

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

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

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

Inherited from AllowsLambdaRole (via FromClause, AnonymizedFromClauseRole, StrictFromClauseRole, FromClauseRole, JoinTargetRole):

Class Variable allows_lambda Undocumented

Inherited from UsesInspection (via FromClause, AnonymizedFromClauseRole, StrictFromClauseRole, FromClauseRole, JoinTargetRole):

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

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

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

Inherited from Selectable (via FromClause):

Method	`corresponding_column`	No summary
Method	`lateral`	Return a LATERAL alias of this `_expression.Selectable`.
Method	`replace_selectable`	Replace all occurrences of `_expression.FromClause` 'old' with the given `_expression.Alias` object, returning a copy of this `_expression.FromClause`.

Inherited from ReturnsRows (via FromClause, Selectable):

Class Variable	`_is_lateral`	Undocumented
Class Variable	`_is_returns_rows`	Undocumented
Class Variable	`_is_select_statement`	Undocumented
Property	`_all_selected_columns`	A sequence of column expression objects that represents the "selected" columns of this `_expression.ReturnsRows`.
Property	`selectable`	Undocumented

Inherited from ReturnsRowsRole (via FromClause, Selectable, ReturnsRows):

Class Variable _role_name Undocumented

Inherited from SQLRole (via FromClause, Selectable, ReturnsRows, ReturnsRowsRole):

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

Inherited from ClauseElement (via FromClause, Selectable, ReturnsRows):

Method	`compare`	Compare this `_expression.ClauseElement` to the given `_expression.ClauseElement`.
Method	`compile`	Compile this SQL expression.
Method	`params`	Return a copy with `_expression.bindparam` elements replaced.
Method	`self_group`	Apply a 'grouping' to this `_expression.ClauseElement`.
Method	`unique_params`	Return a copy with `_expression.bindparam` elements replaced.
Method	`__bool__`	Undocumented
Method	`__getstate__`	Undocumented
Method	`__invert__`	Undocumented
Method	`__repr__`	Undocumented
Method	`__str__`	Undocumented
Method	`_clone`	Create a shallow copy of this ClauseElement.
Method	`_cloned_set`	Return the set consisting all cloned ancestors of this ClauseElement.
Method	`_compile_w_cache`	Undocumented
Method	`_compiler`	Return a compiler appropriate for this ClauseElement, given a Dialect.
Method	`_execute_on_connection`	Undocumented
Method	`_negate`	Undocumented
Method	`_negate_in_binary`	a hook to allow the right side of a binary expression to respond to a negation of the binary expression.
Method	`_replace_params`	Undocumented
Method	`_set_propagate_attrs`	Undocumented
Method	`_ungroup`	Return this `_expression.ClauseElement` without any groupings.
Method	`_with_binary_element_type`	in the context of binary expression, convert the type of this object to the one given.
Class Variable	`_cache_key_traversal`	Undocumented
Class Variable	`_is_bind_parameter`	Undocumented
Class Variable	`_is_clause_list`	Undocumented
Class Variable	`_is_clone_of`	Undocumented
Class Variable	`_is_immutable`	Undocumented
Class Variable	`_is_lambda_element`	Undocumented
Class Variable	`_is_select_container`	Undocumented
Class Variable	`_is_singleton_constant`	Undocumented
Class Variable	`_is_text_clause`	Undocumented
Class Variable	`_is_textual`	Undocumented
Class Variable	`_order_by_label_element`	Undocumented
Class Variable	`is_clause_element`	Undocumented
Class Variable	`stringify_dialect`	Undocumented
Class Variable	`supports_execution`	Undocumented
Instance Variable	`_propagate_attrs`	like annotations, however these propagate outwards liberally as SQL constructs are built, and are set up at construction time.
Property	`_constructor`	return the 'constructor' for this ClauseElement.

Inherited from SQLRole (via FromClause, Selectable, ReturnsRows, ClauseElement):

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

Inherited from SupportsWrappingAnnotations (via FromClause, Selectable, ReturnsRows, ClauseElement):

Method	`_annotate`	return a copy of this ClauseElement with annotations updated by the given dictionary.
Method	`_deannotate`	return a copy of this `_expression.ClauseElement` with annotations removed.
Method	`_with_annotations`	return a copy of this ClauseElement with annotations replaced by the given dictionary.

Inherited from SupportsAnnotations (via FromClause, Selectable, ReturnsRows, ClauseElement, SupportsWrappingAnnotations):

Property _annotations_cache_key Undocumented

Inherited from MemoizedHasCacheKey (via FromClause, Selectable, ReturnsRows, ClauseElement):

Method _generate_cache_key return a cache key.

Inherited from HasCacheKey (via FromClause, Selectable, ReturnsRows, ClauseElement, 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 Traversible (via FromClause, Selectable, ReturnsRows, ClauseElement):

Method	`get_children`	Return immediate child `.visitors.Traversible` elements of this `.visitors.Traversible`.
Method	`__class_getitem__`	Undocumented

def is_derived_from(self, fromclause):

overrides sqlalchemy.sql.expression.FromClause.is_derived_from

Return True if this _expression.FromClause is 'derived' from the given FromClause.

An example would be an Alias of a Table is derived from that Table.

@classmethod
def _construct(cls, *arg, **kw):

Undocumented

@classmethod
def _factory(cls, returnsrows, name=None):

overridden in sqlalchemy.sql.expression.Alias, sqlalchemy.sql.expression.Lateral, sqlalchemy.sql.expression.Subquery, sqlalchemy.sql.expression.TableSample, sqlalchemy.sql.selectable.CTE

Base factory method. Subclasses need to provide this.

def _copy_internals(self, clone=_clone, **kw):

overrides sqlalchemy.sql.traversals.HasCopyInternals._copy_internals

Reassign internal elements to be clones of themselves.

Called during a copy-and-traverse operation on newly shallow-copied elements to create a deep copy.

The given clone function should be used, which may be applying additional transformations to the element (i.e. replacement traversal, cloned traversal, annotations).

def _init(self, selectable, name=None):

overridden in sqlalchemy.sql.expression.TableSample, sqlalchemy.sql.expression.TableValuedAlias, sqlalchemy.sql.selectable.CTE

Undocumented

def _populate_column_collection(self):

overrides sqlalchemy.sql.expression.FromClause._populate_column_collection

overridden in sqlalchemy.sql.selectable.CTE

Called on subclasses to establish the .c collection.

Each implementation has a different way of establishing this collection.

def _refresh_for_new_column(self, column):

overrides sqlalchemy.sql.expression.FromClause._refresh_for_new_column

Given a column added to the .c collection of an underlying selectable, produce the local version of that column, assuming this selectable ultimately should proxy this column.

this is used to "ping" a derived selectable to add a new column to its .c. collection when a Column has been added to one of the Table objects it ultimately derives from.

If the given selectable hasn't populated its .c. collection yet, it should at least pass on the message to the contained selectables, but it will return None.

This method is currently used by Declarative to allow Table columns to be added to a partially constructed inheritance mapping that may have already produced joins. The method isn't public right now, as the full span of implications and/or caveats aren't yet clear.

It's also possible that this functionality could be invoked by default via an event, which would require that selectables maintain a weak referencing collection of all derivations.

_is_from_container: bool =

overrides sqlalchemy.sql.expression.ClauseElement._is_from_container

Undocumented

_supports_derived_columns: bool =

overridden in sqlalchemy.sql.expression.TableValuedAlias

Undocumented

_traverse_internals =

overridden in sqlalchemy.sql.expression.TableSample, sqlalchemy.sql.expression.TableValuedAlias, sqlalchemy.sql.selectable.CTE

Undocumented

named_with_column: bool =

overrides sqlalchemy.sql.expression.FromClause.named_with_column

Undocumented

_orig_name =

Undocumented

element =

Undocumented

name =

Undocumented

@property
_from_objects =

overrides sqlalchemy.sql.expression.ClauseElement._from_objects

Undocumented

@property
bind =

overrides sqlalchemy.sql.expression.ClauseElement.bind

Undocumented

@property
description =

overrides sqlalchemy.sql.expression.FromClause.description

A brief description of this _expression.FromClause.

Used primarily for error message formatting.

@property
original =

Legacy for dialects that are referring to Alias.original.