Struct sea_query::query::DeleteStatement

pub struct DeleteStatement { /* fields omitted */ }

Delete existing rows from the table

Examples

use sea_query::{tests_cfg::*, *};

let query = Query::delete()
    .from_table(Glyph::Table)
    .or_where(Expr::col(Glyph::Id).lt(1))
    .or_where(Expr::col(Glyph::Id).gt(10))
    .to_owned();

assert_eq!(
    query.to_string(MysqlQueryBuilder),
    r#"DELETE FROM `glyph` WHERE `id` < 1 OR `id` > 10"#
);
assert_eq!(
    query.to_string(PostgresQueryBuilder),
    r#"DELETE FROM "glyph" WHERE "id" < 1 OR "id" > 10"#
);
assert_eq!(
    query.to_string(SqliteQueryBuilder),
    r#"DELETE FROM `glyph` WHERE `id` < 1 OR `id` > 10"#
);

Implementations

impl DeleteStatement

pub fn new() -> Self

Construct a new DeleteStatement

pub fn from_table<T>(&mut self, tbl_ref: T) -> &mut Self where
    T: IntoTableRef, 

Specify which table to delete from.

Examples

use sea_query::{tests_cfg::*, *};

let query = Query::delete()
    .from_table(Glyph::Table)
    .and_where(Expr::col(Glyph::Id).eq(1))
    .to_owned();

assert_eq!(
    query.to_string(MysqlQueryBuilder),
    r#"DELETE FROM `glyph` WHERE `id` = 1"#
);
assert_eq!(
    query.to_string(PostgresQueryBuilder),
    r#"DELETE FROM "glyph" WHERE "id" = 1"#
);
assert_eq!(
    query.to_string(SqliteQueryBuilder),
    r#"DELETE FROM `glyph` WHERE `id` = 1"#
);

pub fn limit(&mut self, limit: u64) -> &mut Self

Limit number of updated rows.

pub fn returning(&mut self, select: SelectStatement) -> &mut Self

RETURNING expressions. Postgres only.

use sea_query::{tests_cfg::*, *};

let query = Query::delete()
    .from_table(Glyph::Table)
    .and_where(Expr::col(Glyph::Id).eq(1))
    .returning(Query::select().column(Glyph::Id).take())
    .to_owned();

assert_eq!(
    query.to_string(MysqlQueryBuilder),
    r#"DELETE FROM `glyph` WHERE `id` = 1"#
);
assert_eq!(
    query.to_string(PostgresQueryBuilder),
    r#"DELETE FROM "glyph" WHERE "id" = 1 RETURNING "id""#
);
assert_eq!(
    query.to_string(SqliteQueryBuilder),
    r#"DELETE FROM `glyph` WHERE `id` = 1"#
);

pub fn returning_col<C>(&mut self, col: C) -> &mut Self where
    C: IntoIden, 

RETURNING a column after delete. Postgres only. Wrapper over DeleteStatement::returning().

use sea_query::{tests_cfg::*, *};

let query = Query::delete()
    .from_table(Glyph::Table)
    .and_where(Expr::col(Glyph::Id).eq(1))
    .returning_col(Glyph::Id)
    .to_owned();

assert_eq!(
    query.to_string(MysqlQueryBuilder),
    r#"DELETE FROM `glyph` WHERE `id` = 1"#
);
assert_eq!(
    query.to_string(PostgresQueryBuilder),
    r#"DELETE FROM "glyph" WHERE "id" = 1 RETURNING "id""#
);
assert_eq!(
    query.to_string(SqliteQueryBuilder),
    r#"DELETE FROM `glyph` WHERE `id` = 1"#
);

impl DeleteStatement

pub fn to_string<T: QueryBuilder>(&self, query_builder: T) -> String

pub fn build<T: QueryBuilder>(&self, query_builder: T) -> (String, Values)

pub fn build_any(&self, query_builder: &dyn QueryBuilder) -> (String, Values)

impl DeleteStatement

pub fn order_by<T>(&mut self, col: T, order: Order) -> &mut Self where
    T: IntoColumnRef, 

pub fn order_by_tbl<T, C>(
    &mut self,
    table: T,
    col: C,
    order: Order
) -> &mut Self where
    T: IntoIden,
    C: IntoIden, 

👎 Deprecated since 0.9.0:

Please use the [OrderedStatement::order_by] with a tuple as [ColumnRef]

pub fn order_by_expr(&mut self, expr: SimpleExpr, order: Order) -> &mut Self

pub fn order_by_customs<T>(&mut self, cols: Vec<(T, Order)>) -> &mut Self where
    T: ToString, 

pub fn order_by_columns<T>(&mut self, cols: Vec<(T, Order)>) -> &mut Self where
    T: IntoColumnRef, 

pub fn order_by_table_columns<T, C>(
    &mut self,
    cols: Vec<(T, C, Order)>
) -> &mut Self where
    T: IntoIden,
    C: IntoIden, 

👎 Deprecated since 0.9.0:

Please use the [OrderedStatement::order_by_columns] with a tuple as [ColumnRef]

impl DeleteStatement

pub fn and_where(&mut self, other: SimpleExpr) -> &mut Self

pub fn and_where_option(&mut self, other: Option<SimpleExpr>) -> &mut Self

pub fn or_where(&mut self, other: SimpleExpr) -> &mut Self

👎 Deprecated since 0.12.0:

Please use [ConditionalStatement::cond_where]. Calling or_where after and_where will panic.

pub fn cond_where<C>(&mut self, condition: C) -> &mut Self where
    C: IntoCondition, 

Trait Implementations

impl Clone for DeleteStatement

fn clone(&self) -> DeleteStatement

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConditionalStatement for DeleteStatement

fn and_or_where(&mut self, condition: LogicalChainOper) -> &mut Self

fn cond_where<C>(&mut self, condition: C) -> &mut Self where
    C: IntoCondition, 

Where condition, expressed with any and all. Calling cond_where multiple times will conjoin them. Calling or_where after cond_where will panic.

fn and_where(&mut self, other: SimpleExpr) -> &mut Self

And where condition. This cannot be mixed with ConditionalStatement::or_where. Calling or_where after and_where will panic.

fn and_where_option(&mut self, other: Option<SimpleExpr>) -> &mut Self

Optional and where, short hand for if c.is_some() q.and_where(c).

fn or_where(&mut self, other: SimpleExpr) -> &mut Self

👎 Deprecated since 0.12.0:

Please use [ConditionalStatement::cond_where]. Calling or_where after and_where will panic.

Or where condition. This cannot be mixed with ConditionalStatement::and_where. Calling or_where after and_where will panic.

impl Debug for DeleteStatement

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

Formats the value using the given formatter.

impl Default for DeleteStatement

fn default() -> Self

Returns the “default value” for a type.

impl OrderedStatement for DeleteStatement

fn add_order_by(&mut self, order: OrderExpr) -> &mut Self

fn order_by<T>(&mut self, col: T, order: Order) -> &mut Self where
    T: IntoColumnRef, 

Order by column.

fn order_by_tbl<T, C>(&mut self, table: T, col: C, order: Order) -> &mut Self where
    T: IntoIden,
    C: IntoIden, 

👎 Deprecated since 0.9.0:

Please use the [OrderedStatement::order_by] with a tuple as [ColumnRef]

fn order_by_expr(&mut self, expr: SimpleExpr, order: Order) -> &mut Self

Order by SimpleExpr.

fn order_by_customs<T>(&mut self, cols: Vec<(T, Order)>) -> &mut Self where
    T: ToString, 

Order by custom string.

fn order_by_columns<T>(&mut self, cols: Vec<(T, Order)>) -> &mut Self where
    T: IntoColumnRef, 

Order by vector of columns.

fn order_by_table_columns<T, C>(
    &mut self,
    cols: Vec<(T, C, Order)>
) -> &mut Self where
    T: IntoIden,
    C: IntoIden, 

👎 Deprecated since 0.9.0:

Please use the [OrderedStatement::order_by_columns] with a tuple as [ColumnRef]

impl QueryStatementBuilder for DeleteStatement

fn build_collect<T: QueryBuilder>(
    &self,
    query_builder: T,
    collector: &mut dyn FnMut(Value)
) -> String

Build corresponding SQL statement for certain database backend and collect query parameters

Examples

use sea_query::{tests_cfg::*, *};

let query = Query::delete()
    .from_table(Glyph::Table)
    .and_where(Expr::col(Glyph::Id).eq(1))
    .to_owned();

assert_eq!(
    query.to_string(MysqlQueryBuilder),
    r#"DELETE FROM `glyph` WHERE `id` = 1"#
);

let mut params = Vec::new();
let mut collector = |v| params.push(v);

assert_eq!(
    query.build_collect(MysqlQueryBuilder, &mut collector),
    r#"DELETE FROM `glyph` WHERE `id` = ?"#
);
assert_eq!(params, vec![Value::Int(Some(1)),]);

fn build_collect_any(
    &self,
    query_builder: &dyn QueryBuilder,
    collector: &mut dyn FnMut(Value)
) -> String

Build corresponding SQL statement for certain database backend and collect query parameters

fn to_string<T: QueryBuilder>(&self, query_builder: T) -> String

Build corresponding SQL statement for certain database backend and return SQL string

fn build<T: QueryBuilder>(&self, query_builder: T) -> (String, Values)

Build corresponding SQL statement for certain database backend and collect query parameters into a vector

fn build_any(&self, query_builder: &dyn QueryBuilder) -> (String, Values)

Build corresponding SQL statement for certain database backend and collect query parameters into a vector