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 and_where(&mut self, other: SimpleExpr) -> &mut Self

And where condition.

Examples

use sea_query::{*, tests_cfg::*};
 
let query = Query::delete()
    .from_table(Glyph::Table)
    .and_where(Expr::col(Glyph::Id).gt(1))
    .and_where(Expr::col(Glyph::Id).lt(10))
    .to_owned();
 
assert_eq!(
    query.to_string(MysqlQueryBuilder),
    r#"DELETE FROM `glyph` WHERE (`id` > 1) AND (`id` < 10)"#
);
assert_eq!(
    query.to_string(PostgresQueryBuilder),
    r#"DELETE FROM "glyph" WHERE ("id" > 1) AND ("id" < 10)"#
);
assert_eq!(
    query.to_string(SqliteQueryBuilder),
    r#"DELETE FROM `glyph` WHERE (`id` > 1) AND (`id` < 10)"#
);

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

And where condition.

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)"#
);

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

Order by column.

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 [DeleteStatement::order_by] with a tuple as [ColumnRef]

Order by column with table name prefix.

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

Order by SimpleExpr.

pub fn order_by_customs<T, I>(&mut self, cols: I) -> &mut Self where
    T: ToString,
    I: IntoIterator<Item = (T, Order)>, 

Order by custom string.

pub fn order_by_columns<T, I>(&mut self, cols: I) -> &mut Self where
    T: IntoColumnRef,
    I: IntoIterator<Item = (T, Order)>, 

Order by columns.

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 [DeleteStatement::order_by_columns] with a tuple as [ColumnRef]

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

Limit number of updated rows.

pub 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(1),
    ]
);

pub 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

pub 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

Examples

use sea_query::{*, tests_cfg::*};
 
let (query, params) = Query::delete()
    .from_table(Glyph::Table)
    .and_where(Expr::col(Glyph::Id).eq(1))
    .build(MysqlQueryBuilder);
 
assert_eq!(
    query,
    r#"DELETE FROM `glyph` WHERE `id` = ?"#
);
assert_eq!(
    params,
    Values(vec![
        Value::Int(1),
    ])
);

pub 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

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

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

Examples

use sea_query::{*, tests_cfg::*};
 
let query = Query::delete()
    .from_table(Glyph::Table)
    .and_where(Expr::col(Glyph::Id).eq(1))
    .to_string(MysqlQueryBuilder);
 
assert_eq!(
    query,
    r#"DELETE FROM `glyph` WHERE `id` = 1"#
);

Trait Implementations

impl Clone for DeleteStatement

fn clone(&self) -> DeleteStatement

Returns a copy of the value.

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

Performs copy-assignment from source.

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.