sqlalchemy.orm.query.FromStatement

class documentation

class FromStatement(GroupedElement, SelectBase, Executable):

Core construct that represents a load of ORM objects from a finished select or text construct.

Method	`__init__`	Undocumented
Method	`_compiler_dispatch`	provide a fixed _compiler_dispatch method.
Method	`_ensure_disambiguated_names`	Ensure that the names generated by this selectbase will be disambiguated in some way, if possible.
Method	`get_children`	Return immediate child `.visitors.Traversible` elements of this `.visitors.Traversible`.
Method	`get_label_style`	Undocumented
Method	`set_label_style`	Undocumented
Class Variable	`__visit_name__`	Undocumented
Class Variable	`_cache_key_traversal`	Undocumented
Class Variable	`_for_update_arg`	Undocumented
Class Variable	`_traverse_internals`	Undocumented
Instance Variable	`_raw_columns`	Undocumented
Instance Variable	`element`	Undocumented
Property	`_inline`	Undocumented
Property	`_label_style`	Undocumented
Property	`_returning`	Undocumented

Inherited from SelectBase:

Method	`_generate_fromclause_column_proxies`	Undocumented
Method	`_implicit_subquery`	Undocumented
Method	`_refresh_for_new_column`	Undocumented
Method	`alias`	Return a named subquery against this `_expression.SelectBase`.
Method	`as_scalar`	Undocumented
Method	`exists`	Return an `_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 `_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 `_expression.SelectBase`.
Class Variable	`_is_select_statement`	Undocumented
Class Variable	`is_select`	Undocumented
Property	`_all_selected_columns`	A sequence of expressions that correspond to what is rendered in the columns clause, including `_sql.TextClause` constructs.
Property	`_from_objects`	Undocumented
Property	`c`	Undocumented
Property	`columns`	Undocumented
Property	`exported_columns`	No summary
Property	`selected_columns`	A `_expression.ColumnCollection` representing the columns that this SELECT statement or similar construct returns in its result set.

Inherited from SelectStatementRole (via SelectBase):

Class Variable _role_name Undocumented

Inherited from StatementRole (via SelectBase, SelectStatementRole):

Class Variable _propagate_attrs Undocumented

Inherited from SQLRole (via SelectBase, SelectStatementRole, StatementRole):

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

Inherited from SQLRole (via SelectBase, SelectStatementRole, ReturnsRowsRole):

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

Inherited from DMLSelectRole (via SelectBase):

Class Variable _role_name Undocumented

Inherited from SQLRole (via SelectBase, DMLSelectRole):

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

Inherited from CompoundElementRole (via SelectBase):

Class Variable _role_name Undocumented

Inherited from AllowsLambdaRole (via SelectBase, CompoundElementRole):

Class Variable allows_lambda Undocumented

Inherited from SQLRole (via SelectBase, CompoundElementRole):

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

Inherited from InElementRole (via SelectBase):

Class Variable _role_name Undocumented

Inherited from SQLRole (via SelectBase, InElementRole):

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

Inherited from HasCTE (via SelectBase):

Method	`add_cte`	Add a `_sql.CTE` to this statement object that will be independently rendered even if not referenced in the statement otherwise.
Method	`cte`	Return a new `_expression.CTE`, or Common Table Expression instance.
Class Variable	`_has_ctes_traverse_internals`	Undocumented
Class Variable	`_independent_ctes`	Undocumented

Inherited from ReturnsRowsRole (via SelectBase, HasCTE, HasCTERole):

Class Variable _role_name Undocumented

Inherited from SQLRole (via SelectBase, HasCTE, HasCTERole, ReturnsRowsRole):

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

Inherited from Executable (via SelectBase):

Method	`_add_context_option`	Add a context option to this statement.
Method	`_set_compile_options`	Assign the compile options to a new value.
Method	`_update_compile_options`	update the _compile_options with new keys.
Method	`execute`	Compile and execute this `.Executable`.
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.
Method	`scalar`	Compile and execute this `.Executable`, returning the result's scalar representation.
Class Variable	`_bind`	Undocumented
Class Variable	`_executable_traverse_internals`	Undocumented
Class Variable	`_with_context_options`	Undocumented
Class Variable	`_with_options`	Undocumented
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
Instance Variable	`_compile_options`	Undocumented
Instance Variable	`_execution_options`	Undocumented
Property	`_effective_plugin_target`	Undocumented
Property	`bind`	Returns the `_engine.Engine` or `_engine.Connection` to which this `.Executable` is bound, or None if none found.

Inherited from StatementRole (via SelectBase, Executable):

Class Variable	`_propagate_attrs`	Undocumented
Class Variable	`_role_name`	Undocumented

Inherited from SQLRole (via SelectBase, Executable, StatementRole):

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

Inherited from Generative (via SelectBase, Executable):

Method _generate Undocumented

Inherited from SupportsCloneAnnotations (via SelectBase):

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

Inherited from SupportsAnnotations (via SelectBase, SupportsCloneAnnotations):

Property _annotations_cache_key Undocumented

Inherited from Selectable (via SelectBase):

Method	`corresponding_column`	No summary
Method	`replace_selectable`	Replace all occurrences of `_expression.FromClause` 'old' with the given `_expression.Alias` object, returning a copy of this `_expression.FromClause`.
Class Variable	`is_selectable`	Undocumented

Inherited from ReturnsRows (via SelectBase, Selectable):

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

Inherited from ReturnsRowsRole (via SelectBase, Selectable, ReturnsRows):

Class Variable _role_name Undocumented

Inherited from SQLRole (via SelectBase, Selectable, ReturnsRows, ReturnsRowsRole):

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

Inherited from ClauseElement (via SelectBase, Selectable, ReturnsRows):

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	`_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	`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 SelectBase, Selectable, ReturnsRows, ClauseElement):

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

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

Property _annotations_cache_key Undocumented

Inherited from MemoizedHasCacheKey (via SelectBase, Selectable, ReturnsRows, ClauseElement):

Method _generate_cache_key return a cache key.

Inherited from HasCacheKey (via SelectBase, Selectable, ReturnsRows, 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 SelectBase, Selectable, ReturnsRows, ClauseElement):

Method _copy_internals Reassign internal elements to be clones of themselves.

Inherited from Traversible (via SelectBase, Selectable, ReturnsRows, ClauseElement):

Method __class_getitem__ Undocumented

Inherited from Executable:

Method	`_add_context_option`	Add a context option to this statement.
Method	`_set_compile_options`	Assign the compile options to a new value.
Method	`_update_compile_options`	update the _compile_options with new keys.
Method	`execute`	Compile and execute this `.Executable`.
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.
Method	`scalar`	Compile and execute this `.Executable`, returning the result's scalar representation.
Class Variable	`_bind`	Undocumented
Class Variable	`_executable_traverse_internals`	Undocumented
Class Variable	`_with_context_options`	Undocumented
Class Variable	`_with_options`	Undocumented
Class Variable	`is_delete`	Undocumented
Class Variable	`is_dml`	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
Instance Variable	`_compile_options`	Undocumented
Instance Variable	`_execution_options`	Undocumented
Property	`_effective_plugin_target`	Undocumented
Property	`bind`	Returns the `_engine.Engine` or `_engine.Connection` to which this `.Executable` is bound, or None if none found.

Inherited from StatementRole (via Executable):

Class Variable	`_propagate_attrs`	Undocumented
Class Variable	`_role_name`	Undocumented

Inherited from SQLRole (via Executable, StatementRole):

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

Inherited from Generative (via Executable):

Method _generate Undocumented

def __init__(self, entities, element):

Undocumented

def _compiler_dispatch(self, compiler, **kw):

provide a fixed _compiler_dispatch method.

This is roughly similar to using the sqlalchemy.ext.compiler @compiles extension.

def _ensure_disambiguated_names(self):

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 get_children(self, **kw):

overrides sqlalchemy.sql.visitors.Traversible.get_children

Return immediate child .visitors.Traversible elements of this .visitors.Traversible.

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

def get_label_style(self):

Undocumented

def set_label_style(self, label_style):

Undocumented

__visit_name__: str =

overrides sqlalchemy.sql.expression.Selectable.__visit_name__

Undocumented

_cache_key_traversal =

overrides sqlalchemy.sql.expression.ClauseElement._cache_key_traversal

Undocumented

_for_update_arg =

Undocumented

_traverse_internals =

Undocumented

_raw_columns =

Undocumented

element =

Undocumented

@property
_inline =

Undocumented

@property
_label_style =

Undocumented

@property
_returning =

Undocumented