sqlalchemy.sql.selectable.ReturnsRows

class documentation

class ReturnsRows(roles.ReturnsRowsRole, ClauseElement):

Known subclasses: sqlalchemy.sql.dml.UpdateBase, sqlalchemy.sql.expression.Selectable

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.

New in version 1.4.

Class Variable	`_is_from_clause`	Undocumented
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	`exported_columns`	A `_expression.ColumnCollection` that represents the "exported" columns of this `_expression.ReturnsRows`.
Property	`selectable`	Undocumented

Inherited from ReturnsRowsRole:

Class Variable _role_name Undocumented

Inherited from SQLRole (via ReturnsRowsRole):

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

Inherited from ClauseElement:

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	`__visit_name__`	Undocumented
Class Variable	`_cache_key_traversal`	Undocumented
Class Variable	`_from_objects`	Undocumented
Class Variable	`_is_bind_parameter`	Undocumented
Class Variable	`_is_clause_list`	Undocumented
Class Variable	`_is_clone_of`	Undocumented
Class Variable	`_is_from_container`	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	`bind`	Undocumented
Class Variable	`description`	Undocumented
Class Variable	`is_clause_element`	Undocumented
Class Variable	`is_selectable`	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.
Property	`entity_namespace`	Undocumented

Inherited from SQLRole (via ClauseElement):

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

Inherited from SupportsWrappingAnnotations (via 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 ClauseElement, SupportsWrappingAnnotations):

Property _annotations_cache_key Undocumented

Inherited from MemoizedHasCacheKey (via ClauseElement):

Method _generate_cache_key return a cache key.

Inherited from HasCacheKey (via 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 HasCopyInternals (via ClauseElement):

Method _copy_internals Reassign internal elements to be clones of themselves.

Inherited from Traversible (via ClauseElement):

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

_is_from_clause: bool =

overrides sqlalchemy.sql.expression.ClauseElement._is_from_clause

overridden in sqlalchemy.sql.expression.FromClause

Undocumented

_is_lateral: bool =

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

Undocumented

_is_returns_rows: bool =

overrides sqlalchemy.sql.expression.ClauseElement._is_returns_rows

Undocumented

_is_select_statement: bool =

overrides sqlalchemy.sql.expression.ClauseElement._is_select_statement

overridden in sqlalchemy.sql.selectable.SelectBase

Undocumented

@property
_all_selected_columns =

overridden in sqlalchemy.sql.dml.UpdateBase, sqlalchemy.sql.functions.FunctionElement, sqlalchemy.sql.selectable.SelectBase

A sequence of column expression objects that represents the "selected" columns of this _expression.ReturnsRows.

This is typically equivalent to .exported_columns except it is delivered in the form of a straight sequence and not keyed _expression.ColumnCollection.

@property
exported_columns =

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

A _expression.ColumnCollection that represents the "exported" columns of this _expression.ReturnsRows.

The "exported" columns represent the collection of _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..

New in version 1.4.