dbx-core 0.2.1-beta

High-performance file-based database engine with 5-Tier Hybrid Storage
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
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
//! Metadata Persistence — Schema and Index metadata serialization and storage
//!
//! This module provides functionality to persist table schemas and index definitions
//! to the sled backend, enabling automatic restoration on database reopen.

use crate::error::{DbxError, DbxResult};
use crate::storage::StorageBackend;
use crate::storage::native_wos::NativeWosBackend;
use arrow::datatypes::{DataType, Field, Schema};
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use std::sync::Arc;

// ════════════════════════════════════════════
// Metadata Structures
// ════════════════════════════════════════════

/// Serializable schema metadata for persistence
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SchemaMetadata {
    pub table_name: String,
    pub fields: Vec<FieldMetadata>,
    #[serde(default)]
    pub metadata: HashMap<String, String>,
}

/// Serializable field metadata
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FieldMetadata {
    pub name: String,
    pub data_type: String,
    pub nullable: bool,
}

/// Serializable index metadata
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct IndexMetadata {
    pub index_name: String,
    pub table_name: String,
    pub column_name: String,
}

// ════════════════════════════════════════════
// Schema Conversion
// ════════════════════════════════════════════

impl From<&Schema> for SchemaMetadata {
    fn from(schema: &Schema) -> Self {
        let fields = schema
            .fields()
            .iter()
            .map(|field| FieldMetadata {
                name: field.name().clone(),
                data_type: datatype_to_string(field.data_type()),
                nullable: field.is_nullable(),
            })
            .collect();

        SchemaMetadata {
            table_name: String::new(), // Will be set by caller
            fields,
            metadata: schema.metadata().clone(),
        }
    }
}

impl TryFrom<SchemaMetadata> for Schema {
    type Error = DbxError;

    fn try_from(metadata: SchemaMetadata) -> Result<Self, Self::Error> {
        let fields: Result<Vec<Field>, DbxError> = metadata
            .fields
            .iter()
            .map(|field_meta| {
                let data_type = string_to_datatype(&field_meta.data_type)?;
                Ok(Field::new(&field_meta.name, data_type, field_meta.nullable))
            })
            .collect();

        Ok(Schema::new(fields?).with_metadata(metadata.metadata))
    }
}

// ════════════════════════════════════════════
// DataType Conversion Helpers
// ════════════════════════════════════════════

/// Convert Arrow DataType to string representation
fn datatype_to_string(data_type: &DataType) -> String {
    match data_type {
        DataType::Int8 => "Int8".to_string(),
        DataType::Int16 => "Int16".to_string(),
        DataType::Int32 => "Int32".to_string(),
        DataType::Int64 => "Int64".to_string(),
        DataType::UInt8 => "UInt8".to_string(),
        DataType::UInt16 => "UInt16".to_string(),
        DataType::UInt32 => "UInt32".to_string(),
        DataType::UInt64 => "UInt64".to_string(),
        DataType::Float32 => "Float32".to_string(),
        DataType::Float64 => "Float64".to_string(),
        DataType::Utf8 => "Utf8".to_string(),
        DataType::Boolean => "Boolean".to_string(),
        DataType::Binary => "Binary".to_string(),
        DataType::Date32 => "Date32".to_string(),
        DataType::Date64 => "Date64".to_string(),
        DataType::Timestamp(unit, tz) => {
            format!("Timestamp({:?}, {:?})", unit, tz)
        }
        _ => format!("{:?}", data_type), // Fallback for complex types
    }
}

/// Convert string representation to Arrow DataType
fn string_to_datatype(s: &str) -> DbxResult<DataType> {
    match s {
        "Int8" => Ok(DataType::Int8),
        "Int16" => Ok(DataType::Int16),
        "Int32" => Ok(DataType::Int32),
        "Int64" => Ok(DataType::Int64),
        "UInt8" => Ok(DataType::UInt8),
        "UInt16" => Ok(DataType::UInt16),
        "UInt32" => Ok(DataType::UInt32),
        "UInt64" => Ok(DataType::UInt64),
        "Float32" => Ok(DataType::Float32),
        "Float64" => Ok(DataType::Float64),
        "Utf8" => Ok(DataType::Utf8),
        "Boolean" => Ok(DataType::Boolean),
        "Binary" => Ok(DataType::Binary),
        "Date32" => Ok(DataType::Date32),
        "Date64" => Ok(DataType::Date64),
        _ => Err(DbxError::Schema(format!("Unsupported data type: {}", s))),
    }
}

// ════════════════════════════════════════════
// Schema Persistence Functions
// ════════════════════════════════════════════

/// Save table schema to persistent storage
pub fn save_schema(wos: &NativeWosBackend, table: &str, schema: &Schema) -> DbxResult<()> {
    let mut metadata = SchemaMetadata::from(schema);
    metadata.table_name = table.to_string();

    let json_bytes =
        serde_json::to_vec(&metadata).map_err(|e| DbxError::Serialization(e.to_string()))?;

    wos.insert("__meta__/schemas", table.as_bytes(), &json_bytes)?;
    Ok(())
}

/// Load table schema from persistent storage
pub fn load_schema(wos: &NativeWosBackend, table: &str) -> DbxResult<Option<Arc<Schema>>> {
    match wos.get("__meta__/schemas", table.as_bytes())? {
        Some(json_bytes) => {
            let metadata: SchemaMetadata = serde_json::from_slice(&json_bytes)
                .map_err(|e| DbxError::Serialization(e.to_string()))?;
            let schema = Schema::try_from(metadata)?;
            Ok(Some(Arc::new(schema)))
        }
        None => Ok(None),
    }
}

/// Delete table schema from persistent storage
pub fn delete_schema(wos: &NativeWosBackend, table: &str) -> DbxResult<()> {
    wos.delete("__meta__/schemas", table.as_bytes())?;
    Ok(())
}

/// Load all schemas from persistent storage
pub fn load_all_schemas(wos: &NativeWosBackend) -> DbxResult<HashMap<String, Arc<Schema>>> {
    let mut schemas = HashMap::new();
    let all_records = wos.scan("__meta__/schemas", ..)?;

    for (key_vec, value_vec) in all_records {
        let table_name =
            String::from_utf8(key_vec).map_err(|e| DbxError::Serialization(e.to_string()))?;
        let metadata: SchemaMetadata = serde_json::from_slice(&value_vec)
            .map_err(|e| DbxError::Serialization(e.to_string()))?;
        let schema = Schema::try_from(metadata)?;
        schemas.insert(table_name, Arc::new(schema));
    }

    Ok(schemas)
}

// ════════════════════════════════════════════
// Index Persistence Functions
// ════════════════════════════════════════════

/// Save index metadata to persistent storage
pub fn save_index(
    wos: &NativeWosBackend,
    index_name: &str,
    table: &str,
    column: &str,
) -> DbxResult<()> {
    let metadata = IndexMetadata {
        index_name: index_name.to_string(),
        table_name: table.to_string(),
        column_name: column.to_string(),
    };

    let json_bytes =
        serde_json::to_vec(&metadata).map_err(|e| DbxError::Serialization(e.to_string()))?;

    wos.insert("__meta__/indexes", index_name.as_bytes(), &json_bytes)?;
    Ok(())
}

/// Delete index metadata from persistent storage
pub fn delete_index(wos: &NativeWosBackend, index_name: &str) -> DbxResult<()> {
    wos.delete("__meta__/indexes", index_name.as_bytes())?;
    Ok(())
}

/// Load all index metadata from persistent storage
pub fn load_all_indexes(wos: &NativeWosBackend) -> DbxResult<HashMap<String, (String, String)>> {
    let mut indexes = HashMap::new();
    let all_records = wos.scan("__meta__/indexes", ..)?;

    for (key_vec, value_vec) in all_records {
        let index_name =
            String::from_utf8(key_vec).map_err(|e| DbxError::Serialization(e.to_string()))?;
        let metadata: IndexMetadata = serde_json::from_slice(&value_vec)
            .map_err(|e| DbxError::Serialization(e.to_string()))?;
        indexes.insert(index_name, (metadata.table_name, metadata.column_name));
    }

    Ok(indexes)
}

// ════════════════════════════════════════════
// Trigger Metadata Persistence Functions
// ════════════════════════════════════════════

/// Save trigger metadata to persistent storage
pub fn save_trigger(wos: &NativeWosBackend, trigger: &crate::automation::Trigger) -> DbxResult<()> {
    let json = trigger.to_json()?;
    wos.insert(
        "__meta__/triggers",
        trigger.name.as_bytes(),
        json.as_bytes(),
    )?;
    Ok(())
}

/// Load trigger metadata from persistent storage
pub fn load_trigger(
    wos: &NativeWosBackend,
    name: &str,
) -> DbxResult<Option<crate::automation::Trigger>> {
    match wos.get("__meta__/triggers", name.as_bytes())? {
        Some(json_bytes) => {
            let json = String::from_utf8(json_bytes)
                .map_err(|e| DbxError::Serialization(e.to_string()))?;
            let trigger = crate::automation::Trigger::from_json(&json)?;
            Ok(Some(trigger))
        }
        None => Ok(None),
    }
}

/// Delete trigger metadata from persistent storage
pub fn delete_trigger(wos: &NativeWosBackend, name: &str) -> DbxResult<()> {
    wos.delete("__meta__/triggers", name.as_bytes())?;
    Ok(())
}

/// Load all trigger metadata from persistent storage
pub fn load_all_triggers(wos: &NativeWosBackend) -> DbxResult<Vec<crate::automation::Trigger>> {
    let mut triggers = Vec::new();
    let all_records = wos.scan("__meta__/triggers", ..)?;

    for (_key_vec, value_vec) in all_records {
        let json =
            String::from_utf8(value_vec).map_err(|e| DbxError::Serialization(e.to_string()))?;
        let trigger = crate::automation::Trigger::from_json(&json)?;
        triggers.push(trigger);
    }

    Ok(triggers)
}

// ════════════════════════════════════════════
// Stored Procedure Metadata Persistence Functions
// ════════════════════════════════════════════

/// Save stored procedure metadata to persistent storage
pub fn save_procedure(
    wos: &NativeWosBackend,
    procedure: &crate::automation::StoredProcedure,
) -> DbxResult<()> {
    let json = procedure.to_json()?;
    wos.insert(
        "__meta__/procedures",
        procedure.name.as_bytes(),
        json.as_bytes(),
    )?;
    Ok(())
}

/// Load stored procedure metadata from persistent storage
pub fn load_procedure(
    wos: &NativeWosBackend,
    name: &str,
) -> DbxResult<Option<crate::automation::StoredProcedure>> {
    match wos.get("__meta__/procedures", name.as_bytes())? {
        Some(json_bytes) => {
            let json = String::from_utf8(json_bytes)
                .map_err(|e| DbxError::Serialization(e.to_string()))?;
            let procedure = crate::automation::StoredProcedure::from_json(&json)?;
            Ok(Some(procedure))
        }
        None => Ok(None),
    }
}

/// Delete stored procedure metadata from persistent storage
pub fn delete_procedure(wos: &NativeWosBackend, name: &str) -> DbxResult<()> {
    wos.delete("__meta__/procedures", name.as_bytes())?;
    Ok(())
}

/// Load all stored procedure metadata from persistent storage
pub fn load_all_procedures(
    wos: &NativeWosBackend,
) -> DbxResult<Vec<crate::automation::StoredProcedure>> {
    let mut procedures = Vec::new();
    let all_records = wos.scan("__meta__/procedures", ..)?;

    for (_key_vec, value_vec) in all_records {
        let json =
            String::from_utf8(value_vec).map_err(|e| DbxError::Serialization(e.to_string()))?;
        let procedure = crate::automation::StoredProcedure::from_json(&json)?;
        procedures.push(procedure);
    }

    Ok(procedures)
}

// ════════════════════════════════════════════
// UDF Metadata Persistence Functions
// ════════════════════════════════════════════

/// Save UDF metadata to persistent storage
pub fn save_udf(wos: &NativeWosBackend, udf: &crate::automation::UdfMetadata) -> DbxResult<()> {
    let json = udf.to_json()?;
    wos.insert("__meta__/udfs", udf.name.as_bytes(), json.as_bytes())?;
    Ok(())
}

/// Load UDF metadata from persistent storage
pub fn load_udf(
    wos: &NativeWosBackend,
    name: &str,
) -> DbxResult<Option<crate::automation::UdfMetadata>> {
    match wos.get("__meta__/udfs", name.as_bytes())? {
        Some(json_bytes) => {
            let json = String::from_utf8(json_bytes)
                .map_err(|e| DbxError::Serialization(e.to_string()))?;
            let udf = crate::automation::UdfMetadata::from_json(&json)?;
            Ok(Some(udf))
        }
        None => Ok(None),
    }
}

/// Delete UDF metadata from persistent storage
pub fn delete_udf(wos: &NativeWosBackend, name: &str) -> DbxResult<()> {
    wos.delete("__meta__/udfs", name.as_bytes())?;
    Ok(())
}

/// Load all UDF metadata from persistent storage
pub fn load_all_udfs(wos: &NativeWosBackend) -> DbxResult<Vec<crate::automation::UdfMetadata>> {
    let mut udfs = Vec::new();
    let all_records = wos.scan("__meta__/udfs", ..)?;

    for (_key_vec, value_vec) in all_records {
        let json =
            String::from_utf8(value_vec).map_err(|e| DbxError::Serialization(e.to_string()))?;
        let udf = crate::automation::UdfMetadata::from_json(&json)?;
        udfs.push(udf);
    }

    Ok(udfs)
}

// ════════════════════════════════════════════
// Schedule Metadata Persistence
// ════════════════════════════════════════════

/// Save schedule metadata
pub fn save_schedule(
    wos: &NativeWosBackend,
    schedule: &crate::automation::Schedule,
) -> DbxResult<()> {
    let json = schedule.to_json()?;
    wos.insert(
        "__meta__/schedules",
        schedule.name.as_bytes(),
        json.as_bytes(),
    )?;
    Ok(())
}

/// Load schedule metadata by name
pub fn load_schedule(
    wos: &NativeWosBackend,
    name: &str,
) -> DbxResult<Option<crate::automation::Schedule>> {
    match wos.get("__meta__/schedules", name.as_bytes())? {
        Some(bytes) => {
            let json = String::from_utf8(bytes.to_vec()).map_err(|e| {
                DbxError::Serialization(format!("Failed to decode schedule JSON: {}", e))
            })?;
            let schedule = crate::automation::Schedule::from_json(&json)?;
            Ok(Some(schedule))
        }
        None => Ok(None),
    }
}

/// Delete schedule metadata
pub fn delete_schedule(wos: &NativeWosBackend, name: &str) -> DbxResult<()> {
    wos.delete("__meta__/schedules", name.as_bytes())?;
    Ok(())
}

/// Load all schedules
pub fn load_all_schedules(
    wos: &NativeWosBackend,
) -> DbxResult<HashMap<String, crate::automation::Schedule>> {
    let mut schedules = HashMap::new();
    let all_records = wos.scan("__meta__/schedules", ..)?;

    for (key_vec, value_vec) in all_records {
        let name =
            String::from_utf8(key_vec).map_err(|e| DbxError::Serialization(e.to_string()))?;

        let json = String::from_utf8(value_vec).map_err(|e| {
            DbxError::Serialization(format!("Failed to decode schedule JSON: {}", e))
        })?;

        let schedule = crate::automation::Schedule::from_json(&json)?;
        schedules.insert(name, schedule);
    }

    Ok(schedules)
}

// ════════════════════════════════════════════
// Tests
// ════════════════════════════════════════════

#[cfg(test)]
mod tests {
    use super::*;
    use arrow::datatypes::{DataType, Field, Schema};

    #[test]
    fn test_schema_metadata_conversion() {
        let schema = Schema::new(vec![
            Field::new("id", DataType::Int64, false),
            Field::new("name", DataType::Utf8, true),
            Field::new("age", DataType::Int32, true),
        ]);

        let metadata = SchemaMetadata::from(&schema);
        assert_eq!(metadata.fields.len(), 3);
        assert_eq!(metadata.fields[0].name, "id");
        assert_eq!(metadata.fields[0].data_type, "Int64");
        assert!(!metadata.fields[0].nullable);

        let restored_schema = Schema::try_from(metadata).unwrap();
        assert_eq!(restored_schema.fields().len(), 3);
        assert_eq!(restored_schema.field(0).name(), "id");
        assert_eq!(restored_schema.field(0).data_type(), &DataType::Int64);
    }

    #[test]
    fn test_schema_persistence() {
        let wos = NativeWosBackend::open_temporary().unwrap();
        let schema = Arc::new(Schema::new(vec![
            Field::new("id", DataType::Int64, false),
            Field::new("name", DataType::Utf8, true),
        ]));

        // Save schema
        save_schema(&wos, "users", &schema).unwrap();

        // Load schema
        let loaded = load_schema(&wos, "users").unwrap();
        assert!(loaded.is_some());
        let loaded_schema = loaded.unwrap();
        assert_eq!(loaded_schema.fields().len(), 2);
        assert_eq!(loaded_schema.field(0).name(), "id");
        assert_eq!(loaded_schema.field(1).name(), "name");

        // Delete schema
        delete_schema(&wos, "users").unwrap();
        let deleted = load_schema(&wos, "users").unwrap();
        assert!(deleted.is_none());
    }

    #[test]
    fn test_load_all_schemas() {
        let wos = NativeWosBackend::open_temporary().unwrap();

        // Save multiple schemas
        let schema1 = Arc::new(Schema::new(vec![Field::new("id", DataType::Int64, false)]));
        let schema2 = Arc::new(Schema::new(vec![Field::new("name", DataType::Utf8, true)]));

        save_schema(&wos, "users", &schema1).unwrap();
        save_schema(&wos, "products", &schema2).unwrap();

        // Load all
        let all_schemas = load_all_schemas(&wos).unwrap();
        assert_eq!(all_schemas.len(), 2);
        assert!(all_schemas.contains_key("users"));
        assert!(all_schemas.contains_key("products"));
    }

    #[test]
    fn test_index_persistence() {
        let wos = NativeWosBackend::open_temporary().unwrap();

        // Save index
        save_index(&wos, "idx_name", "users", "name").unwrap();

        // Load all indexes
        let indexes = load_all_indexes(&wos).unwrap();
        assert_eq!(indexes.len(), 1);
        assert_eq!(
            indexes.get("idx_name"),
            Some(&("users".to_string(), "name".to_string()))
        );

        // Delete index
        delete_index(&wos, "idx_name").unwrap();
        let deleted = load_all_indexes(&wos).unwrap();
        assert!(deleted.is_empty());
    }
}