sqlalchemy.sql.selectable.ReturnsRows

class documentation

class ReturnsRows(roles.ReturnsRowsRole, DQLDMLClauseElement): (source)

Known subclasses: sqlalchemy.sql.selectable.ExecutableReturnsRows, sqlalchemy.sql.selectable.Selectable, sqlalchemy.sql.selectable.SelectsRows

View In Hierarchy

The base-most class for Core constructs that have some concept of columns that can represent rows. While the SELECT statement and TABLE are the primary things we think of in this category, DML like INSERT, UPDATE and DELETE can also specify RETURNING which means they can be used in CTEs and other forms, and PostgreSQL has functions that return rows also. .. versionadded:: 1.4

Method	`is_derived_from`	Return ``True`` if this :class:`.ReturnsRows` is 'derived' from the given :class:`.FromClause`.
Property	`exported_columns`	A :class:`_expression.ColumnCollection` that represents the "exported" columns of this :class:`_expression.ReturnsRows`.
Property	`selectable`	Undocumented
Method	`_generate_fromclause_column_proxies`	Populate columns into an :class:`.AliasedReturnsRows` object.
Method	`_refresh_for_new_column`	reset internal collections for an incoming column being added.
Class Variable	`_is_from_clause`	Undocumented
Class Variable	`_is_lateral`	Undocumented
Class Variable	`_is_returns_rows`	Undocumented
Class Variable	`_is_select_base`	Undocumented
Class Variable	`_is_select_statement`	Undocumented
Property	`_all_selected_columns`	A sequence of column expression objects that represents the "selected" columns of this :class:`_expression.ReturnsRows`.

Inherited from ReturnsRowsRole:

Class Variable	`__slots__`	Undocumented
Class Variable	`_role_name`	Undocumented

Inherited from SQLRole (via ReturnsRowsRole):

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

Inherited from DQLDMLClauseElement (via ReturnsRowsRole, SQLRole):

Method	`compile`	Compile this SQL expression.
Method	`_compiler`	Return a compiler appropriate for this ClauseElement, given a Dialect.

Inherited from ClauseElement (via ReturnsRowsRole, SQLRole, DQLDMLClauseElement):

Method	`__bool__`	Undocumented
Method	`__getstate__`	Undocumented
Method	`__invert__`	Undocumented
Method	`__repr__`	Undocumented
Method	`compare`	Compare this :class:`_expression.ClauseElement` to the given :class:`_expression.ClauseElement`.
Method	`get_children`	Return immediate child :class:`.visitors.HasTraverseInternals` elements of this :class:`.visitors.HasTraverseInternals`.
Method	`params`	Return a copy with :func:`_expression.bindparam` elements replaced.
Method	`self_group`	Apply a 'grouping' to this :class:`_expression.ClauseElement`.
Method	`unique_params`	Return a copy with :func:`_expression.bindparam` elements replaced.
Class Variable	`__visit_name__`	Undocumented
Class Variable	`is_clause_element`	Undocumented
Class Variable	`is_dml`	Undocumented
Class Variable	`is_selectable`	Undocumented
Class Variable	`negation_clause`	Undocumented
Property	`description`	Undocumented
Property	`entity_namespace`	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	`_execute_on_connection`	Undocumented
Method	`_execute_on_scalar`	an additional hook for subclasses to provide a different implementation for connection.scalar() vs. connection.execute().
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 :class:`_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	`_gen_static_annotations_cache_key`	Undocumented
Class Variable	`_is_bind_parameter`	Undocumented
Class Variable	`_is_clause_list`	Undocumented
Class Variable	`_is_clone_of`	Undocumented
Class Variable	`_is_column_element`	Undocumented
Class Variable	`_is_from_container`	Undocumented
Class Variable	`_is_immutable`	Undocumented
Class Variable	`_is_keyed_column_element`	Undocumented
Class Variable	`_is_lambda_element`	Undocumented
Class Variable	`_is_select_container`	Undocumented
Class Variable	`_is_singleton_constant`	Undocumented
Class Variable	`_is_star`	Undocumented
Class Variable	`_is_table`	Undocumented
Class Variable	`_is_text_clause`	Undocumented
Class Variable	`_is_textual`	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.
Property	`_from_objects`	Undocumented
Property	`_order_by_label_element`	Undocumented

Inherited from SupportsWrappingAnnotations (via ReturnsRowsRole, SQLRole, DQLDMLClauseElement, ClauseElement):

Method	`_annotate`	return a copy of this ClauseElement with annotations updated by the given dictionary.
Method	`_deannotate`	return a copy of this :class:`_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 ReturnsRowsRole, SQLRole, DQLDMLClauseElement, ClauseElement, SupportsWrappingAnnotations):

Class Variable	`proxy_set`	Undocumented
Method	`_gen_annotations_cache_key`	Undocumented
Property	`_annotations_cache_key`	Undocumented

Inherited from MemoizedHasCacheKey (via ReturnsRowsRole, SQLRole, DQLDMLClauseElement, ClauseElement, SupportsWrappingAnnotations, SupportsAnnotations):

Method _generate_cache_key return a cache key.

Inherited from HasCacheKey (via ReturnsRowsRole, SQLRole, DQLDMLClauseElement, ClauseElement, SupportsWrappingAnnotations, SupportsAnnotations, MemoizedHasCacheKey):

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.
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 HasCopyInternals (via ReturnsRowsRole, SQLRole, DQLDMLClauseElement, ClauseElement, SupportsWrappingAnnotations, SupportsAnnotations, MemoizedHasCacheKey, HasCacheKey):

Method _copy_internals Reassign internal elements to be clones of themselves.

Inherited from HasTraverseInternals (via ReturnsRowsRole, SQLRole, DQLDMLClauseElement, ClauseElement, SupportsWrappingAnnotations, SupportsAnnotations, MemoizedHasCacheKey, HasCacheKey, HasCopyInternals, ExternallyTraversible):

Class Variable _traverse_internals Undocumented

Inherited from CompilerElement (via ReturnsRowsRole, SQLRole, DQLDMLClauseElement, ClauseElement, SupportsWrappingAnnotations, SupportsAnnotations, MemoizedHasCacheKey, HasCacheKey, HasCopyInternals, ExternallyTraversible, HasTraverseInternals):

Method	`__str__`	Undocumented
Class Variable	`stringify_dialect`	Undocumented
Class Variable	`supports_execution`	Undocumented

Inherited from Visitable (via ReturnsRowsRole, SQLRole, DQLDMLClauseElement, ClauseElement, SupportsWrappingAnnotations, SupportsAnnotations, MemoizedHasCacheKey, HasCacheKey, HasCopyInternals, ExternallyTraversible, HasTraverseInternals, CompilerElement):

Method	`__class_getitem__`	Undocumented
Method	`__init_subclass__`	Undocumented
Class Method	`_generate_compiler_dispatch`	Undocumented
Method	`_compiler_dispatch`	Undocumented
Class Variable	`_original_compiler_dispatch`	Undocumented

def is_derived_from(self, fromclause: Optional[FromClause]) -> bool: (source) ¶

overridden in sqlalchemy.sql.selectable.CompoundSelect, sqlalchemy.sql.selectable.CompoundSelect, sqlalchemy.sql.selectable.CompoundSelect, sqlalchemy.sql.selectable.FromClause, sqlalchemy.sql.selectable.Select, sqlalchemy.sql.selectable.Select, sqlalchemy.sql.selectable.Select

Return ``True`` if this :class:`.ReturnsRows` is 'derived' from the given :class:`.FromClause`. An example would be an Alias of a Table is derived from that Table.

@property
exported_columns: ReadOnlyColumnCollection[Any, Any] = (source) ¶

overridden in sqlalchemy.sql.dml.UpdateBase, sqlalchemy.sql.dml.UpdateBase, sqlalchemy.sql.selectable.FromClause, sqlalchemy.sql.selectable.SelectBase, sqlalchemy.sql.selectable.SelectBase

A :class:`_expression.ColumnCollection` that represents the "exported" columns of this :class:`_expression.ReturnsRows`. The "exported" columns represent the collection of :class:`_expression.ColumnElement` expressions that are rendered by this SQL construct. There are primary varieties which are the "FROM clause columns" of a FROM clause, such as a table, join, or subquery, the "SELECTed columns", which are the columns in the "columns clause" of a SELECT statement, and the RETURNING columns in a DML statement.. .. versionadded:: 1.4 .. seealso:: :attr:`_expression.FromClause.exported_columns` :attr:`_expression.SelectBase.exported_columns`

@property
selectable: ReturnsRows = (source) ¶

Undocumented

def _generate_fromclause_column_proxies(self, fromclause: FromClause): (source) ¶

overridden in sqlalchemy.sql.dml.UpdateBase, sqlalchemy.sql.dml.UpdateBase, sqlalchemy.sql.selectable.CompoundSelect, sqlalchemy.sql.selectable.FromClause, sqlalchemy.sql.selectable.Select, sqlalchemy.sql.selectable.SelectBase, sqlalchemy.sql.selectable.SelectBase, sqlalchemy.sql.selectable.TextualSelect

Populate columns into an :class:`.AliasedReturnsRows` object.

def _refresh_for_new_column(self, column: ColumnElement[Any]): (source) ¶

overridden in sqlalchemy.sql.selectable.CompoundSelect, sqlalchemy.sql.selectable.Selectable, sqlalchemy.sql.selectable.SelectBase

reset internal collections for an incoming column being added.

_is_from_clause: bool = (source) ¶

overrides sqlalchemy.sql.elements.ClauseElement._is_from_clause

overridden in sqlalchemy.sql.selectable.FromClause

Undocumented

_is_lateral: bool = (source) ¶

overridden in sqlalchemy.sql.selectable.Lateral, sqlalchemy.sql.selectable.Lateral, sqlalchemy.sql.selectable.Values

Undocumented

_is_returns_rows: bool = (source) ¶

overrides sqlalchemy.sql.elements.ClauseElement._is_returns_rows

Undocumented

_is_select_base: bool = (source) ¶

overrides sqlalchemy.sql.elements.ClauseElement._is_select_base

overridden in sqlalchemy.sql.selectable.SelectBase, sqlalchemy.sql.selectable.SelectBase

Undocumented

_is_select_statement: bool = (source) ¶

overrides sqlalchemy.sql.elements.ClauseElement._is_select_statement

overridden in sqlalchemy.sql.selectable.Select, sqlalchemy.sql.selectable.Select, sqlalchemy.sql.selectable.Select

Undocumented

@util.ro_non_memoized_property
_all_selected_columns: _SelectIterable = (source) ¶

overridden in sqlalchemy.orm.context.FromStatement, sqlalchemy.sql.dml.UpdateBase, sqlalchemy.sql.dml.UpdateBase, sqlalchemy.sql.functions.FunctionElement, sqlalchemy.sql.selectable.CompoundSelect, sqlalchemy.sql.selectable.Select, sqlalchemy.sql.selectable.SelectBase, sqlalchemy.sql.selectable.SelectBase, sqlalchemy.sql.selectable.TextualSelect

A sequence of column expression objects that represents the "selected" columns of this :class:`_expression.ReturnsRows`. This is typically equivalent to .exported_columns except it is delivered in the form of a straight sequence and not keyed :class:`_expression.ColumnCollection`.