sqlalchemy.sql.dml.DMLWhereBase

class documentation

class DMLWhereBase: (source)

Known subclasses: sqlalchemy.sql.dml.Delete, sqlalchemy.sql.dml.Update

View In Hierarchy

Undocumented

Method filter A synonym for the :meth:`_dml.DMLWhereBase.where` method.
Method filter_by apply the given filtering criterion as a WHERE clause to this select.
Method where Return a new construct with the given expression(s) added to its WHERE clause, joined to the existing clause via AND, if any.
Class Variable table Undocumented
Property whereclause Return the completed WHERE clause for this :class:`.DMLWhereBase` statement.
Method _filter_by_zero Undocumented
Class Variable _where_criteria Undocumented
def filter(self, *criteria: roles.ExpressionElementRole[Any]) -> Self: (source)

A synonym for the :meth:`_dml.DMLWhereBase.where` method. .. versionadded:: 1.4

def filter_by(self, **kwargs: Any) -> Self: (source)

apply the given filtering criterion as a WHERE clause to this select.

@_generative
def where(self, *whereclause: _ColumnExpressionArgument[bool]) -> Self: (source)

Return a new construct with the given expression(s) added to its WHERE clause, joined to the existing clause via AND, if any. Both :meth:`_dml.Update.where` and :meth:`_dml.Delete.where` support multiple-table forms, including database-specific ``UPDATE...FROM`` as well as ``DELETE..USING``. For backends that don't have multiple-table support, a backend agnostic approach to using multiple tables is to make use of correlated subqueries. See the linked tutorial sections below for examples. .. seealso:: :ref:`tutorial_correlated_updates` :ref:`tutorial_update_from` :ref:`tutorial_multi_table_deletes`

table: _DMLTableElement = (source)
overridden in sqlalchemy.sql.dml.Delete

Undocumented

@property
whereclause: Optional[ColumnElement[Any]] = (source)

Return the completed WHERE clause for this :class:`.DMLWhereBase` statement. This assembles the current collection of WHERE criteria into a single :class:`_expression.BooleanClauseList` construct. .. versionadded:: 1.4

def _filter_by_zero(self) -> _DMLTableElement: (source)

Undocumented

_where_criteria: Tuple[ColumnElement[Any], ...] = (source)

Undocumented