icydb_core/db/query/session/
delete.rs

1use crate::{
2    db::{
3        DbSession,
4        query::{
5            Query, QueryError,
6            expr::{FilterExpr, SortExpr},
7            plan::{ExecutablePlan, ExplainPlan},
8            predicate::Predicate,
9        },
10        response::Response,
11    },
12    traits::{CanisterKind, EntityKind, EntityValue, SingletonEntity},
13    types::Id,
14};
15
16///
17/// SessionDeleteQuery
18///
19/// Session-bound delete query wrapper.
20/// This type owns *intent construction* and *execution routing only*.
21/// All result projection and cardinality handling lives on `Response<E>`.
22///
23
24pub struct SessionDeleteQuery<'a, C, E>
25where
26    C: CanisterKind,
27    E: EntityKind<Canister = C>,
28{
29    session: &'a DbSession<C>,
30    query: Query<E>,
31}
32
33impl<'a, C, E> SessionDeleteQuery<'a, C, E>
34where
35    C: CanisterKind,
36    E: EntityKind<Canister = C>,
37{
38    pub(crate) const fn new(session: &'a DbSession<C>, query: Query<E>) -> Self {
39        Self { session, query }
40    }
41
42    // ------------------------------------------------------------------
43    // Intent inspection
44    // ------------------------------------------------------------------
45
46    #[must_use]
47    pub const fn query(&self) -> &Query<E> {
48        &self.query
49    }
50
51    // ------------------------------------------------------------------
52    // Intent builders (pure)
53    // ------------------------------------------------------------------
54
55    /// Set the access path to a single typed primary-key value.
56    #[must_use]
57    pub fn by_id(mut self, id: Id<E>) -> Self {
58        self.query = self.query.by_id(id.key());
59        self
60    }
61
62    /// Set the access path to multiple typed primary-key values.
63    #[must_use]
64    pub fn by_ids<I>(mut self, ids: I) -> Self
65    where
66        I: IntoIterator<Item = Id<E>>,
67    {
68        self.query = self.query.by_ids(ids.into_iter().map(|id| id.key()));
69        self
70    }
71
72    // ------------------------------------------------------------------
73    // Query Refinement
74    // ------------------------------------------------------------------
75
76    #[must_use]
77    pub fn filter(mut self, predicate: Predicate) -> Self {
78        self.query = self.query.filter(predicate);
79        self
80    }
81
82    pub fn filter_expr(mut self, expr: FilterExpr) -> Result<Self, QueryError> {
83        self.query = self.query.filter_expr(expr)?;
84        Ok(self)
85    }
86
87    pub fn sort_expr(mut self, expr: SortExpr) -> Result<Self, QueryError> {
88        self.query = self.query.sort_expr(expr)?;
89        Ok(self)
90    }
91
92    #[must_use]
93    pub fn order_by(mut self, field: impl AsRef<str>) -> Self {
94        self.query = self.query.order_by(field);
95        self
96    }
97
98    #[must_use]
99    pub fn order_by_desc(mut self, field: impl AsRef<str>) -> Self {
100        self.query = self.query.order_by_desc(field);
101        self
102    }
103
104    #[must_use]
105    pub fn limit(mut self, limit: u32) -> Self {
106        self.query = self.query.limit(limit);
107        self
108    }
109
110    // ------------------------------------------------------------------
111    // Planning / diagnostics
112    // ------------------------------------------------------------------
113
114    pub fn explain(&self) -> Result<ExplainPlan, QueryError> {
115        self.query.explain()
116    }
117
118    pub fn plan(&self) -> Result<ExecutablePlan<E>, QueryError> {
119        self.query.plan()
120    }
121
122    // ------------------------------------------------------------------
123    // Execution (minimal core surface)
124    // ------------------------------------------------------------------
125
126    /// Execute this delete using the session's policy settings.
127    ///
128    /// All result inspection and projection is performed on `Response<E>`.
129    pub fn execute(&self) -> Result<Response<E>, QueryError>
130    where
131        E: EntityValue,
132    {
133        self.session.execute_query(self.query())
134    }
135
136    /// Execute and return whether any rows were affected.
137    pub fn is_empty(&self) -> Result<bool, QueryError>
138    where
139        E: EntityValue,
140    {
141        Ok(self.execute()?.is_empty())
142    }
143
144    /// Execute and return the number of affected rows.
145    pub fn count(&self) -> Result<u32, QueryError>
146    where
147        E: EntityValue,
148    {
149        Ok(self.execute()?.count())
150    }
151
152    /// Execute and require exactly one affected row.
153    pub fn require_one(&self) -> Result<(), QueryError>
154    where
155        E: EntityValue,
156    {
157        self.execute()?.require_one().map_err(QueryError::Response)
158    }
159
160    /// Execute and require at least one affected row.
161    pub fn require_some(&self) -> Result<(), QueryError>
162    where
163        E: EntityValue,
164    {
165        self.execute()?.require_some().map_err(QueryError::Response)
166    }
167}
168
169impl<C, E> SessionDeleteQuery<'_, C, E>
170where
171    C: CanisterKind,
172    E: EntityKind<Canister = C> + SingletonEntity,
173    E::Key: Default,
174{
175    /// Delete the singleton entity.
176    #[must_use]
177    pub fn only(mut self) -> Self {
178        self.query = self.query.only();
179        self
180    }
181}
icydb_core/db/query/session/delete.rs

icydb_core/db/query/session/
delete.rs
