quaint_forked/ast/
delete.rs

1use crate::ast::*;
2use std::borrow::Cow;
3
4#[derive(Debug, PartialEq, Clone)]
5/// A builder for a `DELETE` statement.
6pub struct Delete<'a> {
7    pub(crate) table: Table<'a>,
8    pub(crate) conditions: Option<ConditionTree<'a>>,
9    pub(crate) comment: Option<Cow<'a, str>>,
10}
11
12impl<'a> From<Delete<'a>> for Query<'a> {
13    fn from(delete: Delete<'a>) -> Self {
14        Query::Delete(Box::new(delete))
15    }
16}
17
18impl<'a> Delete<'a> {
19    /// Creates a new `DELETE` statement for the given table.
20    ///
21    /// ```rust
22    /// # use quaint::{ast::*, visitor::{Visitor, Sqlite}};
23    /// # fn main() -> Result<(), quaint::error::Error> {
24    /// let query = Delete::from_table("users");
25    /// let (sql, _) = Sqlite::build(query)?;
26    ///
27    /// assert_eq!("DELETE FROM `users`", sql);
28    /// # Ok(())
29    /// # }
30    /// ```
31    pub fn from_table<T>(table: T) -> Self
32    where
33        T: Into<Table<'a>>,
34    {
35        Self {
36            table: table.into(),
37            conditions: None,
38            comment: None,
39        }
40    }
41
42    /// Adds a comment to the delete.
43    ///
44    /// ```rust
45    /// # use quaint::{ast::*, visitor::{Visitor, Sqlite}};
46    /// # fn main() -> Result<(), quaint::error::Error> {
47    /// let query = Delete::from_table("users").comment("trace_id='5bd66ef5095369c7b0d1f8f4bd33716a', parent_id='c532cb4098ac3dd2'");
48    /// let (sql, _) = Sqlite::build(query)?;
49    ///
50    /// assert_eq!("DELETE FROM `users` /* trace_id='5bd66ef5095369c7b0d1f8f4bd33716a', parent_id='c532cb4098ac3dd2' */", sql);
51    /// # Ok(())
52    /// # }
53    /// ```
54    pub fn comment<C: Into<Cow<'a, str>>>(mut self, comment: C) -> Self {
55        self.comment = Some(comment.into());
56        self
57    }
58
59    /// Adds `WHERE` conditions to the query. See
60    /// [Comparable](trait.Comparable.html#required-methods) for more examples.
61    ///
62    /// ```rust
63    /// # use quaint::{ast::*, visitor::{Visitor, Sqlite}};
64    /// # fn main() -> Result<(), quaint::error::Error> {
65    /// let query = Delete::from_table("users").so_that("bar".equals(false));
66    /// let (sql, params) = Sqlite::build(query)?;
67    ///
68    /// assert_eq!("DELETE FROM `users` WHERE `bar` = ?", sql);
69    /// assert_eq!(vec![Value::boolean(false)], params);
70    /// # Ok(())
71    /// # }
72    /// ```
73    pub fn so_that<T>(mut self, conditions: T) -> Self
74    where
75        T: Into<ConditionTree<'a>>,
76    {
77        self.conditions = Some(conditions.into());
78        self
79    }
80}
quaint_forked/ast/delete.rs

quaint_forked/ast/
delete.rs
