sqlalchemy.orm.context.FromStatement

class documentation

class FromStatement(GroupedElement, Generative, TypedReturnsRows[_TP]): (source)

View In Hierarchy

Core construct that represents a load of ORM objects from various :class:`.ReturnsRows` and other classes including: :class:`.Select`, :class:`.TextClause`, :class:`.TextualSelect`, :class:`.CompoundSelect`, :class`.Insert`, :class:`.Update`, and in theory, :class:`.Delete`.

Method __init__ Undocumented
Method get_children Return immediate child :class:`.visitors.HasTraverseInternals` elements of this :class:`.visitors.HasTraverseInternals`.
Class Variable __visit_name__ Undocumented
Instance Variable element Undocumented
Instance Variable is_dml Undocumented
Property column_descriptions Return a :term:`plugin-enabled` 'column descriptions' structure referring to the columns which are SELECTed by this statement.
Method _compiler_dispatch provide a fixed _compiler_dispatch method.
Method _ensure_disambiguated_names Undocumented
Class Variable _cache_key_traversal Undocumented
Class Variable _for_update_arg Undocumented
Class Variable _traverse_internals Undocumented
Instance Variable _adapt_on_names Undocumented
Instance Variable _label_style Undocumented
Instance Variable _raw_columns Undocumented
Property _all_selected_columns A sequence of column expression objects that represents the "selected" columns of this :class:`_expression.ReturnsRows`.
Property _inline Undocumented
Property _return_defaults Undocumented
Property _returning Undocumented

Inherited from GroupedElement:

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

Inherited from Generative (via GroupedElement):

Method _generate Undocumented

Inherited from Executable (via GroupedElement, Generative, TypedReturnsRows, 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_insert Undocumented
Class Variable is_select 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 GroupedElement, Generative, TypedReturnsRows, ExecutableReturnsRows, Executable):

Class Variable __slots__ Undocumented
Class Variable _role_name Undocumented
Property _propagate_attrs Undocumented

Inherited from ReturnsRows (via GroupedElement, Generative, TypedReturnsRows, ExecutableReturnsRows, Executable, StatementRole):

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

Inherited from SQLRole (via GroupedElement, Generative, TypedReturnsRows, ExecutableReturnsRows, Executable, StatementRole, ReturnsRows, ReturnsRowsRole):

Class Variable allows_lambda Undocumented
Class Variable uses_inspection Undocumented

Inherited from DQLDMLClauseElement (via GroupedElement, Generative, TypedReturnsRows, ExecutableReturnsRows, Executable, StatementRole, 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, Generative, TypedReturnsRows, ExecutableReturnsRows, Executable, StatementRole, 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 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_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 _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 _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
Property _constructor return the 'constructor' for this ClauseElement.
Property _from_objects Undocumented
Property _order_by_label_element Undocumented

Inherited from SupportsWrappingAnnotations (via GroupedElement, Generative, TypedReturnsRows, ExecutableReturnsRows, Executable, StatementRole, 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, Generative, TypedReturnsRows, ExecutableReturnsRows, Executable, StatementRole, 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, Generative, TypedReturnsRows, ExecutableReturnsRows, Executable, StatementRole, ReturnsRows, ReturnsRowsRole, SQLRole, DQLDMLClauseElement, ClauseElement, SupportsWrappingAnnotations, SupportsAnnotations):

Method _generate_cache_key return a cache key.

Inherited from HasCacheKey (via GroupedElement, Generative, TypedReturnsRows, ExecutableReturnsRows, Executable, StatementRole, 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, Generative, TypedReturnsRows, ExecutableReturnsRows, Executable, StatementRole, 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, Generative, TypedReturnsRows, ExecutableReturnsRows, Executable, StatementRole, ReturnsRows, ReturnsRowsRole, SQLRole, DQLDMLClauseElement, ClauseElement, SupportsWrappingAnnotations, SupportsAnnotations, MemoizedHasCacheKey, HasCacheKey, HasCopyInternals, ExternallyTraversible, HasTraverseInternals):

Method __str__ Undocumented
Class Variable stringify_dialect Undocumented

Inherited from Visitable (via GroupedElement, Generative, TypedReturnsRows, ExecutableReturnsRows, Executable, StatementRole, 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
Class Variable _original_compiler_dispatch Undocumented
def __init__(self, entities: Iterable[_ColumnsClauseArgument[Any]], element: Union[ExecutableReturnsRows, TextClause], _adapt_on_names: bool = True): (source)

Undocumented

def get_children(self, **kw): (source)
overrides sqlalchemy.sql.elements.ClauseElement.get_children

Return immediate child :class:`.visitors.HasTraverseInternals` elements of this :class:`.visitors.HasTraverseInternals`. This is used for visit traversal. \**kw may contain flags that change the collection that is returned, for example to return a subset of items in order to cut down on larger traversals, or to return child items from a different context (such as schema-level collections instead of clause-level).

__visit_name__: str = (source)
overrides sqlalchemy.sql.elements.GroupedElement.__visit_name__

Undocumented

element = (source)
overrides sqlalchemy.sql.elements.GroupedElement.element

Undocumented

is_dml = (source)
overrides sqlalchemy.sql.base.Executable.is_dml

Undocumented

@property
column_descriptions = (source)

Return a :term:`plugin-enabled` 'column descriptions' structure referring to the columns which are SELECTed by this statement. See the section :ref:`queryguide_inspection` for an overview of this feature. .. seealso:: :ref:`queryguide_inspection` - ORM background

def _compiler_dispatch(self, compiler, **kw): (source)
overrides sqlalchemy.sql.visitors.Visitable._compiler_dispatch

provide a fixed _compiler_dispatch method. This is roughly similar to using the sqlalchemy.ext.compiler ``@compiles`` extension.

def _ensure_disambiguated_names(self): (source)

Undocumented

_cache_key_traversal = (source)
overrides sqlalchemy.sql.elements.ClauseElement._cache_key_traversal

Undocumented

_for_update_arg = (source)

Undocumented

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

Undocumented

_adapt_on_names = (source)

Undocumented

_label_style = (source)

Undocumented

_raw_columns = (source)

Undocumented

@property
_all_selected_columns = (source)
overrides sqlalchemy.sql.base.Executable._all_selected_columns

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`.

@property
_inline = (source)

Undocumented

@property
_return_defaults = (source)

Undocumented

@property
_returning = (source)

Undocumented