sqlalchemy.sql.elements.ClauseList

class documentation

class ClauseList(roles.InElementRole, roles.OrderByRole, roles.ColumnsClauseRole, roles.DMLColumnRole, ClauseElement):

Known subclasses: sqlalchemy.dialects.postgresql.array, sqlalchemy.sql.elements.Tuple, sqlalchemy.sql.elements.BooleanClauseList

View In Hierarchy

Describe a list of clauses, separated by an operator.

By default, is comma-separated, such as a column listing.

Class Method ​_construct​_raw Undocumented
Method __init__ Undocumented
Method __iter__ Undocumented
Method __len__ Undocumented
Method append Undocumented
Method self​_group Apply a 'grouping' to this _expression.ClauseElement.
Class Variable __visit​_name__ Undocumented
Class Variable ​_is​_clause​_list Undocumented
Class Variable ​_traverse​_internals Undocumented
Instance Variable ​_is​_implicitly​_boolean Undocumented
Instance Variable ​_text​_converter​_role Undocumented
Instance Variable clauses Undocumented
Instance Variable group Undocumented
Instance Variable group​_contents Undocumented
Instance Variable operator Undocumented
Property ​_from​_objects Undocumented
Property ​_select​_iterable Undocumented

Inherited from InElementRole:

Class Variable ​_role​_name Undocumented

Inherited from SQLRole (via InElementRole):

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

Inherited from OrderByRole:

Class Variable ​_role​_name Undocumented

Inherited from AllowsLambdaRole (via OrderByRole):

Class Variable allows​_lambda Undocumented

Inherited from SQLRole (via OrderByRole, ByOfRole, ColumnListRole):

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

Inherited from ColumnsClauseRole:

Class Variable ​_role​_name Undocumented

Inherited from AllowsLambdaRole (via ColumnsClauseRole):

Class Variable allows​_lambda Undocumented

Inherited from UsesInspection (via ColumnsClauseRole):

Class Variable ​_post​_inspect Undocumented
Class Variable uses​_inspection Undocumented

Inherited from SQLRole (via ColumnsClauseRole, ColumnListRole):

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

Inherited from DMLColumnRole:

Class Variable ​_role​_name Undocumented

Inherited from SQLRole (via DMLColumnRole):

Class Variable allows​_lambda Undocumented
Class Variable uses​_inspection 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 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 ​_cache​_key​_traversal Undocumented
Class Variable ​_is​_bind​_parameter 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​_lambda​_element 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
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 ClauseElement):

Method ​_copy​_internals Reassign internal elements to be clones of themselves.

Inherited from Traversible (via ClauseElement):

Method get​_children Return immediate child .visitors.Traversible elements of this .visitors.Traversible.
Method __class​_getitem__ Undocumented
@classmethod
def _construct_raw(cls, operator, clauses=None):
overridden in sqlalchemy.sql.elements.BooleanClauseList

Undocumented

def __init__(self, *clauses, **kwargs):
overridden in sqlalchemy.dialects.postgresql.array, sqlalchemy.sql.elements.Tuple, sqlalchemy.sql.elements.BooleanClauseList

Undocumented

def __iter__(self):

Undocumented

def __len__(self):

Undocumented

def append(self, clause):

Undocumented

def self_group(self, against=None):
overrides sqlalchemy.sql.expression.ClauseElement.self_group
overridden in sqlalchemy.dialects.postgresql.array, sqlalchemy.sql.elements.Tuple, sqlalchemy.sql.elements.BooleanClauseList

Apply a 'grouping' to this _expression.ClauseElement.

This method is overridden by subclasses to return a "grouping" construct, i.e. parenthesis. In particular it's used by "binary" expressions to provide a grouping around themselves when placed into a larger expression, as well as by _expression.select constructs when placed into the FROM clause of another _expression.select. (Note that subqueries should be normally created using the _expression.Select.alias method, as many platforms require nested SELECT statements to be named).

As expressions are composed together, the application of self_group is automatic - end-user code should never need to use this method directly. Note that SQLAlchemy's clause constructs take operator precedence into account - so parenthesis might not be needed, for example, in an expression like x OR (y AND z) - AND takes precedence over OR.

The base self_group method of _expression.ClauseElement just returns self.

__visit_name__: str =
overrides sqlalchemy.sql.expression.ClauseElement.__visit_name__
overridden in sqlalchemy.dialects.postgresql.array, sqlalchemy.sql.elements.Tuple, sqlalchemy.sql.elements.BooleanClauseList

Undocumented

_is_clause_list: bool =
overrides sqlalchemy.sql.expression.ClauseElement._is_clause_list

Undocumented

_traverse_internals =
overridden in sqlalchemy.sql.elements.Tuple

Undocumented

_is_implicitly_boolean: bool =
overridden in sqlalchemy.sql.elements.BooleanClauseList

Undocumented

_text_converter_role =

Undocumented

clauses =
overridden in sqlalchemy.sql.elements.BooleanClauseList

Undocumented

group: bool =
overridden in sqlalchemy.sql.elements.BooleanClauseList

Undocumented

group_contents: bool =
overridden in sqlalchemy.sql.elements.BooleanClauseList

Undocumented

operator =
overridden in sqlalchemy.sql.elements.BooleanClauseList

Undocumented

@property
_from_objects =
overrides sqlalchemy.sql.expression.ClauseElement._from_objects

Undocumented

@property
_select_iterable =
overrides sqlalchemy.sql.roles.ColumnsClauseRole._select_iterable
overridden in sqlalchemy.dialects.postgresql.array, sqlalchemy.sql.elements.Tuple, sqlalchemy.sql.elements.BooleanClauseList

Undocumented