sqlalchemy.sql.lambdas.LambdaElement

class documentation

class LambdaElement(elements.ClauseElement): (source)

Known subclasses: sqlalchemy.sql.lambdas.DeferredLambdaElement, sqlalchemy.sql.lambdas.StatementLambdaElement

A SQL construct where the state is stored as an un-invoked lambda. The :class:`_sql.LambdaElement` is produced transparently whenever passing lambda expressions into SQL constructs, such as:: stmt = select(table).where(lambda: table.c.col == parameter) The :class:`_sql.LambdaElement` is the base of the :class:`_sql.StatementLambdaElement` which represents a full statement within a lambda. .. versionadded:: 1.4 .. seealso:: :ref:`engine_lambda_caching`

Method	`__getattr__`	Undocumented
Method	`__init__`	Undocumented
Method	`__repr__`	Undocumented
Class Variable	`__visit_name__`	Undocumented
Class Variable	`parent_lambda`	Undocumented
Instance Variable	`closure_cache_key`	Undocumented
Instance Variable	`fn`	Undocumented
Instance Variable	`opts`	Undocumented
Instance Variable	`role`	Undocumented
Instance Variable	`tracker_key`	Undocumented
Method	`_copy_internals`	Reassign internal elements to be clones of themselves.
Method	`_gen_cache_key`	return an optional cache key.
Method	`_invoke_user_fn`	Undocumented
Method	`_param_dict`	Undocumented
Method	`_retrieve_tracker_rec`	Undocumented
Method	`_setup_binds_for_tracked_expr`	Undocumented
Class Variable	`_is_lambda_element`	Undocumented
Class Variable	`_transforms`	Undocumented
Class Variable	`_traverse_internals`	Undocumented
Instance Variable	`_rec`	Undocumented
Instance Variable	`_resolved_bindparams`	Undocumented
Property	`_from_objects`	Undocumented
Property	`_is_sequence`	Undocumented
Property	`_resolved`	Undocumented
Property	`_select_iterable`	Undocumented

Inherited from ClauseElement:

Method	`__bool__`	Undocumented
Method	`__getstate__`	Undocumented
Method	`__invert__`	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	`self_group`	Apply a 'grouping' to this :class:`_expression.ClauseElement`.
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	`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	`_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	`_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_from_clause`	Undocumented
Class Variable	`_is_from_container`	Undocumented
Class Variable	`_is_immutable`	Undocumented
Class Variable	`_is_keyed_column_element`	Undocumented
Class Variable	`_is_returns_rows`	Undocumented
Class Variable	`_is_select_base`	Undocumented
Class Variable	`_is_select_container`	Undocumented
Class Variable	`_is_select_statement`	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 ClauseElement):

Class Variable	`__slots__`	Undocumented
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 ClauseElement, SupportsWrappingAnnotations):

Class Variable	`proxy_set`	Undocumented
Method	`_gen_annotations_cache_key`	Undocumented
Property	`_annotations_cache_key`	Undocumented

Inherited from MemoizedHasCacheKey (via ClauseElement, SupportsWrappingAnnotations, SupportsAnnotations):

Method _generate_cache_key return a cache key.

Inherited from HasCacheKey (via 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
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 CompilerElement (via ClauseElement, SupportsWrappingAnnotations, SupportsAnnotations, MemoizedHasCacheKey, HasCacheKey, HasCopyInternals, ExternallyTraversible, HasTraverseInternals):

Method	`__str__`	Undocumented
Method	`compile`	Compile this SQL expression.
Class Variable	`stringify_dialect`	Undocumented
Class Variable	`supports_execution`	Undocumented
Method	`_compiler`	Return a compiler appropriate for this ClauseElement, given a Dialect.

Inherited from Visitable (via 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 __getattr__(self, key): (source) ¶

Undocumented

def __init__(self, fn: _LambdaType, role: Type[SQLRole], opts: Union[Type[LambdaOptions], LambdaOptions] = LambdaOptions, apply_propagate_attrs: Optional[ClauseElement] = None): (source) ¶

overridden in sqlalchemy.sql.lambdas.DeferredLambdaElement, sqlalchemy.sql.lambdas.StatementLambdaElement

Undocumented

def __repr__(self): (source) ¶

overrides sqlalchemy.sql.elements.ClauseElement.__repr__

Undocumented

__visit_name__: str = (source) ¶

overrides sqlalchemy.sql.elements.ClauseElement.__visit_name__

Undocumented

parent_lambda: Optional[StatementLambdaElement] = (source) ¶

overridden in sqlalchemy.sql.lambdas.LinkedLambdaElement

Undocumented

closure_cache_key = (source) ¶

Undocumented

fn = (source) ¶

overridden in sqlalchemy.sql.lambdas.LinkedLambdaElement

Undocumented

opts = (source) ¶

overridden in sqlalchemy.sql.lambdas.LinkedLambdaElement

Undocumented

role = (source) ¶

Undocumented

tracker_key = (source) ¶

overridden in sqlalchemy.sql.lambdas.LinkedLambdaElement

Undocumented

def _copy_internals(self, clone: _CloneCallableType = _clone, deferred_copy_internals: Optional[_CloneCallableType] = None, **kw: Any): (source) ¶

overrides sqlalchemy.sql.traversals.HasCopyInternals._copy_internals

overridden in sqlalchemy.sql.lambdas.DeferredLambdaElement

Reassign internal elements to be clones of themselves. Called during a copy-and-traverse operation on newly shallow-copied elements to create a deep copy. The given clone function should be used, which may be applying additional transformations to the element (i.e. replacement traversal, cloned traversal, annotations).

def _gen_cache_key(self, anon_map, bindparams): (source) ¶

overrides sqlalchemy.sql.cache_key.HasCacheKey._gen_cache_key

return an optional cache key. The cache key is a tuple which can contain any series of objects that are hashable and also identifies this object uniquely within the presence of a larger SQL expression or statement, for the purposes of caching the resulting query. The cache key should be based on the SQL compiled structure that would ultimately be produced. That is, two structures that are composed in exactly the same way should produce the same cache key; any difference in the structures that would affect the SQL string or the type handlers should result in a different cache key. If a structure cannot produce a useful cache key, the NO_CACHE symbol should be added to the anon_map and the method should return None.