sqlalchemy.sql.expression.Delete

class documentation

class Delete(DMLWhereBase, UpdateBase):

Represent a DELETE construct.

The _expression.Delete object is created using the _expression.delete() function.

Method	`__init__`	Construct `_expression.Delete` object.
Class Variable	`__visit_name__`	Undocumented
Class Variable	`_traverse_internals`	Undocumented
Class Variable	`is_delete`	Undocumented
Instance Variable	`_bind`	Undocumented
Instance Variable	`_returning`	Undocumented
Instance Variable	`table`	Undocumented

Inherited from DMLWhereBase:

Method	`_filter_by_zero`	Undocumented
Method	`filter`	A synonym for the `_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	`_where_criteria`	Undocumented
Property	`whereclause`	Return the completed WHERE clause for this `.DMLWhereBase` statement.

Inherited from UpdateBase:

Class Method	`_constructor_20_deprecations`	Undocumented
Method	`_generate_fromclause_column_proxies`	Undocumented
Method	`_set_bind`	Undocumented
Method	`_validate_dialect_kwargs_deprecated`	Undocumented
Method	`bind`	Return a 'bind' linked to this `.UpdateBase` or a `_schema.Table` associated with it.
Method	`params`	Set the parameters for the statement.
Method	`returning`	Add a :term:`RETURNING` or equivalent clause to this statement.
Method	`with_dialect_options`	Add dialect options to this INSERT/UPDATE/DELETE object.
Method	`with_hint`	Add a table hint for a single table to this INSERT/UPDATE/DELETE statement.
Class Variable	`_execution_options`	Undocumented
Class Variable	`_return_defaults`	Undocumented
Class Variable	`_return_defaults_columns`	Undocumented
Class Variable	`is_dml`	Undocumented
Class Variable	`named_with_column`	Undocumented
Instance Variable	`_hints`	Undocumented
Property	`_all_selected_columns`	A sequence of column expression objects that represents the "selected" columns of this `_expression.ReturnsRows`.
Property	`exported_columns`	Return the RETURNING columns as a column collection for this statement.

Inherited from StatementRole (via UpdateBase, DMLRole):

Class Variable	`_propagate_attrs`	Undocumented
Class Variable	`_role_name`	Undocumented

Inherited from SQLRole (via UpdateBase, DMLRole, StatementRole):

Class Variable	`allows_lambda`	Undocumented
Class Variable	`uses_inspection`	Undocumented

Inherited from HasCTE (via UpdateBase):

Method	`add_cte`	Add a `_sql.CTE` to this statement object that will be independently rendered even if not referenced in the statement otherwise.
Method	`cte`	Return a new `_expression.CTE`, or Common Table Expression instance.
Class Variable	`_has_ctes_traverse_internals`	Undocumented
Class Variable	`_independent_ctes`	Undocumented

Inherited from ReturnsRowsRole (via UpdateBase, HasCTE, HasCTERole):

Class Variable _role_name Undocumented

Inherited from SQLRole (via UpdateBase, HasCTE, HasCTERole, ReturnsRowsRole):

Class Variable	`allows_lambda`	Undocumented
Class Variable	`uses_inspection`	Undocumented

Inherited from HasCompileState (via UpdateBase):

Class Variable	`_attributes`	Undocumented
Class Variable	`_compile_state_plugin`	Undocumented

Inherited from Generative (via UpdateBase, HasCompileState):

Method _generate Undocumented

Inherited from DialectKWArgs (via UpdateBase):

Class Method	`argument_for`	Add a new kind of dialect-specific keyword argument for this class.
Method	`_kw_reg_for_dialect_cls`	Undocumented
Method	`_validate_dialect_kwargs`	Undocumented
Class Variable	`_dialect_kwargs_traverse_internals`	Undocumented
Class Variable	`_kw_registry`	Undocumented
Property	`dialect_kwargs`	A collection of keyword arguments specified as dialect-specific options to this construct.
Property	`dialect_options`	A collection of keyword arguments specified as dialect-specific options to this construct.
Property	`kwargs`	A synonym for `.DialectKWArgs.dialect_kwargs`.

Inherited from HasPrefixes (via UpdateBase):

Method	`_setup_prefixes`	Undocumented
Method	`prefix_with`	Add one or more expressions following the statement keyword, i.e. SELECT, INSERT, UPDATE, or DELETE. Generative.
Class Variable	`_has_prefixes_traverse_internals`	Undocumented
Instance Variable	`_prefixes`	Undocumented

Inherited from ReturnsRows (via UpdateBase):

Class Variable	`_is_from_clause`	Undocumented
Class Variable	`_is_lateral`	Undocumented
Class Variable	`_is_returns_rows`	Undocumented
Class Variable	`_is_select_statement`	Undocumented
Property	`selectable`	Undocumented

Inherited from ReturnsRowsRole (via UpdateBase, ReturnsRows):

Class Variable _role_name Undocumented

Inherited from SQLRole (via UpdateBase, ReturnsRows, ReturnsRowsRole):

Class Variable	`allows_lambda`	Undocumented
Class Variable	`uses_inspection`	Undocumented

Inherited from ClauseElement (via UpdateBase, ReturnsRows):

Method	`compare`	Compare this `_expression.ClauseElement` to the given `_expression.ClauseElement`.
Method	`compile`	Compile this SQL expression.
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	`__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	`_from_objects`	Undocumented
Class Variable	`_is_bind_parameter`	Undocumented
Class Variable	`_is_clause_list`	Undocumented
Class Variable	`_is_clone_of`	Undocumented
Class Variable	`_is_from_container`	Undocumented
Class Variable	`_is_immutable`	Undocumented
Class Variable	`_is_lambda_element`	Undocumented
Class Variable	`_is_select_container`	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	`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 UpdateBase, ReturnsRows, ClauseElement):

Class Variable	`allows_lambda`	Undocumented
Class Variable	`uses_inspection`	Undocumented

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

Property _annotations_cache_key Undocumented

Inherited from MemoizedHasCacheKey (via UpdateBase, ReturnsRows, ClauseElement):

Method _generate_cache_key return a cache key.

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

Method _copy_internals Reassign internal elements to be clones of themselves.

Inherited from Traversible (via UpdateBase, ReturnsRows, ClauseElement):

Method	`get_children`	Return immediate child `.visitors.Traversible` elements of this `.visitors.Traversible`.
Method	`__class_getitem__`	Undocumented

Inherited from Executable (via UpdateBase):

Method	`_add_context_option`	Add a context option to this statement.
Method	`_set_compile_options`	Assign the compile options to a new value.
Method	`_update_compile_options`	update the _compile_options with new keys.
Method	`execute`	Compile and execute this `.Executable`.
Method	`execution_options`	Set non-SQL options for the statement which take effect during execution.
Method	`get_execution_options`	Get the non-SQL options which will take effect during execution.
Method	`options`	Apply options to this statement.
Method	`scalar`	Compile and execute this `.Executable`, returning the result's scalar representation.
Class Variable	`_executable_traverse_internals`	Undocumented
Class Variable	`_with_context_options`	Undocumented
Class Variable	`_with_options`	Undocumented
Class Variable	`is_insert`	Undocumented
Class Variable	`is_select`	Undocumented
Class Variable	`is_text`	Undocumented
Class Variable	`is_update`	Undocumented
Class Variable	`supports_execution`	Undocumented
Instance Variable	`_compile_options`	Undocumented
Property	`_effective_plugin_target`	Undocumented

Inherited from StatementRole (via UpdateBase, Executable):

Class Variable	`_propagate_attrs`	Undocumented
Class Variable	`_role_name`	Undocumented

Inherited from SQLRole (via UpdateBase, Executable, StatementRole):

Class Variable	`allows_lambda`	Undocumented
Class Variable	`uses_inspection`	Undocumented

Inherited from Generative (via UpdateBase, Executable):

Method _generate Undocumented

Inherited from ClauseElement (via UpdateBase):

Method	`compare`	Compare this `_expression.ClauseElement` to the given `_expression.ClauseElement`.
Method	`compile`	Compile this SQL expression.
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	`__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	`_from_objects`	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_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	`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 UpdateBase, ClauseElement):

Class Variable	`allows_lambda`	Undocumented
Class Variable	`uses_inspection`	Undocumented

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

Property _annotations_cache_key Undocumented

Inherited from MemoizedHasCacheKey (via UpdateBase, ClauseElement):

Method _generate_cache_key return a cache key.

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

Method _copy_internals Reassign internal elements to be clones of themselves.

Inherited from Traversible (via UpdateBase, ClauseElement):

Method	`get_children`	Return immediate child `.visitors.Traversible` elements of this `.visitors.Traversible`.
Method	`__class_getitem__`	Undocumented

@ValuesBase._constructor_20_deprecations('delete', 'Delete', ['whereclause', 'values', 'bind', 'prefixes', 'returning'])
def __init__(self, table, whereclause=None, bind=None, returning=None, prefixes=None, **dialect_kw):

Construct _expression.Delete object.

E.g.:

from sqlalchemy import delete

stmt = (
    delete(user_table).
    where(user_table.c.id == 5)
)

Similar functionality is available via the _expression.TableClause.delete method on _schema.Table.

Parameters
table	The table to delete rows from.
whereclause	Optional SQL expression describing the `WHERE` condition of the `DELETE` statement; is equivalent to using the more modern `~Delete.where()` method to specify the `WHERE` clause.
bind	Undocumented
returning	Undocumented
prefixes	Undocumented
**dialect_kw	Undocumented