Class Delete

lib/sqlalchemy/sql/dml.py:1842–2006

Represent a DELETE construct. The :class:`_expression.Delete` object is created using the :func:`_expression.delete()` function. Available extension points: * ``post_criteria``: applies additional logic after the ``WHERE`` clause.

class Delete(
    DMLWhereBase, UpdateBase, HasSyntaxExtensions[Literal["post_criteria"]]
):
    """Represent a DELETE construct.

    The :class:`_expression.Delete` object is created using the
    :func:`_expression.delete()` function.

    Available extension points:

    * ``post_criteria``: applies additional logic after the ``WHERE`` clause.

    """

    __visit_name__ = "delete"

    is_delete = True

    _traverse_internals = (
        [
            ("table", InternalTraversal.dp_clauseelement),
            ("_extra_froms", InternalTraversal.dp_clauseelement_tuple),
            ("_where_criteria", InternalTraversal.dp_clauseelement_tuple),
            ("_returning", InternalTraversal.dp_clauseelement_tuple),
            ("_hints", InternalTraversal.dp_table_hint_list),
            ("_post_criteria_clause", InternalTraversal.dp_clauseelement),
        ]
        + HasPrefixes._has_prefixes_traverse_internals
        + DialectKWArgs._dialect_kwargs_traverse_internals
        + ExecutableStatement._executable_traverse_internals
        + HasCTE._has_ctes_traverse_internals
    )

    _position_map = util.immutabledict(
        {"post_criteria": "_post_criteria_clause"}
    )

    _extra_froms: Tuple[FromClause, ...] = ()

    def __init__(self, table: _DMLTableArgument):
        self.table = coercions.expect(
            roles.DMLTableRole, table, apply_propagate_attrs=self
        )

    @_generative
    def using(self, *froms: _FromClauseArgument) -> Self:
        r"""Add one or more explicit ``USING`` expressions to this DELETE.

        This method may be used for backend-specific multiple-table DELETE
        forms where the secondary FROM expression needs to be stated
        explicitly, such as MySQL&#x27;s ``DELETE FROM table USING <join>`` form.

        .. versionadded:: 2.1

        .. seealso::

            :ref:`tutorial_multi_table_deletes`