Struct DeleteBuilder 

pub struct DeleteBuilder<'a, M: Model> { /* private fields */ }

DELETE query builder.

Example

// Delete by filter
delete!(Hero)
    .filter(Expr::col("age").lt(18))
    .execute(cx, &conn).await?;

// Delete a specific model instance
DeleteBuilder::from_model(&hero)
    .execute(cx, &conn).await?;

// Delete with RETURNING
let rows = delete!(Hero)
    .filter(Expr::col("status").eq("inactive"))
    .returning()
    .execute_returning(cx, &conn).await?;

Implementations

impl<'a, M: Model> DeleteBuilder<'a, M>

pub fn new() -> Self

Create a new DELETE builder for the model type.

pub fn from_model(model: &'a M) -> Self

Create a DELETE builder for a specific model instance.

This automatically adds a WHERE clause matching the primary key.

pub fn filter(self, expr: Expr) -> Self

Add a WHERE condition.

pub fn returning(self) -> Self

Add RETURNING * clause to return the deleted row(s).

pub fn build(&self) -> (String, Vec<Value>)

Build the DELETE SQL and parameters with default dialect (Postgres).

pub fn build_with_dialect(&self, dialect: Dialect) -> (String, Vec<Value>)

Build the DELETE SQL and parameters with specific dialect.

pub async fn execute<C: Connection>( self, cx: &Cx, conn: &C, ) -> Outcome<u64, Error>

Execute the DELETE and return rows affected.

Joined-table inheritance semantics:

• Filters select target child primary keys from a base+child join.
• Deletion always removes matching child rows and their parent rows in one transaction.

pub async fn execute_returning<C: Connection>( self, cx: &Cx, conn: &C, ) -> Outcome<Vec<Row>, Error>

Execute the DELETE with RETURNING and get the deleted rows.

For joined-table inheritance child models, returned rows are projected with both child and parent prefixes (table__column) before the delete is applied.

Trait Implementations

impl<'a, M: Debug + Model> Debug for DeleteBuilder<'a, M>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<M: Model> Default for DeleteBuilder<'_, M>

fn default() -> Self

Returns the “default value” for a type.