Struct migration::DeleteStatement
pub struct DeleteStatement { /* private fields */ }
Expand description
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
impl DeleteStatement
pub fn new() -> DeleteStatement
pub fn new() -> DeleteStatement
Construct a new DeleteStatement
pub fn from_table<T>(&mut self, tbl_ref: T) -> &mut DeleteStatementwhere
T: IntoTableRef,
pub fn from_table<T>(&mut self, tbl_ref: T) -> &mut DeleteStatementwhere 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 DeleteStatement
pub fn limit(&mut self, limit: u64) -> &mut DeleteStatement
Limit number of updated rows.
pub fn returning(
&mut self,
returning_cols: ReturningClause
) -> &mut DeleteStatement
pub fn returning( &mut self, returning_cols: ReturningClause ) -> &mut DeleteStatement
RETURNING expressions.
Examples
use sea_query::{tests_cfg::*, *};
let query = Query::delete()
.from_table(Glyph::Table)
.and_where(Expr::col(Glyph::Id).eq(1))
.returning(Query::returning().columns([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 RETURNING "id""#
);
pub fn returning_col<C>(&mut self, col: C) -> &mut DeleteStatementwhere
C: IntoColumnRef,
pub fn returning_col<C>(&mut self, col: C) -> &mut DeleteStatementwhere C: IntoColumnRef,
RETURNING expressions for a column.
Examples
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 RETURNING "id""#
);
pub fn returning_all(&mut self) -> &mut DeleteStatement
pub fn returning_all(&mut self) -> &mut DeleteStatement
RETURNING expressions all columns.
Examples
use sea_query::{tests_cfg::*, *};
let query = Query::insert()
.into_table(Glyph::Table)
.columns([Glyph::Image])
.values_panic(vec!["12A".into()])
.returning_all()
.to_owned();
assert_eq!(
query.to_string(MysqlQueryBuilder),
"INSERT INTO `glyph` (`image`) VALUES ('12A')"
);
assert_eq!(
query.to_string(PostgresQueryBuilder),
r#"INSERT INTO "glyph" ("image") VALUES ('12A') RETURNING *"#
);
assert_eq!(
query.to_string(SqliteQueryBuilder),
r#"INSERT INTO "glyph" ("image") VALUES ('12A') RETURNING *"#
);
pub fn with(self, clause: WithClause) -> WithQuery
pub fn with(self, clause: WithClause) -> WithQuery
Create a WithQuery by specifying a WithClause to execute this query with.
Examples
use sea_query::{*, IntoCondition, IntoIden, tests_cfg::*};
let select = SelectStatement::new()
.columns([Glyph::Id])
.from(Glyph::Table)
.and_where(Expr::col(Glyph::Image).like("0%"))
.to_owned();
let cte = CommonTableExpression::new()
.query(select)
.column(Glyph::Id)
.table_name(Alias::new("cte"))
.to_owned();
let with_clause = WithClause::new().cte(cte).to_owned();
let update = DeleteStatement::new()
.from_table(Glyph::Table)
.and_where(Expr::col(Glyph::Id).in_subquery(SelectStatement::new().column(Glyph::Id).from(Alias::new("cte")).to_owned()))
.to_owned();
let query = update.with(with_clause);
assert_eq!(
query.to_string(MysqlQueryBuilder),
r#"WITH `cte` (`id`) AS (SELECT `id` FROM `glyph` WHERE `image` LIKE '0%') DELETE FROM `glyph` WHERE `id` IN (SELECT `id` FROM `cte`)"#
);
assert_eq!(
query.to_string(PostgresQueryBuilder),
r#"WITH "cte" ("id") AS (SELECT "id" FROM "glyph" WHERE "image" LIKE '0%') DELETE FROM "glyph" WHERE "id" IN (SELECT "id" FROM "cte")"#
);
assert_eq!(
query.to_string(SqliteQueryBuilder),
r#"WITH "cte" ("id") AS (SELECT "id" FROM "glyph" WHERE "image" LIKE '0%') DELETE FROM "glyph" WHERE "id" IN (SELECT "id" FROM "cte")"#
);
§impl DeleteStatement
impl DeleteStatement
pub fn to_string<T>(&self, query_builder: T) -> Stringwhere T: QueryBuilder,
pub fn build<T>(&self, query_builder: T) -> (String, Values)where T: QueryBuilder,
pub fn build_any(&self, query_builder: &dyn QueryBuilder) -> (String, Values)
§impl DeleteStatement
impl DeleteStatement
pub fn order_by<T>(&mut self, col: T, order: Order) -> &mut DeleteStatementwhere T: IntoColumnRef,
pub fn order_by_tbl<T, C>( &mut self, table: T, col: C, order: Order ) -> &mut DeleteStatementwhere 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 DeleteStatement
pub fn order_by_customs<T>( &mut self, cols: Vec<(T, Order), Global> ) -> &mut DeleteStatementwhere T: ToString,
pub fn order_by_columns<T>( &mut self, cols: Vec<(T, Order), Global> ) -> &mut DeleteStatementwhere T: IntoColumnRef,
pub fn order_by_table_columns<T, C>( &mut self, cols: Vec<(T, C, Order), Global> ) -> &mut DeleteStatementwhere T: IntoIden, C: IntoIden,
👎Deprecated since 0.9.0: Please use the [
OrderedStatement::order_by_columns
] with a tuple as [ColumnRef
]§impl DeleteStatement
impl DeleteStatement
pub fn and_where(&mut self, other: SimpleExpr) -> &mut DeleteStatement
pub fn and_where_option( &mut self, other: Option<SimpleExpr> ) -> &mut DeleteStatement
pub fn or_where(&mut self, other: SimpleExpr) -> &mut DeleteStatement
👎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 DeleteStatementwhere C: IntoCondition,
Trait Implementations§
§impl Clone for DeleteStatement
impl Clone for DeleteStatement
§fn clone(&self) -> DeleteStatement
fn clone(&self) -> DeleteStatement
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read more§impl ConditionalStatement for DeleteStatement
impl ConditionalStatement for DeleteStatement
§fn cond_where<C>(&mut self, condition: C) -> &mut DeleteStatementwhere
C: IntoCondition,
fn cond_where<C>(&mut self, condition: C) -> &mut DeleteStatementwhere 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. Read more§fn and_where(&mut self, other: SimpleExpr) -> &mut Self
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. Read more§fn and_where_option(&mut self, other: Option<SimpleExpr>) -> &mut Self
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)
. Read more§fn or_where(&mut self, other: SimpleExpr) -> &mut Self
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
impl Debug for DeleteStatement
§impl Default for DeleteStatement
impl Default for DeleteStatement
§fn default() -> DeleteStatement
fn default() -> DeleteStatement
Returns the “default value” for a type. Read more
§impl OrderedStatement for DeleteStatement
impl OrderedStatement for DeleteStatement
§fn clear_order_by(&mut self) -> &mut DeleteStatement
fn clear_order_by(&mut self) -> &mut DeleteStatement
Clear order expressions
§fn order_by<T>(&mut self, col: T, order: Order) -> &mut Selfwhere
T: IntoColumnRef,
fn order_by<T>(&mut self, col: T, order: Order) -> &mut Selfwhere T: IntoColumnRef,
Order by column. Read more
§fn order_by_tbl<T, C>(&mut self, table: T, col: C, order: Order) -> &mut Selfwhere
T: IntoIden,
C: IntoIden,
fn order_by_tbl<T, C>(&mut self, table: T, col: C, order: Order) -> &mut Selfwhere 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
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), Global>) -> &mut Selfwhere
T: ToString,
fn order_by_customs<T>(&mut self, cols: Vec<(T, Order), Global>) -> &mut Selfwhere T: ToString,
Order by custom string.
§fn order_by_columns<T>(&mut self, cols: Vec<(T, Order), Global>) -> &mut Selfwhere
T: IntoColumnRef,
fn order_by_columns<T>(&mut self, cols: Vec<(T, Order), Global>) -> &mut Selfwhere T: IntoColumnRef,
Order by vector of columns.
§fn order_by_table_columns<T, C>(
&mut self,
cols: Vec<(T, C, Order), Global>
) -> &mut Selfwhere
T: IntoIden,
C: IntoIden,
fn order_by_table_columns<T, C>( &mut self, cols: Vec<(T, C, Order), Global> ) -> &mut Selfwhere T: IntoIden, C: IntoIden,
👎Deprecated since 0.9.0: Please use the [
OrderedStatement::order_by_columns
] with a tuple as [ColumnRef
]§fn order_by_with_nulls<T>(
&mut self,
col: T,
order: Order,
nulls: NullOrdering
) -> &mut Selfwhere
T: IntoColumnRef,
fn order_by_with_nulls<T>( &mut self, col: T, order: Order, nulls: NullOrdering ) -> &mut Selfwhere T: IntoColumnRef,
Order by column with nulls order option. Read more
§fn order_by_expr_with_nulls(
&mut self,
expr: SimpleExpr,
order: Order,
nulls: NullOrdering
) -> &mut Self
fn order_by_expr_with_nulls( &mut self, expr: SimpleExpr, order: Order, nulls: NullOrdering ) -> &mut Self
Order by
SimpleExpr
with nulls order option.§fn order_by_customs_with_nulls<T>(
&mut self,
cols: Vec<(T, Order, NullOrdering), Global>
) -> &mut Selfwhere
T: ToString,
fn order_by_customs_with_nulls<T>( &mut self, cols: Vec<(T, Order, NullOrdering), Global> ) -> &mut Selfwhere T: ToString,
Order by custom string with nulls order option.
§fn order_by_columns_with_nulls<T>(
&mut self,
cols: Vec<(T, Order, NullOrdering), Global>
) -> &mut Selfwhere
T: IntoColumnRef,
fn order_by_columns_with_nulls<T>( &mut self, cols: Vec<(T, Order, NullOrdering), Global> ) -> &mut Selfwhere T: IntoColumnRef,
Order by vector of columns with nulls order option.
§impl QueryStatementBuilder for DeleteStatement
impl QueryStatementBuilder for DeleteStatement
§fn build_collect_any_into(
&self,
query_builder: &dyn QueryBuilder,
sql: &mut SqlWriter,
collector: &mut dyn FnMut(Value)
)
fn build_collect_any_into( &self, query_builder: &dyn QueryBuilder, sql: &mut SqlWriter, collector: &mut dyn FnMut(Value) )
Build corresponding SQL statement into the SqlWriter for certain database backend and collect query parameters
fn into_sub_query_statement(self) -> SubQueryStatement
§fn build_any(&self, query_builder: &dyn QueryBuilder) -> (String, Values)
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
§fn build_collect_any(
&self,
query_builder: &dyn QueryBuilder,
collector: &mut dyn FnMut(Value)
) -> String
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
§impl QueryStatementWriter for DeleteStatement
impl QueryStatementWriter for DeleteStatement
§fn build_collect<T>(
&self,
query_builder: T,
collector: &mut dyn FnMut(Value)
) -> Stringwhere
T: QueryBuilder,
fn build_collect<T>( &self, query_builder: T, collector: &mut dyn FnMut(Value) ) -> Stringwhere T: QueryBuilder,
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 to_string<T>(&self, query_builder: T) -> Stringwhere
T: QueryBuilder,
fn to_string<T>(&self, query_builder: T) -> Stringwhere T: QueryBuilder,
Build corresponding SQL statement for certain database backend and return SQL string Read more
§impl StatementBuilder for DeleteStatement
impl StatementBuilder for DeleteStatement
§fn build(&self, db_backend: &DatabaseBackend) -> Statement
fn build(&self, db_backend: &DatabaseBackend) -> Statement
Method to call in order to build a Statement