class documentation

class LambdaElement(elements.ClauseElement):

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

View In Hierarchy

A SQL construct where the state is stored as an un-invoked lambda.

The _sql.LambdaElement is produced transparently whenever passing lambda expressions into SQL constructs, such as:

stmt = select(table).where(lambda: table.c.col == parameter)

The _sql.LambdaElement is the base of the _sql.StatementLambdaElement which represents a full statement within a lambda.

New in version 1.4.
Method __getattr__ Undocumented
Method __init__ Undocumented
Method __repr__ 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 __visit​_name__ Undocumented
Class Variable ​_is​_lambda​_element Undocumented
Class Variable ​_transforms Undocumented
Class Variable ​_traverse​_internals Undocumented
Class Variable parent​_lambda Undocumented
Instance Variable ​_rec Undocumented
Instance Variable ​_resolved​_bindparams Undocumented
Instance Variable closure​_cache​_key Undocumented
Instance Variable fn Undocumented
Instance Variable opts Undocumented
Instance Variable role Undocumented
Instance Variable tracker​_key Undocumented
Property ​_from​_objects Undocumented
Property ​_is​_sequence Undocumented
Property ​_resolved Undocumented
Property ​_select​_iterable Undocumented

Inherited from ClauseElement:

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 __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 ​_cache​_key​_traversal Undocumented
Class Variable ​_is​_bind​_parameter Undocumented
Class Variable ​_is​_clause​_list Undocumented
Class Variable ​_is​_clone​_of Undocumented
Class Variable ​_is​_from​_clause Undocumented
Class Variable ​_is​_from​_container Undocumented
Class Variable ​_is​_immutable Undocumented
Class Variable ​_is​_returns​_rows Undocumented
Class Variable ​_is​_select​_container Undocumented
Class Variable ​_is​_select​_statement 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 is​_selectable 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 ClauseElement):

Class Variable allows​_lambda Undocumented
Class Variable uses​_inspection Undocumented

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

Property ​_annotations​_cache​_key Undocumented

Inherited from MemoizedHasCacheKey (via ClauseElement):

Method ​_generate​_cache​_key return a cache key.

Inherited from HasCacheKey (via 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
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 Traversible (via ClauseElement):

Method get​_children Return immediate child .visitors.Traversible elements of this .visitors.Traversible.
Method __class​_getitem__ Undocumented
def __getattr__(self, key):

Undocumented

def __init__(self, fn, role, opts=LambdaOptions, apply_propagate_attrs=None):
def __repr__(self):
def _copy_internals(self, clone=_clone, deferred_copy_internals=None, **kw):

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

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.

def _invoke_user_fn(self, fn, *arg):
def _param_dict(self):

Undocumented

def _retrieve_tracker_rec(self, fn, apply_propagate_attrs, opts):

Undocumented

def _setup_binds_for_tracked_expr(self, expr):

Undocumented

__visit_name__: str =
_is_lambda_element: bool =
_transforms: tuple =

Undocumented

_traverse_internals =

Undocumented

parent_lambda =

Undocumented

_rec =

Undocumented

_resolved_bindparams: list =

Undocumented

closure_cache_key =

Undocumented

fn =

Undocumented

opts =

Undocumented

role =

Undocumented

tracker_key =

Undocumented

@property
_from_objects =
@property
_is_sequence =

Undocumented

@util.memoized_property
_resolved =

Undocumented

@property
_select_iterable =

Undocumented