sqlalchemy.sql.selectable.CompoundSelect

class documentation

class CompoundSelect(HasCompileState, GenerativeSelect, ExecutableReturnsRows): (source)

View In Hierarchy

Forms the basis of ``UNION``, ``UNION ALL``, and other SELECT-based set operations. .. seealso:: :func:`_expression.union` :func:`_expression.union_all` :func:`_expression.intersect` :func:`_expression.intersect_all` :func:`_expression.except` :func:`_expression.except_all`

Method __init__ Undocumented
Method is_derived_from Return ``True`` if this :class:`.ReturnsRows` is 'derived' from the given :class:`.FromClause`.
Method self_group Apply a 'grouping' to this :class:`_expression.ClauseElement`.
Method set_label_style Return a new selectable with the specified label style.
Class Variable __visit_name__ Undocumented
Instance Variable keyword Undocumented
Instance Variable selects Undocumented
Property selected_columns A :class:`_expression.ColumnCollection` representing the columns that this SELECT statement or similar construct returns in its result set, not including :class:`_sql.TextClause` constructs.
Class Method _create_except Undocumented
Class Method _create_except_all Undocumented
Class Method _create_intersect Undocumented
Class Method _create_intersect_all Undocumented
Class Method _create_union Undocumented
Class Method _create_union_all Undocumented
Method _ensure_disambiguated_names Ensure that the names generated by this selectbase will be disambiguated in some way, if possible.
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.
Method _scalar_type Undocumented
Class Variable _auto_correlate Undocumented
Class Variable _is_from_container Undocumented
Class Variable _traverse_internals Undocumented
Property _all_selected_columns A sequence of expressions that correspond to what is rendered in the columns clause, including :class:`_sql.TextClause` constructs.

Inherited from HasCompileState:

Class Variable _compile_state_plugin Undocumented

Inherited from GenerativeSelect (via HasCompileState):

Method fetch Return a new selectable with the given FETCH FIRST criterion applied.
Method get_label_style Retrieve the current label style.
Method group_by Return a new selectable with the given list of GROUP BY criterion applied.
Method limit Return a new selectable with the given LIMIT criterion applied.
Method offset Return a new selectable with the given OFFSET criterion applied.
Method order_by Return a new selectable with the given list of ORDER BY criteria applied.
Method slice Apply LIMIT / OFFSET to this statement based on a slice.
Method with_for_update Specify a ``FOR UPDATE`` clause for this :class:`_expression.GenerativeSelect`.
Method _offset_or_limit_clause Convert the given value to an "offset or limit" clause.
Method _offset_or_limit_clause_asint Convert the "offset or limit" clause of a select construct to an integer.
Method _simple_int_clause True if the clause is a simple integer, False if it is not present or is a SQL expression.
Instance Variable _fetch_clause Undocumented
Instance Variable _fetch_clause_options Undocumented
Instance Variable _for_update_arg Undocumented
Instance Variable _group_by_clauses Undocumented
Instance Variable _label_style Undocumented
Instance Variable _limit_clause Undocumented
Instance Variable _offset_clause Undocumented
Instance Variable _order_by_clauses Undocumented
Property _group_by_clause ClauseList access to group_by_clauses for legacy dialects
Property _has_row_limiting_clause Undocumented
Property _limit Get an integer value for the limit. This should only be used by code that cannot support a limit as a BindParameter or other custom clause as it will throw an exception if the limit isn't currently set to an integer.
Property _offset Get an integer value for the offset. This should only be used by code that cannot support an offset as a BindParameter or other custom clause as it will throw an exception if the offset isn't currently set to an integer.
Property _order_by_clause ClauseList access to order_by_clauses for legacy dialects

Inherited from SelectBase (via HasCompileState, GenerativeSelect):

Method alias Return a named subquery against this :class:`_expression.SelectBase`.
Method as_scalar Undocumented
Method exists Return an :class:`_sql.Exists` representation of this selectable, which can be used as a column expression.
Method label Return a 'scalar' representation of this selectable, embedded as a subquery with a label.
Method lateral Return a LATERAL alias of this :class:`_expression.Selectable`.
Method scalar_subquery Return a 'scalar' representation of this selectable, which can be used as a column expression.
Method select Undocumented
Method subquery Return a subquery of this :class:`_expression.SelectBase`.
Class Variable is_select Undocumented
Property c Undocumented
Property columns Undocumented
Property exported_columns A :class:`_expression.ColumnCollection` that represents the "exported" columns of this :class:`_expression.Selectable`, not including :class:`_sql.TextClause` constructs.
Method _implicit_subquery Undocumented
Class Variable _is_select_base Undocumented

Inherited from SelectStatementRole (via HasCompileState, GenerativeSelect, SelectBase):

Class Variable __slots__ Undocumented
Class Variable _role_name Undocumented

Inherited from Executable (via HasCompileState, GenerativeSelect, SelectBase, SelectStatementRole, ExecutableReturnsRows):

Method execution_options Set non-SQL options for the statement which take effect during execution.
Method get_execution_options Get the non-SQL options which will take effect during execution.
Method options Apply options to this statement.
Class Variable is_delete Undocumented
Class Variable is_dml Undocumented
Class Variable is_insert Undocumented
Class Variable is_text Undocumented
Class Variable is_update Undocumented
Class Variable supports_execution Undocumented
Method _add_context_option Add a context option to this statement.
Method _compile_w_cache Undocumented
Method _execute_on_connection Undocumented
Method _execute_on_scalar Undocumented
Method _set_compile_options Assign the compile options to a new value.
Method _update_compile_options update the _compile_options with new keys.
Class Variable _executable_traverse_internals Undocumented
Class Variable _is_default_generator Undocumented
Class Variable _with_context_options Undocumented
Class Variable _with_options Undocumented
Instance Variable _compile_options Undocumented
Instance Variable _execution_options Undocumented
Property _effective_plugin_target Undocumented

Inherited from StatementRole (via HasCompileState, GenerativeSelect, SelectBase, SelectStatementRole, ExecutableReturnsRows, Executable):

Property _propagate_attrs Undocumented

Inherited from AllowsLambdaRole (via HasCompileState, GenerativeSelect, SelectBase, SelectStatementRole, ExecutableReturnsRows, Executable, StatementRole, DMLSelectRole, CompoundElementRole):

Class Variable allows_lambda Undocumented

Inherited from HasCTE (via HasCompileState, GenerativeSelect, SelectBase, SelectStatementRole, ExecutableReturnsRows, Executable, StatementRole, DMLSelectRole, CompoundElementRole, AllowsLambdaRole, InElementRole):

Method add_cte Add one or more :class:`_sql.CTE` constructs to this statement.
Method cte Return a new :class:`_expression.CTE`, or Common Table Expression instance.
Class Variable _has_ctes_traverse_internals Undocumented
Class Variable _independent_ctes Undocumented
Class Variable _independent_ctes_opts Undocumented

Inherited from SelectsRows (via HasCompileState, GenerativeSelect, SelectBase, SelectStatementRole, ExecutableReturnsRows, Executable, StatementRole, DMLSelectRole, CompoundElementRole, AllowsLambdaRole, InElementRole, HasCTE, HasCTERole):

Method _generate_columns_plus_names Generate column names as rendered in a SELECT statement by the compiler.

Inherited from SupportsCloneAnnotations (via HasCompileState, GenerativeSelect, SelectBase, SelectStatementRole, ExecutableReturnsRows, Executable, StatementRole, DMLSelectRole, CompoundElementRole, AllowsLambdaRole, InElementRole, HasCTE, HasCTERole, SelectsRows):

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.
Class Variable _clone_annotations_traverse_internals Undocumented

Inherited from Selectable (via HasCompileState, GenerativeSelect, SelectBase, SelectStatementRole, ExecutableReturnsRows, Executable, StatementRole, DMLSelectRole, CompoundElementRole, AllowsLambdaRole, InElementRole, HasCTE, HasCTERole, SelectsRows, SupportsCloneAnnotations):

Method corresponding_column Given a :class:`_expression.ColumnElement`, return the exported :class:`_expression.ColumnElement` object from the :attr:`_expression.Selectable.exported_columns` collection of this :class:`_expression...
Method replace_selectable Replace all occurrences of :class:`_expression.FromClause` 'old' with the given :class:`_expression.Alias` object, returning a copy of this :class:`_expression.FromClause`.
Class Variable is_selectable Undocumented

Inherited from ReturnsRows (via HasCompileState, GenerativeSelect, SelectBase, SelectStatementRole, ExecutableReturnsRows, Executable, StatementRole, DMLSelectRole, CompoundElementRole, AllowsLambdaRole, InElementRole, HasCTE, HasCTERole, SelectsRows, SupportsCloneAnnotations, Selectable):

Property selectable Undocumented
Class Variable _is_from_clause Undocumented
Class Variable _is_lateral Undocumented
Class Variable _is_returns_rows Undocumented
Class Variable _is_select_statement Undocumented

Inherited from SQLRole (via HasCompileState, GenerativeSelect, SelectBase, SelectStatementRole, ExecutableReturnsRows, Executable, StatementRole, DMLSelectRole, CompoundElementRole, AllowsLambdaRole, InElementRole, HasCTE, HasCTERole, SelectsRows, SupportsCloneAnnotations, Selectable, ReturnsRows, ReturnsRowsRole):

Class Variable uses_inspection Undocumented

Inherited from DQLDMLClauseElement (via HasCompileState, GenerativeSelect, SelectBase, SelectStatementRole, ExecutableReturnsRows, Executable, StatementRole, DMLSelectRole, CompoundElementRole, AllowsLambdaRole, InElementRole, HasCTE, HasCTERole, SelectsRows, SupportsCloneAnnotations, Selectable, ReturnsRows, ReturnsRowsRole, SQLRole):

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

Inherited from ClauseElement (via HasCompileState, GenerativeSelect, SelectBase, SelectStatementRole, ExecutableReturnsRows, Executable, StatementRole, DMLSelectRole, CompoundElementRole, AllowsLambdaRole, InElementRole, HasCTE, HasCTERole, SelectsRows, SupportsCloneAnnotations, Selectable, ReturnsRows, 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 unique_params Return a copy with :func:`_expression.bindparam` elements replaced.
Class Variable is_clause_element 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 _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_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
Property _constructor return the 'constructor' for this ClauseElement.
Property _from_objects Undocumented
Property _order_by_label_element Undocumented

Inherited from SupportsAnnotations (via HasCompileState, GenerativeSelect, SelectBase, SelectStatementRole, ExecutableReturnsRows, Executable, StatementRole, DMLSelectRole, CompoundElementRole, AllowsLambdaRole, InElementRole, HasCTE, HasCTERole, SelectsRows, SupportsCloneAnnotations, Selectable, ReturnsRows, 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 HasCompileState, GenerativeSelect, SelectBase, SelectStatementRole, ExecutableReturnsRows, Executable, StatementRole, DMLSelectRole, CompoundElementRole, AllowsLambdaRole, InElementRole, HasCTE, HasCTERole, SelectsRows, SupportsCloneAnnotations, Selectable, ReturnsRows, ReturnsRowsRole, SQLRole, DQLDMLClauseElement, ClauseElement, SupportsWrappingAnnotations, SupportsAnnotations):

Method _generate_cache_key return a cache key.

Inherited from HasCacheKey (via HasCompileState, GenerativeSelect, SelectBase, SelectStatementRole, ExecutableReturnsRows, Executable, StatementRole, DMLSelectRole, CompoundElementRole, AllowsLambdaRole, InElementRole, HasCTE, HasCTERole, SelectsRows, SupportsCloneAnnotations, Selectable, ReturnsRows, 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 Generative (via HasCompileState, GenerativeSelect, SelectBase, SelectStatementRole, ExecutableReturnsRows, Executable, StatementRole, DMLSelectRole, CompoundElementRole, AllowsLambdaRole, InElementRole, HasCTE, HasCTERole, SelectsRows, SupportsCloneAnnotations, Selectable, ReturnsRows, ReturnsRowsRole, SQLRole, DQLDMLClauseElement, ClauseElement, SupportsWrappingAnnotations, SupportsAnnotations, MemoizedHasCacheKey, HasCacheKey):

Method _generate Undocumented

Inherited from HasCopyInternals (via HasCompileState, GenerativeSelect, SelectBase, SelectStatementRole, ExecutableReturnsRows, Executable, StatementRole, DMLSelectRole, CompoundElementRole, AllowsLambdaRole, InElementRole, HasCTE, HasCTERole, SelectsRows, SupportsCloneAnnotations, Selectable, ReturnsRows, ReturnsRowsRole, SQLRole, DQLDMLClauseElement, ClauseElement, SupportsWrappingAnnotations, SupportsAnnotations, MemoizedHasCacheKey, HasCacheKey, Generative):

Method _copy_internals Reassign internal elements to be clones of themselves.

Inherited from CompilerElement (via HasCompileState, GenerativeSelect, SelectBase, SelectStatementRole, ExecutableReturnsRows, Executable, StatementRole, DMLSelectRole, CompoundElementRole, AllowsLambdaRole, InElementRole, HasCTE, HasCTERole, SelectsRows, SupportsCloneAnnotations, Selectable, ReturnsRows, ReturnsRowsRole, SQLRole, DQLDMLClauseElement, ClauseElement, SupportsWrappingAnnotations, SupportsAnnotations, MemoizedHasCacheKey, HasCacheKey, Generative, HasCopyInternals, ExternallyTraversible, HasTraverseInternals):

Method __str__ Undocumented
Class Variable stringify_dialect Undocumented

Inherited from Visitable (via HasCompileState, GenerativeSelect, SelectBase, SelectStatementRole, ExecutableReturnsRows, Executable, StatementRole, DMLSelectRole, CompoundElementRole, AllowsLambdaRole, InElementRole, HasCTE, HasCTERole, SelectsRows, SupportsCloneAnnotations, Selectable, ReturnsRows, ReturnsRowsRole, SQLRole, DQLDMLClauseElement, ClauseElement, SupportsWrappingAnnotations, SupportsAnnotations, MemoizedHasCacheKey, HasCacheKey, Generative, 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 __init__(self, keyword: _CompoundSelectKeyword, *selects: _SelectStatementForCompoundArgument): (source)
overrides sqlalchemy.sql.selectable.GenerativeSelect.__init__

Undocumented

def is_derived_from(self, fromclause: Optional[FromClause]) -> bool: (source)
overrides sqlalchemy.sql.selectable.ReturnsRows.is_derived_from

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.

def self_group(self, against: Optional[OperatorType] = None) -> GroupedElement: (source)
overrides sqlalchemy.sql.elements.ClauseElement.self_group

Apply a 'grouping' to this :class:`_expression.ClauseElement`. This method is overridden by subclasses to return a "grouping" construct, i.e. parenthesis. In particular it's used by "binary" expressions to provide a grouping around themselves when placed into a larger expression, as well as by :func:`_expression.select` constructs when placed into the FROM clause of another :func:`_expression.select`. (Note that subqueries should be normally created using the :meth:`_expression.Select.alias` method, as many platforms require nested SELECT statements to be named). As expressions are composed together, the application of :meth:`self_group` is automatic - end-user code should never need to use this method directly. Note that SQLAlchemy's clause constructs take operator precedence into account - so parenthesis might not be needed, for example, in an expression like ``x OR (y AND z)`` - AND takes precedence over OR. The base :meth:`self_group` method of :class:`_expression.ClauseElement` just returns self.

def set_label_style(self, style: SelectLabelStyle) -> CompoundSelect: (source)
overrides sqlalchemy.sql.selectable.GenerativeSelect.set_label_style

Return a new selectable with the specified label style. There are three "label styles" available, :attr:`_sql.SelectLabelStyle.LABEL_STYLE_DISAMBIGUATE_ONLY`, :attr:`_sql.SelectLabelStyle.LABEL_STYLE_TABLENAME_PLUS_COL`, and :attr:`_sql.SelectLabelStyle.LABEL_STYLE_NONE`. The default style is :attr:`_sql.SelectLabelStyle.LABEL_STYLE_TABLENAME_PLUS_COL`. In modern SQLAlchemy, there is not generally a need to change the labeling style, as per-expression labels are more effectively used by making use of the :meth:`_sql.ColumnElement.label` method. In past versions, :data:`_sql.LABEL_STYLE_TABLENAME_PLUS_COL` was used to disambiguate same-named columns from different tables, aliases, or subqueries; the newer :data:`_sql.LABEL_STYLE_DISAMBIGUATE_ONLY` now applies labels only to names that conflict with an existing name so that the impact of this labeling is minimal. The rationale for disambiguation is mostly so that all column expressions are available from a given :attr:`_sql.FromClause.c` collection when a subquery is created. .. versionadded:: 1.4 - the :meth:`_sql.GenerativeSelect.set_label_style` method replaces the previous combination of ``.apply_labels()``, ``.with_labels()`` and ``use_labels=True`` methods and/or parameters. .. seealso:: :data:`_sql.LABEL_STYLE_DISAMBIGUATE_ONLY` :data:`_sql.LABEL_STYLE_TABLENAME_PLUS_COL` :data:`_sql.LABEL_STYLE_NONE` :data:`_sql.LABEL_STYLE_DEFAULT`

__visit_name__: str = (source)
overrides sqlalchemy.sql.base.Executable.__visit_name__

Undocumented

keyword = (source)

Undocumented

selects = (source)

Undocumented

@util.ro_non_memoized_property
selected_columns: ColumnCollection[str, ColumnElement[Any]] = (source)
overrides sqlalchemy.sql.selectable.SelectBase.selected_columns

A :class:`_expression.ColumnCollection` representing the columns that this SELECT statement or similar construct returns in its result set, not including :class:`_sql.TextClause` constructs. For a :class:`_expression.CompoundSelect`, the :attr:`_expression.CompoundSelect.selected_columns` attribute returns the selected columns of the first SELECT statement contained within the series of statements within the set operation. .. seealso:: :attr:`_sql.Select.selected_columns` .. versionadded:: 1.4

@classmethod
def _create_except(cls, *selects: _SelectStatementForCompoundArgument) -> CompoundSelect: (source)

Undocumented

@classmethod
def _create_except_all(cls, *selects: _SelectStatementForCompoundArgument) -> CompoundSelect: (source)

Undocumented

@classmethod
def _create_intersect(cls, *selects: _SelectStatementForCompoundArgument) -> CompoundSelect: (source)

Undocumented

@classmethod
def _create_intersect_all(cls, *selects: _SelectStatementForCompoundArgument) -> CompoundSelect: (source)

Undocumented

@classmethod
def _create_union(cls, *selects: _SelectStatementForCompoundArgument) -> CompoundSelect: (source)

Undocumented

@classmethod
def _create_union_all(cls, *selects: _SelectStatementForCompoundArgument) -> CompoundSelect: (source)

Undocumented

def _ensure_disambiguated_names(self) -> CompoundSelect: (source)
overrides sqlalchemy.sql.selectable.SelectBase._ensure_disambiguated_names

Ensure that the names generated by this selectbase will be disambiguated in some way, if possible.

def _generate_fromclause_column_proxies(self, subquery: FromClause, *, proxy_compound_columns: Optional[Iterable[Sequence[ColumnElement[Any]]]] = None): (source)
overrides sqlalchemy.sql.selectable.SelectBase._generate_fromclause_column_proxies

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

def _refresh_for_new_column(self, column: ColumnElement[Any]): (source)
overrides sqlalchemy.sql.selectable.SelectBase._refresh_for_new_column

reset internal collections for an incoming column being added.

def _scalar_type(self) -> TypeEngine[Any]: (source)
overrides sqlalchemy.sql.selectable.SelectBase._scalar_type

Undocumented

_auto_correlate: bool = (source)

Undocumented

_is_from_container: bool = (source)
overrides sqlalchemy.sql.elements.ClauseElement._is_from_container

Undocumented

_traverse_internals: _TraverseInternalsType = (source)
overrides sqlalchemy.sql.visitors.HasTraverseInternals._traverse_internals

Undocumented

@util.ro_non_memoized_property
_all_selected_columns: _SelectIterable = (source)
overrides sqlalchemy.sql.selectable.SelectBase._all_selected_columns

A sequence of expressions that correspond to what is rendered in the columns clause, including :class:`_sql.TextClause` constructs. .. versionadded:: 1.4.12 .. seealso:: :attr:`_sql.SelectBase.exported_columns`