sntl 0.1.1

Compile-time guarded ORM for PostgreSQL — your data's guardian from compile to production
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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291

//! Runtime helpers called by code generated by `sntl::query!` family macros.
//!
//! This is a public-by-necessity module under `__macro_support`. Users should
//! not import from it directly — the API is not covered by semver.

use std::marker::PhantomData;

use crate::core::error::Result;
use driver::pipeline::QueryResult;
use driver::{Connection, FromSql, Oid, Row, ToSql};

/// Trait implemented by types that can be constructed from a Sentinel row.
///
/// Unified target for `query_as!` whether the type is a Model, a Partial,
/// or an ad-hoc `#[derive(FromRow)]` struct.
pub trait FromRow: Sized {
    fn from_row(row: &Row) -> Result<Self>;
}

/// SQL text + the OIDs the macro inferred from `.sentinel/`.
///
/// Held by value (owned `Vec<Oid>`) so the execution struct is movable
/// across `.fetch_one(conn).await` chains without dangling references.
pub struct TypedQueryHandle<'sql> {
    pub sql: &'sql str,
    pub param_oids: Vec<Oid>,
    pub macro_name: &'static str,
    pub query_id: &'static str,
}

impl<'sql> TypedQueryHandle<'sql> {
    pub fn new(
        sql: &'sql str,
        param_oids: Vec<Oid>,
        macro_name: &'static str,
        query_id: &'static str,
    ) -> Self {
        Self {
            sql,
            param_oids,
            macro_name,
            query_id,
        }
    }

    fn pair_with<'a>(
        &self,
        params: &'a [&'a (dyn ToSql + Sync)],
    ) -> Vec<(&'a (dyn ToSql + Sync), Oid)> {
        debug_assert_eq!(
            self.param_oids.len(),
            params.len(),
            "macro emitted mismatched parameter and OID counts",
        );
        params
            .iter()
            .zip(self.param_oids.iter())
            .map(|(p, oid)| (*p, *oid))
            .collect()
    }
}

/// Bundles the typed handle with `Vec<&dyn ToSql>` of parameter borrows so
/// the macro can return an expression that survives an `.await` chain. The
/// borrows live as long as the caller's local bindings.
pub struct QueryExecution<'a, T> {
    handle: TypedQueryHandle<'a>,
    params: Vec<&'a (dyn ToSql + Sync)>,
    _t: PhantomData<T>,
}

impl<'a, T: FromRow> QueryExecution<'a, T> {
    pub fn new(handle: TypedQueryHandle<'a>, params: Vec<&'a (dyn ToSql + Sync)>) -> Self {
        Self {
            handle,
            params,
            _t: PhantomData,
        }
    }

    pub async fn fetch_one(self, conn: &mut Connection) -> Result<T> {
        crate::__priv::emit_query_macro(
            conn,
            self.handle.macro_name,
            self.handle.query_id,
            self.handle.sql,
        );
        let pairs = self.handle.pair_with(&self.params);
        let row = conn.query_typed_one(self.handle.sql, &pairs).await?;
        T::from_row(&row)
    }

    pub async fn fetch_optional(self, conn: &mut Connection) -> Result<Option<T>> {
        crate::__priv::emit_query_macro(
            conn,
            self.handle.macro_name,
            self.handle.query_id,
            self.handle.sql,
        );
        let pairs = self.handle.pair_with(&self.params);
        match conn.query_typed_opt(self.handle.sql, &pairs).await? {
            Some(row) => Ok(Some(T::from_row(&row)?)),
            None => Ok(None),
        }
    }

    pub async fn fetch_all(self, conn: &mut Connection) -> Result<Vec<T>> {
        crate::__priv::emit_query_macro(
            conn,
            self.handle.macro_name,
            self.handle.query_id,
            self.handle.sql,
        );
        let pairs = self.handle.pair_with(&self.params);
        let rows = conn.query_typed(self.handle.sql, &pairs).await?;
        rows.iter().map(T::from_row).collect()
    }

    pub async fn execute(self, conn: &mut Connection) -> Result<u64> {
        crate::__priv::emit_query_macro(
            conn,
            self.handle.macro_name,
            self.handle.query_id,
            self.handle.sql,
        );
        let pairs = self.handle.pair_with(&self.params);
        Ok(conn.execute_typed(self.handle.sql, &pairs).await?)
    }
}

/// Single-column scalar wrapper. The macro generates a tiny `__SntlScalar`
/// FromRow type and routes through this so the user never sees a wrapper.
pub struct ScalarExecution<'a, T, S> {
    inner: QueryExecution<'a, S>,
    extract: fn(S) -> T,
}

impl<'a, T, S: FromRow> ScalarExecution<'a, T, S> {
    pub fn new(inner: QueryExecution<'a, S>, extract: fn(S) -> T) -> Self {
        Self { inner, extract }
    }

    pub async fn fetch_one(self, conn: &mut Connection) -> Result<T> {
        let s = self.inner.fetch_one(conn).await?;
        Ok((self.extract)(s))
    }

    pub async fn fetch_optional(self, conn: &mut Connection) -> Result<Option<T>> {
        match self.inner.fetch_optional(conn).await? {
            Some(s) => Ok(Some((self.extract)(s))),
            None => Ok(None),
        }
    }

    pub async fn fetch_all(self, conn: &mut Connection) -> Result<Vec<T>> {
        let rows = self.inner.fetch_all(conn).await?;
        Ok(rows.into_iter().map(self.extract).collect())
    }
}

/// Unchecked execution path: ordinary `query`/`execute` without the macro's
/// pre-resolved OIDs. Used by `query_unchecked!` and friends.
pub struct UncheckedExecution<'a, T> {
    pub sql: &'a str,
    pub params: Vec<&'a (dyn ToSql + Sync)>,
    _t: PhantomData<T>,
}

impl<'a, T: FromRow> UncheckedExecution<'a, T> {
    pub fn new(sql: &'a str, params: Vec<&'a (dyn ToSql + Sync)>) -> Self {
        Self {
            sql,
            params,
            _t: PhantomData,
        }
    }

    pub async fn fetch_one(self, conn: &mut Connection) -> Result<T> {
        crate::__priv::emit_query_macro(conn, "query_unchecked", "unchecked", self.sql);
        let row = conn.query_one(self.sql, &self.params).await?;
        T::from_row(&row)
    }

    pub async fn fetch_optional(self, conn: &mut Connection) -> Result<Option<T>> {
        crate::__priv::emit_query_macro(conn, "query_unchecked", "unchecked", self.sql);
        match conn.query_opt(self.sql, &self.params).await? {
            Some(row) => Ok(Some(T::from_row(&row)?)),
            None => Ok(None),
        }
    }

    pub async fn fetch_all(self, conn: &mut Connection) -> Result<Vec<T>> {
        crate::__priv::emit_query_macro(conn, "query_unchecked", "unchecked", self.sql);
        let rows = conn.query(self.sql, &self.params).await?;
        rows.iter().map(T::from_row).collect()
    }

    pub async fn execute(self, conn: &mut Connection) -> Result<u64> {
        crate::__priv::emit_query_macro(conn, "query_unchecked", "unchecked", self.sql);
        Ok(conn.execute(self.sql, &self.params).await?)
    }
}

/// One pipelined query: SQL text, parameter OIDs, and pre-encoded binary params.
///
/// The macro builds these eagerly so the runtime only has to copy them into
/// the driver's `PipelineBatch`.
pub struct PipelineQuerySpec<'q> {
    pub sql: &'q str,
    pub param_oids: Vec<Oid>,
    pub encoded_params: Vec<Option<Vec<u8>>>,
    pub macro_name: &'static str,
    pub query_id: &'static str,
}

/// Multi-query single-round-trip executor. Each query in `specs` is appended
/// to a `PipelineBatch` and the whole batch is sent in one network write.
pub struct PipelineExecution<'q> {
    pub specs: Vec<PipelineQuerySpec<'q>>,
}

impl<'q> PipelineExecution<'q> {
    pub fn new(specs: Vec<PipelineQuerySpec<'q>>) -> Self {
        Self { specs }
    }

    pub async fn run(self, conn: &mut Connection) -> Result<Vec<QueryResult>> {
        let mut batch = conn.pipeline();
        for spec in self.specs {
            crate::__priv::emit_query_macro(conn, spec.macro_name, spec.query_id, spec.sql);
            let oids: Vec<u32> = spec.param_oids.iter().map(|o| u32::from(*o)).collect();
            batch.add(spec.sql.to_string(), oids, spec.encoded_params);
        }
        Ok(conn.execute_pipeline(batch).await?)
    }
}

/// Helper used by the pipeline macro: encode a borrowed param list into the
/// `Vec<Option<Vec<u8>>>` shape `PipelineBatch::add` expects.
pub fn encode_params(params: &[&(dyn ToSql + Sync)]) -> Result<Vec<Option<Vec<u8>>>> {
    use bytes::BytesMut;
    let mut out = Vec::with_capacity(params.len());
    for p in params {
        if p.is_null() {
            out.push(None);
        } else {
            let mut buf = BytesMut::new();
            p.to_sql(&mut buf)?;
            out.push(Some(buf.to_vec()));
        }
    }
    Ok(out)
}

// ── Tuple FromRow blanket impls ──────────────────────────────────────────────
//
// Mirrors sqlx's `from_row.rs` — positional `try_get(idx)` for arity 1-16.
// Lets `query_as!((i32, String), …)` work without a wrapper struct.

macro_rules! impl_from_row_tuple {
    ($($ty:ident at $idx:tt),+ $(,)?) => {
        impl<$($ty),+> FromRow for ($($ty,)+)
        where
            $($ty: FromSql),+
        {
            fn from_row(row: &Row) -> Result<Self> {
                Ok(($(
                    row.try_get::<$ty>($idx)
                        .map_err(crate::Error::Driver)?,
                )+))
            }
        }
    };
}

impl_from_row_tuple!(T0 at 0);
impl_from_row_tuple!(T0 at 0, T1 at 1);
impl_from_row_tuple!(T0 at 0, T1 at 1, T2 at 2);
impl_from_row_tuple!(T0 at 0, T1 at 1, T2 at 2, T3 at 3);
impl_from_row_tuple!(T0 at 0, T1 at 1, T2 at 2, T3 at 3, T4 at 4);
impl_from_row_tuple!(T0 at 0, T1 at 1, T2 at 2, T3 at 3, T4 at 4, T5 at 5);
impl_from_row_tuple!(T0 at 0, T1 at 1, T2 at 2, T3 at 3, T4 at 4, T5 at 5, T6 at 6);
impl_from_row_tuple!(T0 at 0, T1 at 1, T2 at 2, T3 at 3, T4 at 4, T5 at 5, T6 at 6, T7 at 7);
impl_from_row_tuple!(T0 at 0, T1 at 1, T2 at 2, T3 at 3, T4 at 4, T5 at 5, T6 at 6, T7 at 7, T8 at 8);
impl_from_row_tuple!(T0 at 0, T1 at 1, T2 at 2, T3 at 3, T4 at 4, T5 at 5, T6 at 6, T7 at 7, T8 at 8, T9 at 9);
impl_from_row_tuple!(T0 at 0, T1 at 1, T2 at 2, T3 at 3, T4 at 4, T5 at 5, T6 at 6, T7 at 7, T8 at 8, T9 at 9, T10 at 10);
impl_from_row_tuple!(T0 at 0, T1 at 1, T2 at 2, T3 at 3, T4 at 4, T5 at 5, T6 at 6, T7 at 7, T8 at 8, T9 at 9, T10 at 10, T11 at 11);
impl_from_row_tuple!(T0 at 0, T1 at 1, T2 at 2, T3 at 3, T4 at 4, T5 at 5, T6 at 6, T7 at 7, T8 at 8, T9 at 9, T10 at 10, T11 at 11, T12 at 12);
impl_from_row_tuple!(T0 at 0, T1 at 1, T2 at 2, T3 at 3, T4 at 4, T5 at 5, T6 at 6, T7 at 7, T8 at 8, T9 at 9, T10 at 10, T11 at 11, T12 at 12, T13 at 13);
impl_from_row_tuple!(T0 at 0, T1 at 1, T2 at 2, T3 at 3, T4 at 4, T5 at 5, T6 at 6, T7 at 7, T8 at 8, T9 at 9, T10 at 10, T11 at 11, T12 at 12, T13 at 13, T14 at 14);
impl_from_row_tuple!(T0 at 0, T1 at 1, T2 at 2, T3 at 3, T4 at 4, T5 at 5, T6 at 6, T7 at 7, T8 at 8, T9 at 9, T10 at 10, T11 at 11, T12 at 12, T13 at 13, T14 at 14, T15 at 15);