netabase_store 0.0.8

A type-safe, multi-backend key-value storage library for Rust with support for native (Sled, Redb) and WASM (IndexedDB) environments.
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
//! RedbStoreTree implementation
//!
//! This module contains the tree struct for type-safe operations on a single model type.

use crate::error::NetabaseError;
use crate::traits::definition::NetabaseDefinitionTrait;
use crate::traits::model::{NetabaseModelTrait, NetabaseModelTraitKey};

use redb::{
    Database, MultimapTableDefinition, ReadableDatabase, ReadableTable, ReadableTableMetadata,
    TableDefinition,
};
use std::fmt::Debug;
use std::marker::PhantomData;
use std::sync::Arc;
use strum::IntoDiscriminant;

use super::types::BincodeWrapper;

/// Type-safe wrapper around redb table operations for a specific model type.
///
/// RedbStoreTree provides CRUD operations for a single model type with automatic
/// encoding/decoding via redb's Key/Value traits and secondary key management.
///
/// This is similar to SledStoreTree but leverages redb's native type safety.
///
/// The lifetime parameter `'db` ensures that trees cannot outlive their parent database.
pub struct RedbStoreTree<'db, D, M>
where
    D: NetabaseDefinitionTrait,
    M: NetabaseModelTrait<D>,
    <D as IntoDiscriminant>::Discriminant: crate::DiscriminantBounds,
{
    pub(crate) db: Arc<Database>,
    pub discriminant: D::Discriminant,
    /// Cached table name string with 'static lifetime (leaked once)
    pub(crate) table_name: &'static str,
    /// Cached secondary table name string with 'static lifetime (leaked once)
    pub(crate) secondary_table_name: &'static str,
    pub(crate) _phantom_d: PhantomData<D>,
    pub(crate) _phantom_m: PhantomData<M>,
    pub(crate) _phantom_db: PhantomData<&'db ()>,
}

impl<'db, D, M> RedbStoreTree<'db, D, M>
where
    D: NetabaseDefinitionTrait,
    M: NetabaseModelTrait<D> + Debug + bincode::Decode<()>,
    M::Keys: Debug + bincode::Decode<()> + Ord + PartialEq,
    <D as IntoDiscriminant>::Discriminant: crate::DiscriminantBounds,
{
    /// Create a new RedbStoreTree with shared database access
    ///
    /// Uses discriminant directly instead of string conversion.
    /// Caches table names to avoid memory leaks on every operation.
    pub(crate) fn new(db: Arc<Database>, discriminant: D::Discriminant) -> Self {
        // Leak the table name strings once during construction
        let table_name = discriminant.to_string();
        let table_name_static: &'static str = Box::leak(table_name.into_boxed_str());

        let sec_name = format!("{}_secondary", discriminant.as_ref());
        let sec_name_static: &'static str = Box::leak(sec_name.into_boxed_str());

        Self {
            db,
            discriminant,
            table_name: table_name_static,
            secondary_table_name: sec_name_static,
            _phantom_d: PhantomData,
            _phantom_m: PhantomData,
            _phantom_db: PhantomData,
        }
    }

    /// Get the table definition for this tree using typed keys and values
    ///
    /// Uses cached table name to avoid allocations and memory leaks.
    /// Stores model M directly instead of Definition enum D for better performance.
    pub(crate) fn table_def(
        &self,
    ) -> TableDefinition<'static, BincodeWrapper<M::Keys>, BincodeWrapper<M>> {
        TableDefinition::new(self.table_name)
    }

    /// Get the table definition for secondary keys
    ///
    /// Uses cached table name to avoid allocations and memory leaks.
    /// MultimapTable maps SecondaryKey -> PrimaryKey (one-to-many relationship).
    pub(crate) fn secondary_table_def(
        &self,
    ) -> MultimapTableDefinition<
        'static,
        <M::Keys as NetabaseModelTraitKey<D>>::SecondaryKey,
        <M::Keys as NetabaseModelTraitKey<D>>::PrimaryKey,
    > {
        MultimapTableDefinition::new(self.secondary_table_name)
    }

    /// Insert or update a model in the tree
    ///
    /// Stores model directly without Definition enum wrapper for optimal performance.
    pub fn put(&self, model: M) -> Result<(), NetabaseError> {
        let table_def = self.table_def();
        let sec_table_def = self.secondary_table_def();
        let key = model.key();
        let primary_key = model.primary_key();
        let secondary_keys = model.secondary_keys();

        // Begin write transaction
        let write_txn = self.db.as_ref().begin_write()?;

        // Store model directly (no enum wrapping, no clone needed)
        {
            let mut table = write_txn.open_table(table_def)?;
            table.insert(&key, &model)?;

            // Insert secondary index entries: SecondaryKey -> PrimaryKey
            if !secondary_keys.is_empty() {
                let mut sec_table = write_txn.open_multimap_table(sec_table_def)?;
                for sec_key in secondary_keys.values() {
                    sec_table.insert(sec_key.clone(), primary_key.clone())?;
                }
            }
        }

        write_txn.commit()?;

        Ok(())
    }

    /// Get a model by its primary key
    ///
    /// Reads model directly without Definition enum unwrapping.
    pub fn get(&self, key: M::Keys) -> Result<Option<M>, NetabaseError> {
        let table_def = self.table_def();

        let read_txn = self.db.as_ref().begin_read()?;

        // Handle the case where the table doesn't exist yet (hasn't been written to)
        let table = match read_txn.open_table(table_def) {
            Ok(table) => table,
            Err(redb::TableError::TableDoesNotExist(_)) => return Ok(None),
            Err(e) => return Err(NetabaseError::RedbTableError(e)),
        };

        match table.get(&key)? {
            Some(model_guard) => {
                let model: M = model_guard.value();
                Ok(Some(model))
            }
            None => Ok(None),
        }
    }

    /// Delete a model by its primary key
    pub fn remove(&self, key: M::Keys) -> Result<Option<M>, NetabaseError> {
        // First get the model so we can clean up secondary keys
        let model = self.get(key.clone())?;

        if model.is_none() {
            return Ok(None);
        }

        let table_def = self.table_def();
        let sec_table_def = self.secondary_table_def();

        let write_txn = self.db.as_ref().begin_write()?;
        {
            let mut table = write_txn.open_table(table_def)?;
            table.remove(&key)?;

            // Clean up secondary keys in the same transaction
            if let Some(ref m) = model {
                let primary_key = m.primary_key();
                let secondary_keys = m.secondary_keys();
                if !secondary_keys.is_empty() {
                    let mut sec_table = write_txn.open_multimap_table(sec_table_def)?;
                    for sec_key in secondary_keys.values() {
                        sec_table.remove(sec_key.clone(), primary_key.clone())?;
                    }
                }
            }
        }

        write_txn.commit()?;

        Ok(model)
    }

    /// Bulk insert multiple models in a single transaction
    ///
    /// This is significantly faster than calling put() in a loop.
    pub fn put_many(&self, models: Vec<M>) -> Result<(), NetabaseError> {
        if models.is_empty() {
            return Ok(());
        }

        let table_def = self.table_def();
        let sec_table_def = self.secondary_table_def();

        let write_txn = self.db.as_ref().begin_write()?;
        {
            let mut table = write_txn.open_table(table_def)?;
            let mut sec_table = write_txn.open_multimap_table(sec_table_def)?;

            for model in models {
                let key = model.key();
                table.insert(&key, &model)?;

                // Handle secondary keys
                let primary_key = model.primary_key();
                let secondary_keys = model.secondary_keys();
                if !secondary_keys.is_empty() {
                    for sec_key in secondary_keys.values() {
                        sec_table.insert(sec_key.clone(), primary_key.clone())?;
                    }
                }
            }
        }
        write_txn.commit()?;

        Ok(())
    }

    /// Bulk get multiple models by their primary keys in a single transaction
    ///
    /// This is significantly faster than calling get() in a loop.
    pub fn get_many(&self, keys: Vec<M::Keys>) -> Result<Vec<Option<M>>, NetabaseError> {
        if keys.is_empty() {
            return Ok(Vec::new());
        }

        let table_def = self.table_def();

        let read_txn = self.db.as_ref().begin_read()?;

        // Handle the case where the table doesn't exist yet
        let table = match read_txn.open_table(table_def) {
            Ok(table) => table,
            Err(redb::TableError::TableDoesNotExist(_)) => {
                return Ok(vec![None; keys.len()]);
            }
            Err(e) => return Err(NetabaseError::RedbTableError(e)),
        };

        let mut results = Vec::with_capacity(keys.len());

        for key in keys {
            let model = table.get(&key)?.map(|model_guard| model_guard.value());
            results.push(model);
        }

        Ok(results)
    }

    /// Iterate over all models in the tree
    pub fn iter(&self) -> Result<Vec<(M::Keys, M)>, NetabaseError> {
        let table_def = self.table_def();

        let read_txn = self.db.as_ref().begin_read()?;

        // Handle the case where the table doesn't exist yet (hasn't been written to)
        let table = match read_txn.open_table(table_def) {
            Ok(table) => table,
            Err(redb::TableError::TableDoesNotExist(_)) => return Ok(Vec::new()),
            Err(e) => return Err(NetabaseError::RedbTableError(e)),
        };

        let mut results = Vec::new();

        for item in table.iter()? {
            let (key_guard, value_guard) = item?;

            let key: M::Keys = key_guard.value();
            let model: M = value_guard.value();

            results.push((key, model));
        }

        Ok(results)
    }

    /// Get the number of models in the tree
    pub fn len(&self) -> Result<usize, NetabaseError> {
        let table_def = self.table_def();

        let read_txn = self.db.as_ref().begin_read()?;

        // Handle the case where the table doesn't exist yet (hasn't been written to)
        match read_txn.open_table(table_def) {
            Ok(table) => Ok(table.len()? as usize),
            Err(redb::TableError::TableDoesNotExist(_)) => Ok(0),
            Err(e) => Err(NetabaseError::RedbTableError(e)),
        }
    }

    /// Check if the tree is empty
    pub fn is_empty(&self) -> Result<bool, NetabaseError> {
        Ok(self.len()? == 0)
    }

    /// Clear all models from the tree
    pub fn clear(&self) -> Result<(), NetabaseError> {
        let table_def = self.table_def();
        let sec_table_def = self.secondary_table_def();

        let write_txn = self.db.as_ref().begin_write()?;
        {
            // Clear main table (if it exists)
            match write_txn.open_table(table_def) {
                Ok(mut table) => {
                    let keys: Vec<M::Keys> = table
                        .iter()?
                        .filter_map(|item| item.ok())
                        .map(|(k, _)| k.value())
                        .collect();

                    for key in keys {
                        table.remove(&key)?;
                    }
                }
                Err(redb::TableError::TableDoesNotExist(_)) => {
                    // Table doesn't exist yet, nothing to clear
                }
                Err(e) => return Err(NetabaseError::RedbTableError(e)),
            }

            // Clear secondary keys table (if it exists)
            match write_txn.open_multimap_table(sec_table_def) {
                Ok(sec_table) => {
                    // Since MultimapTable doesn't provide a clear() method, we drop it
                    drop(sec_table);
                }
                Err(redb::TableError::TableDoesNotExist(_)) => {
                    // Table doesn't exist yet, nothing to clear
                }
                Err(e) => return Err(NetabaseError::RedbTableError(e)),
            }
        }
        write_txn.commit()?;

        Ok(())
    }

    /// Find models by secondary key using the secondary key index
    pub fn get_by_secondary_key(
        &self,
        secondary_key: <M::Keys as NetabaseModelTraitKey<D>>::SecondaryKey,
    ) -> Result<Vec<M>, NetabaseError>
    where
        M::Keys: for<'a> From<<M::PrimaryKey as redb::Value>::SelfType<'a>>,
    {
        let sec_table_def = self.secondary_table_def();

        let read_txn = self.db.as_ref().begin_read()?;

        // Handle the case where the secondary table doesn't exist yet (hasn't been written to)
        let sec_table = match read_txn.open_multimap_table(sec_table_def) {
            Ok(table) => table,
            Err(redb::TableError::TableDoesNotExist(_)) => return Ok(Vec::new()),
            Err(e) => return Err(NetabaseError::RedbTableError(e)),
        };

        let mut results = Vec::new();

        // Get all primary keys for this secondary key from the multimap
        for item in sec_table.get(secondary_key)? {
            let prim_key_guard = item?;
            let prim_key = prim_key_guard.value();

            // Convert from PrimaryKey::SelfType to M::Keys using From/Into
            let keys = M::Keys::from(prim_key);
            if let Some(model) = self.get(keys)? {
                results.push(model);
            }
        }

        Ok(results)
    }

    /// Bulk query models by multiple secondary keys in a single transaction
    ///
    /// Returns a vector of result sets, one per secondary key queried.
    /// This is significantly faster than calling get_by_secondary_key() in a loop.
    pub fn get_many_by_secondary_keys(
        &self,
        secondary_keys: Vec<<M::Keys as NetabaseModelTraitKey<D>>::SecondaryKey>,
    ) -> Result<Vec<Vec<M>>, NetabaseError>
    where
        M::Keys: for<'a> From<<M::PrimaryKey as redb::Value>::SelfType<'a>>,
    {
        if secondary_keys.is_empty() {
            return Ok(Vec::new());
        }

        let table_def = self.table_def();
        let sec_table_def = self.secondary_table_def();

        let read_txn = self.db.as_ref().begin_read()?;

        // Handle the case where the secondary table doesn't exist yet
        let sec_table = match read_txn.open_multimap_table(sec_table_def) {
            Ok(table) => table,
            Err(redb::TableError::TableDoesNotExist(_)) => {
                return Ok(vec![Vec::new(); secondary_keys.len()]);
            }
            Err(e) => return Err(NetabaseError::RedbTableError(e)),
        };

        // Open the primary table
        let table = match read_txn.open_table(table_def) {
            Ok(table) => table,
            Err(redb::TableError::TableDoesNotExist(_)) => {
                return Ok(vec![Vec::new(); secondary_keys.len()]);
            }
            Err(e) => return Err(NetabaseError::RedbTableError(e)),
        };

        let mut all_results = Vec::with_capacity(secondary_keys.len());

        for secondary_key in secondary_keys {
            let mut results = Vec::new();

            // Get all primary keys for this secondary key from the multimap
            for item in sec_table.get(secondary_key)? {
                let prim_key_guard = item?;
                let prim_key = prim_key_guard.value();

                // Convert from PrimaryKey::SelfType to M::Keys using From/Into
                let keys = M::Keys::from(prim_key);

                // Get the model directly from the table (same transaction)
                if let Some(model_guard) = table.get(&keys)? {
                    results.push(model_guard.value());
                }
            }

            all_results.push(results);
        }

        Ok(all_results)
    }
}