toasty-core 0.5.0

Core types, schema representations, and driver interface for Toasty
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

use super::Operation;
use crate::{schema::db::TableId, stmt};

/// Deletes one or more records from a table by primary key.
///
/// Used by key-value drivers (e.g., DynamoDB). SQL drivers receive an
/// equivalent `DELETE` statement via [`QuerySql`](super::QuerySql) instead.
///
/// # Examples
///
/// ```ignore
/// use toasty_core::driver::operation::{DeleteByKey, Operation};
///
/// let op = DeleteByKey {
///     table: table_id,
///     keys: vec![key_value],
///     filter: None,
/// };
/// let operation: Operation = op.into();
/// ```
#[derive(Debug, Clone)]
pub struct DeleteByKey {
    /// The table to delete from.
    pub table: TableId,

    /// Primary key values identifying the records to delete.
    pub keys: Vec<stmt::Value>,

    /// Optional filter expression. When set, only records whose key is in
    /// `keys` *and* that match this filter are deleted.
    pub filter: Option<stmt::Expr>,

    /// Optional condition for optimistic locking. When set, the delete fails
    /// with an error if the condition is not met (unlike `filter`, which
    /// silently skips non-matching records).
    pub condition: Option<stmt::Expr>,
}

impl From<DeleteByKey> for Operation {
    fn from(value: DeleteByKey) -> Self {
        Self::DeleteByKey(value)
    }
}