appdb 0.2.14

Lightweight SurrealDB helper library for Tauri embedded database apps
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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
use anyhow::Result;
use async_trait::async_trait;
use serde::{Deserialize, Serialize};
use surrealdb::types::{RecordId, SurrealValue, Table, Value as SurrealDbValue};

use crate::connection::get_db;
use crate::model::meta::{ModelMeta, ResolveRecordId};
use crate::model::relation::{RelationMeta, ensure_relation_name};
use crate::query::builder::QueryKind;
use crate::{ForeignModel, StoredModel};

/// Edge payload used with relation-table inserts.
#[derive(Debug, Serialize, Deserialize, SurrealValue)]
pub struct RelationEdge {
    /// Source record id.
    #[serde(rename = "in")]
    pub _in: RecordId,
    /// Target record id.
    pub out: RecordId,
}

/// Ordered edge payload used by `#[relate(...)]` field synchronization.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, SurrealValue)]
pub struct OrderedRelationEdge {
    /// Source record id.
    #[serde(rename = "in")]
    pub _in: Option<RecordId>,
    /// Target record id.
    pub out: RecordId,
    /// Stable position for vector-shaped relation fields.
    pub position: i64,
}

#[derive(Debug, Deserialize, SurrealValue)]
struct OrderedRelationEdgeRow {
    source: RecordId,
    out: RecordId,
    position: i64,
}

impl From<OrderedRelationEdgeRow> for OrderedRelationEdge {
    fn from(value: OrderedRelationEdgeRow) -> Self {
        Self {
            _in: Some(value.source),
            out: value.out,
            position: value.position,
        }
    }
}

/// Repository-style helpers for SurrealDB relation tables.
pub struct GraphRepo;

impl GraphRepo {
    /// Creates a relation row from `in_id` to `out_id` in `rel`.
    pub async fn relate_at(in_id: RecordId, out_id: RecordId, rel: &str) -> Result<()> {
        let db = get_db()?;
        let sql = QueryKind::relate(&in_id, &out_id, rel);
        db.query(sql)
            .bind(("rel", Table::from(rel)))
            .bind(("in", in_id))
            .bind(("out", out_id))
            .await?
            .check()?;
        Ok(())
    }

    /// Creates a relation row from `target_id` back to `self_id` in `rel`.
    pub async fn back_relate_at(self_id: RecordId, target_id: RecordId, rel: &str) -> Result<()> {
        Self::relate_at(target_id, self_id, rel).await
    }

    /// Deletes a single outgoing relation from `self_id` to `target_id`.
    pub async fn unrelate_at(self_id: RecordId, target_id: RecordId, rel: &str) -> Result<()> {
        let db = get_db()?;
        db.query(QueryKind::unrelate(&self_id, &target_id, rel))
            .bind(("rel", Table::from(rel)))
            .bind(("in", self_id))
            .bind(("out", target_id))
            .await?
            .check()?;
        Ok(())
    }

    /// Deletes all outgoing relations for `self_id` in `rel`.
    pub async fn unrelate_all(self_id: RecordId, rel: &str) -> Result<()> {
        let db = get_db()?;
        db.query(QueryKind::unrelate_all(&self_id, rel))
            .bind(("rel", Table::from(rel)))
            .bind(("in", self_id))
            .await?
            .check()?;
        Ok(())
    }

    /// Lists target record ids reachable from `in_id` through `rel`.
    pub async fn out_ids(in_id: RecordId, rel: &str, out_table: &str) -> Result<Vec<RecordId>> {
        let sql = QueryKind::select_out_ids(&in_id, rel, out_table);
        let db = get_db()?;
        let mut result = db
            .query(sql)
            .bind(("rel", Table::from(rel)))
            .bind(("in", in_id))
            .bind(("out_table", out_table.to_owned()))
            .await?
            .check()?;
        let rows: Vec<RecordId> = result.take(0)?;
        Ok(rows)
    }

    /// Lists all outgoing target record ids for `in_id` through `rel`.
    pub async fn outgoing_ids(in_id: RecordId, rel: &str) -> Result<Vec<RecordId>> {
        let sql = QueryKind::select_all_out_ids(&in_id, rel);
        let db = get_db()?;
        let mut result = db
            .query(sql)
            .bind(("rel", Table::from(rel)))
            .bind(("in", in_id))
            .await?
            .check()?;
        let rows: Vec<RecordId> = result.take(0)?;
        Ok(rows)
    }

    /// Loads outgoing related records from `in_id` through `rel` for one target model table.
    pub async fn outgoing<T>(in_id: RecordId, rel: &str) -> Result<Vec<T>>
    where
        T: ModelMeta + StoredModel + ForeignModel,
        T::Stored: serde::de::DeserializeOwned,
    {
        let sql = QueryKind::select_outgoing_rows(&in_id, rel, T::storage_table());
        let db = get_db()?;
        let mut result = db
            .query(sql)
            .bind(("rel", Table::from(rel)))
            .bind(("in", in_id))
            .bind(("out_table", T::storage_table().to_owned()))
            .await?
            .check()?;
        let rows: Vec<SurrealDbValue> = result.take(1)?;
        crate::repository::raw_rows_to_public_hydrated::<T>(rows).await
    }

    /// Counts all outgoing edges for `in_id` through `rel`.
    pub async fn outgoing_count(in_id: RecordId, rel: &str) -> Result<i64> {
        let sql = QueryKind::count_all_outgoing(&in_id, rel);
        let db = get_db()?;
        let mut result = db
            .query(sql)
            .bind(("rel", Table::from(rel)))
            .bind(("in", in_id))
            .await?
            .check()?;
        let count: Option<i64> = result.take(0)?;
        Ok(count.unwrap_or(0))
    }

    /// Counts outgoing edges for `in_id` through `rel` filtered by one target model table.
    pub async fn outgoing_count_as<T>(in_id: RecordId, rel: &str) -> Result<i64>
    where
        T: ModelMeta + StoredModel + ForeignModel,
    {
        let sql = QueryKind::count_outgoing_in_table(&in_id, rel, T::storage_table());
        let db = get_db()?;
        let mut result = db
            .query(sql)
            .bind(("rel", Table::from(rel)))
            .bind(("in", in_id))
            .bind(("out_table", T::storage_table().to_owned()))
            .await?
            .check()?;
        let count: Option<i64> = result.take(0)?;
        Ok(count.unwrap_or(0))
    }

    /// Lists ordered outgoing relation edges for `in_id` through `rel`.
    pub async fn out_edges(in_id: RecordId, rel: &str) -> Result<Vec<OrderedRelationEdge>> {
        let sql = QueryKind::select_out_edges(&in_id, rel);
        let db = get_db()?;
        let mut result = db
            .query(sql)
            .bind(("rel", Table::from(rel)))
            .bind(("in", in_id))
            .await?
            .check()?;
        let rows: Vec<OrderedRelationEdgeRow> = result.take(0)?;
        Ok(rows.into_iter().map(OrderedRelationEdge::from).collect())
    }

    /// Lists source record ids that point to `out_id` through `rel`.
    pub async fn in_ids(out_id: RecordId, rel: &str, in_table: &str) -> Result<Vec<RecordId>> {
        let sql = QueryKind::select_in_ids(&out_id, rel, in_table);
        let db = get_db()?;
        let mut result = db
            .query(sql)
            .bind(("rel", Table::from(rel)))
            .bind(("out", out_id))
            .bind(("in_table", in_table.to_owned()))
            .await?
            .check()?;
        let rows: Vec<RecordId> = result.take(0)?;
        Ok(rows)
    }

    /// Lists ordered incoming relation edges for `out_id` through `rel`.
    pub async fn in_edges(out_id: RecordId, rel: &str) -> Result<Vec<OrderedRelationEdge>> {
        let sql = QueryKind::select_in_edges(&out_id, rel);
        let db = get_db()?;
        let mut result = db
            .query(sql)
            .bind(("rel", Table::from(rel)))
            .bind(("out", out_id))
            .await?
            .check()?;
        let rows: Vec<OrderedRelationEdgeRow> = result.take(0)?;
        Ok(rows.into_iter().map(OrderedRelationEdge::from).collect())
    }

    /// Lists all incoming source record ids for `out_id` through `rel`.
    pub async fn incoming_ids(out_id: RecordId, rel: &str) -> Result<Vec<RecordId>> {
        let sql = QueryKind::select_all_in_ids(&out_id, rel);
        let db = get_db()?;
        let mut result = db
            .query(sql)
            .bind(("rel", Table::from(rel)))
            .bind(("out", out_id))
            .await?
            .check()?;
        let rows: Vec<RecordId> = result.take(0)?;
        Ok(rows)
    }

    /// Loads incoming related records into one source model table through `rel`.
    pub async fn incoming<T>(out_id: RecordId, rel: &str) -> Result<Vec<T>>
    where
        T: ModelMeta + StoredModel + ForeignModel,
        T::Stored: serde::de::DeserializeOwned,
    {
        let sql = QueryKind::select_incoming_rows(&out_id, rel, T::storage_table());
        let db = get_db()?;
        let mut result = db
            .query(sql)
            .bind(("rel", Table::from(rel)))
            .bind(("out", out_id))
            .bind(("in_table", T::storage_table().to_owned()))
            .await?
            .check()?;
        let rows: Vec<SurrealDbValue> = result.take(1)?;
        crate::repository::raw_rows_to_public_hydrated::<T>(rows).await
    }

    /// Counts all incoming edges for `out_id` through `rel`.
    pub async fn incoming_count(out_id: RecordId, rel: &str) -> Result<i64> {
        let sql = QueryKind::count_all_incoming(&out_id, rel);
        let db = get_db()?;
        let mut result = db
            .query(sql)
            .bind(("rel", Table::from(rel)))
            .bind(("out", out_id))
            .await?
            .check()?;
        let count: Option<i64> = result.take(0)?;
        Ok(count.unwrap_or(0))
    }

    /// Counts incoming edges for `out_id` through `rel` filtered by one source model table.
    pub async fn incoming_count_as<T>(out_id: RecordId, rel: &str) -> Result<i64>
    where
        T: ModelMeta + StoredModel + ForeignModel,
    {
        let sql = QueryKind::count_incoming_in_table(&out_id, rel, T::storage_table());
        let db = get_db()?;
        let mut result = db
            .query(sql)
            .bind(("rel", Table::from(rel)))
            .bind(("out", out_id))
            .bind(("in_table", T::storage_table().to_owned()))
            .await?
            .check()?;
        let count: Option<i64> = result.take(0)?;
        Ok(count.unwrap_or(0))
    }

    /// Inserts multiple relation rows into the given relation table.
    pub async fn insert_relation(rel: &str, data: Vec<RelationEdge>) -> Result<Vec<RelationEdge>> {
        let db = get_db()?;
        let relate: Vec<RelationEdge> = db.insert(rel).relation(data).await?;
        Ok(relate)
    }
}

/// Convenience graph methods for values that can resolve to one record id.
#[async_trait]
pub trait GraphCrud: ResolveRecordId + Send + Sync {
    /// Creates a relation from `self` to `target`.
    async fn relate<R, T>(&self, target: &T) -> Result<()>
    where
        R: RelationMeta + Send + Sync,
        T: ResolveRecordId + Send + Sync,
    {
        GraphRepo::relate_at(
            self.resolve_record_id().await?,
            target.resolve_record_id().await?,
            R::relation_name(),
        )
        .await
    }

    /// Creates a relation from `self` to `target` using a raw relation-table name.
    async fn relate_by_name<T>(&self, target: &T, relation: &str) -> Result<()>
    where
        T: ResolveRecordId + Send + Sync,
    {
        ensure_relation_name(relation)?;
        GraphRepo::relate_at(
            self.resolve_record_id().await?,
            target.resolve_record_id().await?,
            relation,
        )
        .await
    }

    /// Creates a relation from `target` back to `self`.
    async fn back_relate<R, T>(&self, target: &T) -> Result<()>
    where
        R: RelationMeta + Send + Sync,
        T: ResolveRecordId + Send + Sync,
    {
        GraphRepo::back_relate_at(
            self.resolve_record_id().await?,
            target.resolve_record_id().await?,
            R::relation_name(),
        )
        .await
    }

    /// Creates a relation from `target` back to `self` using a raw relation-table name.
    async fn back_relate_by_name<T>(&self, target: &T, relation: &str) -> Result<()>
    where
        T: ResolveRecordId + Send + Sync,
    {
        ensure_relation_name(relation)?;
        GraphRepo::back_relate_at(
            self.resolve_record_id().await?,
            target.resolve_record_id().await?,
            relation,
        )
        .await
    }

    /// Deletes a relation from `self` to `target`.
    async fn unrelate<R, T>(&self, target: &T) -> Result<()>
    where
        R: RelationMeta + Send + Sync,
        T: ResolveRecordId + Send + Sync,
    {
        GraphRepo::unrelate_at(
            self.resolve_record_id().await?,
            target.resolve_record_id().await?,
            R::relation_name(),
        )
        .await
    }

    /// Deletes a relation from `self` to `target` using a raw relation-table name.
    async fn unrelate_by_name<T>(&self, target: &T, relation: &str) -> Result<()>
    where
        T: ResolveRecordId + Send + Sync,
    {
        ensure_relation_name(relation)?;
        GraphRepo::unrelate_at(
            self.resolve_record_id().await?,
            target.resolve_record_id().await?,
            relation,
        )
        .await
    }
}

impl<T> GraphCrud for T where T: ResolveRecordId + Send + Sync {}

/// Free-function wrapper for [`GraphRepo::relate_at`].
pub async fn relate_at(in_id: RecordId, out_id: RecordId, rel: &str) -> Result<()> {
    GraphRepo::relate_at(in_id, out_id, rel).await
}

/// Free-function wrapper for [`GraphRepo::back_relate_at`].
pub async fn back_relate_at(self_id: RecordId, target_id: RecordId, rel: &str) -> Result<()> {
    GraphRepo::back_relate_at(self_id, target_id, rel).await
}

/// Free-function wrapper for [`GraphRepo::unrelate_at`].
pub async fn unrelate_at(self_id: RecordId, target_id: RecordId, rel: &str) -> Result<()> {
    GraphRepo::unrelate_at(self_id, target_id, rel).await
}

/// Free-function wrapper for [`GraphRepo::out_ids`].
pub async fn out_ids(in_id: RecordId, rel: &str, out_table: &str) -> Result<Vec<RecordId>> {
    GraphRepo::out_ids(in_id, rel, out_table).await
}

/// Free-function wrapper for [`GraphRepo::outgoing_ids`].
pub async fn outgoing_ids(in_id: RecordId, rel: &str) -> Result<Vec<RecordId>> {
    GraphRepo::outgoing_ids(in_id, rel).await
}

/// Free-function wrapper for [`GraphRepo::outgoing`].
pub async fn outgoing<T>(in_id: RecordId, rel: &str) -> Result<Vec<T>>
where
    T: ModelMeta + StoredModel + ForeignModel,
    T::Stored: serde::de::DeserializeOwned,
{
    GraphRepo::outgoing::<T>(in_id, rel).await
}

/// Free-function wrapper for [`GraphRepo::outgoing_count`].
pub async fn outgoing_count(in_id: RecordId, rel: &str) -> Result<i64> {
    GraphRepo::outgoing_count(in_id, rel).await
}

/// Free-function wrapper for [`GraphRepo::outgoing_count_as`].
pub async fn outgoing_count_as<T>(in_id: RecordId, rel: &str) -> Result<i64>
where
    T: ModelMeta + StoredModel + ForeignModel,
{
    GraphRepo::outgoing_count_as::<T>(in_id, rel).await
}

/// Free-function wrapper for [`GraphRepo::out_edges`].
pub async fn out_edges(in_id: RecordId, rel: &str) -> Result<Vec<OrderedRelationEdge>> {
    GraphRepo::out_edges(in_id, rel).await
}

/// Free-function wrapper for [`GraphRepo::in_ids`].
pub async fn in_ids(out_id: RecordId, rel: &str, in_table: &str) -> Result<Vec<RecordId>> {
    GraphRepo::in_ids(out_id, rel, in_table).await
}

/// Free-function wrapper for [`GraphRepo::in_edges`].
pub async fn in_edges(out_id: RecordId, rel: &str) -> Result<Vec<OrderedRelationEdge>> {
    GraphRepo::in_edges(out_id, rel).await
}

/// Free-function wrapper for [`GraphRepo::incoming_ids`].
pub async fn incoming_ids(out_id: RecordId, rel: &str) -> Result<Vec<RecordId>> {
    GraphRepo::incoming_ids(out_id, rel).await
}

/// Free-function wrapper for [`GraphRepo::incoming`].
pub async fn incoming<T>(out_id: RecordId, rel: &str) -> Result<Vec<T>>
where
    T: ModelMeta + StoredModel + ForeignModel,
    T::Stored: serde::de::DeserializeOwned,
{
    GraphRepo::incoming::<T>(out_id, rel).await
}

/// Free-function wrapper for [`GraphRepo::incoming_count`].
pub async fn incoming_count(out_id: RecordId, rel: &str) -> Result<i64> {
    GraphRepo::incoming_count(out_id, rel).await
}

/// Free-function wrapper for [`GraphRepo::incoming_count_as`].
pub async fn incoming_count_as<T>(out_id: RecordId, rel: &str) -> Result<i64>
where
    T: ModelMeta + StoredModel + ForeignModel,
{
    GraphRepo::incoming_count_as::<T>(out_id, rel).await
}