Struct Delete

pub struct Delete<'a> { /* private fields */ }

A builder for a DELETE statement.

Implementations

impl<'a> Delete<'a>

pub fn from_table<T>(table: T) -> Self

where T: Into<Table<'a>>,

Creates a new DELETE statement for the given table.

let query = Delete::from_table("users");
let (sql, _) = renderer::Postgres::build(query);

assert_eq!(r#"DELETE FROM "users""#, sql);

pub fn so_that<T>(&mut self, conditions: T)

where T: Into<ConditionTree<'a>>,

Adds WHERE conditions to the query. See Comparable for more examples.

let mut query = Delete::from_table("users");
query.so_that("bar".equals(false));

let (sql, params) = renderer::Postgres::build(query);

assert_eq!(r#"DELETE FROM "users" WHERE "bar" = $1"#, sql);
assert_eq!(vec![Value::from(false)], params);

pub fn returning<E, T>(&mut self, returning: T)

where T: IntoIterator<Item = E>, E: Into<Expression<'a>>,

Adds a RETURNING definition to the DELETE statement. Defines the return value of the query.

let mut query = Delete::from_table("users");
query.returning([Column::from("id"), Column::from("name")]);

let (sql, _) = renderer::Postgres::build(query);

assert_eq!(r#"DELETE FROM "users" RETURNING "id", "name""#, sql);

Trait Implementations

impl<'a> Clone for Delete<'a>

fn clone(&self) -> Delete<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for Delete<'a>

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

Formats the value using the given formatter.

impl<'a> From<Delete<'a>> for Query<'a>

fn from(delete: Delete<'a>) -> Self

Converts to this type from the input type.

impl<'a> PartialEq for Delete<'a>

fn eq(&self, other: &Delete<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> StructuralPartialEq for Delete<'a>