sqlalchemy.sql.selectable.FromGrouping

class documentation

class FromGrouping(GroupedElement, FromClause): (source)

Known subclasses: sqlalchemy.sql.selectable.NamedFromGrouping

Represent a grouping of a FROM clause

Method	`__getstate__`	Undocumented
Method	`__init__`	Undocumented
Method	`__setstate__`	Undocumented
Method	`alias`	Return an alias of this :class:`_expression.FromClause`.
Method	`is_derived_from`	Return ``True`` if this :class:`_expression.FromClause` is 'derived' from the given ``FromClause``.
Instance Variable	`element`	Undocumented
Property	`c`	A synonym for :attr:`.FromClause.columns`
Property	`columns`	A named-based collection of :class:`_expression.ColumnElement` objects maintained by this :class:`_expression.FromClause`.
Property	`foreign_keys`	Return the collection of :class:`_schema.ForeignKey` marker objects which this FromClause references.
Property	`primary_key`	Return the iterable collection of :class:`_schema.Column` objects which comprise the primary key of this :class:`_selectable.FromClause`.
Method	`_anonymous_fromclause`	Undocumented
Method	`_init_collections`	Undocumented
Class Variable	`_traverse_internals`	Undocumented
Property	`_from_objects`	Undocumented
Property	`_hide_froms`	Undocumented

Inherited from GroupedElement:

Method	`self_group`	Apply a 'grouping' to this :class:`_expression.ClauseElement`.
Class Variable	`__visit_name__`	Undocumented
Method	`_ungroup`	Return this :class:`_expression.ClauseElement` without any groupings.

Inherited from FromClause (via GroupedElement):

Method	`join`	Return a :class:`_expression.Join` from this :class:`_expression.FromClause` to another :class:`FromClause`.
Method	`outerjoin`	Return a :class:`_expression.Join` from this :class:`_expression.FromClause` to another :class:`FromClause`, with the "isouter" flag set to True.
Method	`select`	Return a SELECT of this :class:`_expression.FromClause`.
Method	`tablesample`	Return a TABLESAMPLE alias of this :class:`_expression.FromClause`.
Class Variable	`is_selectable`	Undocumented
Class Variable	`named_with_column`	Undocumented
Class Variable	`schema`	Define the 'schema' attribute for this :class:`_expression.FromClause`.
Property	`description`	A brief description of this :class:`_expression.FromClause`.
Property	`entity_namespace`	Return a namespace used for name-based access in SQL expressions.
Property	`exported_columns`	A :class:`_expression.ColumnCollection` that represents the "exported" columns of this :class:`_expression.Selectable`.
Method	`_generate_fromclause_column_proxies`	Populate columns into an :class:`.AliasedReturnsRows` object.
Method	`_is_lexical_equivalent`	Return ``True`` if this :class:`_expression.FromClause` and the other represent the same lexical identity.
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.
Method	`_reset_column_collection`	Reset the attributes linked to the ``FromClause.c`` attribute.
Class Variable	`_is_clone_of`	Undocumented
Class Variable	`_is_from_clause`	Undocumented
Class Variable	`_is_join`	Undocumented
Class Variable	`_use_schema_map`	Undocumented
Instance Variable	`_columns`	Undocumented
Property	`_cols_populated`	Undocumented
Property	`_select_iterable`	Undocumented

Inherited from AnonymizedFromClauseRole (via GroupedElement, FromClause):

Class Variable __slots__ Undocumented

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

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

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

Class Variable allows_lambda Undocumented

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

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

Inherited from Selectable (via GroupedElement, FromClause, AnonymizedFromClauseRole, StrictFromClauseRole, FromClauseRole, ColumnsClauseRole, JoinTargetRole, AllowsLambdaRole, UsesInspection, ColumnListRole, StructuralRole):

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	`lateral`	Return a LATERAL alias of this :class:`_expression.Selectable`.
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`.

Inherited from ReturnsRows (via GroupedElement, FromClause, AnonymizedFromClauseRole, StrictFromClauseRole, FromClauseRole, ColumnsClauseRole, JoinTargetRole, AllowsLambdaRole, UsesInspection, ColumnListRole, StructuralRole, Selectable):

Property	`selectable`	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 DQLDMLClauseElement (via GroupedElement, FromClause, AnonymizedFromClauseRole, StrictFromClauseRole, FromClauseRole, ColumnsClauseRole, JoinTargetRole, AllowsLambdaRole, UsesInspection, ColumnListRole, StructuralRole, 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 GroupedElement, FromClause, AnonymizedFromClauseRole, StrictFromClauseRole, FromClauseRole, ColumnsClauseRole, JoinTargetRole, AllowsLambdaRole, UsesInspection, ColumnListRole, StructuralRole, Selectable, ReturnsRows, ReturnsRowsRole, SQLRole, DQLDMLClauseElement):

Method	`__bool__`	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	`is_dml`	Undocumented
Class Variable	`negation_clause`	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	`_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_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	`_order_by_label_element`	Undocumented

Inherited from SupportsWrappingAnnotations (via GroupedElement, FromClause, AnonymizedFromClauseRole, StrictFromClauseRole, FromClauseRole, ColumnsClauseRole, JoinTargetRole, AllowsLambdaRole, UsesInspection, ColumnListRole, StructuralRole, Selectable, ReturnsRows, 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 GroupedElement, FromClause, AnonymizedFromClauseRole, StrictFromClauseRole, FromClauseRole, ColumnsClauseRole, JoinTargetRole, AllowsLambdaRole, UsesInspection, ColumnListRole, StructuralRole, 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 GroupedElement, FromClause, AnonymizedFromClauseRole, StrictFromClauseRole, FromClauseRole, ColumnsClauseRole, JoinTargetRole, AllowsLambdaRole, UsesInspection, ColumnListRole, StructuralRole, Selectable, ReturnsRows, ReturnsRowsRole, SQLRole, DQLDMLClauseElement, ClauseElement, SupportsWrappingAnnotations, SupportsAnnotations):

Method _generate_cache_key return a cache key.

Inherited from HasCacheKey (via GroupedElement, FromClause, AnonymizedFromClauseRole, StrictFromClauseRole, FromClauseRole, ColumnsClauseRole, JoinTargetRole, AllowsLambdaRole, UsesInspection, ColumnListRole, StructuralRole, 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 HasCopyInternals (via GroupedElement, FromClause, AnonymizedFromClauseRole, StrictFromClauseRole, FromClauseRole, ColumnsClauseRole, JoinTargetRole, AllowsLambdaRole, UsesInspection, ColumnListRole, StructuralRole, Selectable, ReturnsRows, ReturnsRowsRole, SQLRole, DQLDMLClauseElement, ClauseElement, SupportsWrappingAnnotations, SupportsAnnotations, MemoizedHasCacheKey, HasCacheKey):

Method _copy_internals Reassign internal elements to be clones of themselves.

Inherited from CompilerElement (via GroupedElement, FromClause, AnonymizedFromClauseRole, StrictFromClauseRole, FromClauseRole, ColumnsClauseRole, JoinTargetRole, AllowsLambdaRole, UsesInspection, ColumnListRole, StructuralRole, Selectable, ReturnsRows, 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 GroupedElement, FromClause, AnonymizedFromClauseRole, StrictFromClauseRole, FromClauseRole, ColumnsClauseRole, JoinTargetRole, AllowsLambdaRole, UsesInspection, ColumnListRole, StructuralRole, Selectable, ReturnsRows, 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 __getstate__(self) -> Dict[str, FromClause]: (source) ¶

overrides sqlalchemy.sql.elements.ClauseElement.__getstate__

Undocumented

def __init__(self, element: FromClause): (source) ¶

Undocumented

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

Undocumented

def alias(self, name: Optional[str] = None, flat: bool = False) -> NamedFromGrouping: (source) ¶

overrides sqlalchemy.sql.selectable.FromClause.alias

Return an alias of this :class:`_expression.FromClause`. E.g.:: a2 = some_table.alias('a2') The above code creates an :class:`_expression.Alias` object which can be used as a FROM clause in any SELECT statement. .. seealso:: :ref:`tutorial_using_aliases` :func:`_expression.alias`

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

overrides sqlalchemy.sql.selectable.FromClause.is_derived_from

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

element = (source) ¶

overrides sqlalchemy.sql.elements.GroupedElement.element

Undocumented

@util.ro_non_memoized_property
c: ReadOnlyColumnCollection[str, KeyedColumnElement[Any]] = (source) ¶

overrides sqlalchemy.sql.selectable.FromClause.c

A synonym for :attr:`.FromClause.columns` :return: a :class:`.ColumnCollection`

@util.ro_non_memoized_property
columns: ReadOnlyColumnCollection[str, KeyedColumnElement[Any]] = (source) ¶

overrides sqlalchemy.sql.selectable.FromClause.columns

A named-based collection of :class:`_expression.ColumnElement` objects maintained by this :class:`_expression.FromClause`. The :attr:`.columns`, or :attr:`.c` collection, is the gateway to the construction of SQL expressions using table-bound or other selectable-bound columns:: select(mytable).where(mytable.c.somecolumn == 5) :return: a :class:`.ColumnCollection` object.

@property
foreign_keys: Iterable[ForeignKey] = (source) ¶

overrides sqlalchemy.sql.selectable.FromClause.foreign_keys

Return the collection of :class:`_schema.ForeignKey` marker objects which this FromClause references. Each :class:`_schema.ForeignKey` is a member of a :class:`_schema.Table`-wide :class:`_schema.ForeignKeyConstraint`. .. seealso:: :attr:`_schema.Table.foreign_key_constraints`

@property
primary_key: Iterable[NamedColumn[Any]] = (source) ¶

overrides sqlalchemy.sql.selectable.FromClause.primary_key

Return the iterable collection of :class:`_schema.Column` objects which comprise the primary key of this :class:`_selectable.FromClause`. For a :class:`_schema.Table` object, this collection is represented by the :class:`_schema.PrimaryKeyConstraint` which itself is an iterable collection of :class:`_schema.Column` objects.

def _anonymous_fromclause(self, **kw: Any) -> FromGrouping: (source) ¶

overrides sqlalchemy.sql.selectable.FromClause._anonymous_fromclause

Undocumented

def _init_collections(self): (source) ¶

overrides sqlalchemy.sql.selectable.FromClause._init_collections

Undocumented

_traverse_internals: _TraverseInternalsType = (source) ¶

overrides sqlalchemy.sql.visitors.HasTraverseInternals._traverse_internals

Undocumented

@util.ro_non_memoized_property
_from_objects: List[FromClause] = (source) ¶

overrides sqlalchemy.sql.elements.ClauseElement._from_objects

Undocumented

@util.ro_non_memoized_property
_hide_froms: Iterable[FromClause] = (source) ¶

overrides sqlalchemy.sql.selectable.FromClause._hide_froms

Undocumented