contextdb-core 0.3.4

Core types, traits, and error types for contextdb
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
use crate::Direction;
use serde::{Deserialize, Serialize};
use std::collections::HashMap;

#[derive(Debug, Clone, Default, Serialize)]
pub struct TableMeta {
    pub columns: Vec<ColumnDef>,
    pub immutable: bool,
    pub state_machine: Option<StateMachineConstraint>,
    #[serde(default)]
    pub dag_edge_types: Vec<String>,
    #[serde(default)]
    pub unique_constraints: Vec<Vec<String>>,
    pub natural_key_column: Option<String>,
    #[serde(default)]
    pub propagation_rules: Vec<PropagationRule>,
    #[serde(default)]
    pub default_ttl_seconds: Option<u64>,
    #[serde(default)]
    pub sync_safe: bool,
    #[serde(default)]
    pub expires_column: Option<String>,
    #[serde(default)]
    pub indexes: Vec<IndexDecl>,
}

// Custom `Deserialize` that tolerates prior on-disk `TableMeta` encoded
// without the trailing `indexes` field (backward-compat).
impl<'de> serde::Deserialize<'de> for TableMeta {
    fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        use serde::de::{MapAccess, SeqAccess, Visitor};
        use std::fmt;

        struct TableMetaVisitor;

        impl<'de> Visitor<'de> for TableMetaVisitor {
            type Value = TableMeta;

            fn expecting(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
                f.write_str("a TableMeta")
            }

            fn visit_seq<A>(self, mut seq: A) -> std::result::Result<TableMeta, A::Error>
            where
                A: SeqAccess<'de>,
            {
                let columns = seq
                    .next_element::<Vec<ColumnDef>>()?
                    .ok_or_else(|| serde::de::Error::invalid_length(0, &self))?;
                let immutable = seq
                    .next_element::<bool>()?
                    .ok_or_else(|| serde::de::Error::invalid_length(1, &self))?;
                let state_machine = seq
                    .next_element::<Option<StateMachineConstraint>>()?
                    .ok_or_else(|| serde::de::Error::invalid_length(2, &self))?;
                let dag_edge_types = seq.next_element::<Vec<String>>()?.unwrap_or_default();
                let unique_constraints =
                    seq.next_element::<Vec<Vec<String>>>()?.unwrap_or_default();
                let natural_key_column = seq.next_element::<Option<String>>()?.unwrap_or_default();
                let propagation_rules = seq
                    .next_element::<Vec<PropagationRule>>()?
                    .unwrap_or_default();
                let default_ttl_seconds = seq.next_element::<Option<u64>>()?.unwrap_or_default();
                let sync_safe = seq.next_element::<bool>()?.unwrap_or_default();
                // Ok(None) at a declared-length tail is legitimate serde
                // behavior (declared-length sequence exhausted). Decode
                // errors, in contrast, indicate corruption or incompatible
                // on-disk payloads and must propagate rather than silently
                // default.
                let expires_column = seq.next_element::<Option<String>>()?.unwrap_or_default();
                let indexes = seq.next_element::<Vec<IndexDecl>>()?.unwrap_or_default();
                Ok(TableMeta {
                    columns,
                    immutable,
                    state_machine,
                    dag_edge_types,
                    unique_constraints,
                    natural_key_column,
                    propagation_rules,
                    default_ttl_seconds,
                    sync_safe,
                    expires_column,
                    indexes,
                })
            }

            fn visit_map<A>(self, mut map: A) -> std::result::Result<TableMeta, A::Error>
            where
                A: MapAccess<'de>,
            {
                let mut columns: Option<Vec<ColumnDef>> = None;
                let mut immutable: Option<bool> = None;
                let mut state_machine: Option<Option<StateMachineConstraint>> = None;
                let mut dag_edge_types: Option<Vec<String>> = None;
                let mut unique_constraints: Option<Vec<Vec<String>>> = None;
                let mut natural_key_column: Option<Option<String>> = None;
                let mut propagation_rules: Option<Vec<PropagationRule>> = None;
                let mut default_ttl_seconds: Option<Option<u64>> = None;
                let mut sync_safe: Option<bool> = None;
                let mut expires_column: Option<Option<String>> = None;
                let mut indexes: Option<Vec<IndexDecl>> = None;

                while let Some(key) = map.next_key::<String>()? {
                    match key.as_str() {
                        "columns" => columns = Some(map.next_value()?),
                        "immutable" => immutable = Some(map.next_value()?),
                        "state_machine" => state_machine = Some(map.next_value()?),
                        "dag_edge_types" => dag_edge_types = Some(map.next_value()?),
                        "unique_constraints" => unique_constraints = Some(map.next_value()?),
                        "natural_key_column" => natural_key_column = Some(map.next_value()?),
                        "propagation_rules" => propagation_rules = Some(map.next_value()?),
                        "default_ttl_seconds" => default_ttl_seconds = Some(map.next_value()?),
                        "sync_safe" => sync_safe = Some(map.next_value()?),
                        "expires_column" => expires_column = Some(map.next_value()?),
                        "indexes" => indexes = Some(map.next_value()?),
                        _ => {
                            let _: serde::de::IgnoredAny = map.next_value()?;
                        }
                    }
                }

                Ok(TableMeta {
                    columns: columns.ok_or_else(|| serde::de::Error::missing_field("columns"))?,
                    immutable: immutable
                        .ok_or_else(|| serde::de::Error::missing_field("immutable"))?,
                    state_machine: state_machine.unwrap_or_default(),
                    dag_edge_types: dag_edge_types.unwrap_or_default(),
                    unique_constraints: unique_constraints.unwrap_or_default(),
                    natural_key_column: natural_key_column.unwrap_or_default(),
                    propagation_rules: propagation_rules.unwrap_or_default(),
                    default_ttl_seconds: default_ttl_seconds.unwrap_or_default(),
                    sync_safe: sync_safe.unwrap_or_default(),
                    expires_column: expires_column.unwrap_or_default(),
                    indexes: indexes.unwrap_or_default(),
                })
            }
        }

        const FIELDS: &[&str] = &[
            "columns",
            "immutable",
            "state_machine",
            "dag_edge_types",
            "unique_constraints",
            "natural_key_column",
            "propagation_rules",
            "default_ttl_seconds",
            "sync_safe",
            "expires_column",
            "indexes",
        ];
        deserializer.deserialize_struct("TableMeta", FIELDS, TableMetaVisitor)
    }
}

/// Direction for a column within an engine-local index declaration.
/// Distinct from `contextdb_parser::ast::SortDirection`, which carries a
/// `CosineDistance` variant that is meaningful only for vector ordering.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, Default)]
pub enum SortDirection {
    #[default]
    Asc,
    Desc,
}

/// How an index entered `TableMeta.indexes`. `Auto` indexes are synthesized
/// at CREATE TABLE time from PRIMARY KEY / UNIQUE constraints. `UserDeclared`
/// indexes come from `CREATE INDEX` DDL. The distinction drives surface
/// rendering (auto-indexes omitted from `.schema`), schema-rendering verbose
/// flags, and sync DDL emission (auto-indexes are not re-emitted since they
/// are derived from the CreateTable payload).
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, Default)]
pub enum IndexKind {
    Auto,
    #[default]
    UserDeclared,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct IndexDecl {
    pub name: String,
    pub columns: Vec<(String, SortDirection)>,
    #[serde(default)]
    pub kind: IndexKind,
}

impl IndexDecl {
    pub fn estimated_bytes(&self) -> usize {
        32 + self.name.len() * 16
            + self
                .columns
                .iter()
                .fold(0usize, |acc, (c, _)| acc.saturating_add(24 + c.len() * 16))
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum PropagationRule {
    ForeignKey {
        fk_column: String,
        referenced_table: String,
        referenced_column: String,
        trigger_state: String,
        target_state: String,
        max_depth: u32,
        abort_on_failure: bool,
    },
    Edge {
        edge_type: String,
        direction: Direction,
        trigger_state: String,
        target_state: String,
        max_depth: u32,
        abort_on_failure: bool,
    },
    VectorExclusion {
        trigger_state: String,
    },
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct StateMachineConstraint {
    pub column: String,
    pub transitions: HashMap<String, Vec<String>>,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
pub struct ColumnDef {
    pub name: String,
    pub column_type: ColumnType,
    pub nullable: bool,
    pub primary_key: bool,
    #[serde(default)]
    pub unique: bool,
    #[serde(default)]
    pub default: Option<String>,
    #[serde(default)]
    pub references: Option<ForeignKeyReference>,
    #[serde(default)]
    pub expires: bool,
    #[serde(default)]
    pub immutable: bool,
}

// Custom `Deserialize` that tolerates prior on-disk schemas missing the
// `immutable` field (backward-compat, I5). Attempts to deserialize the full
// nine-field struct; on sequence truncation at the trailing `immutable`
// position, defaults it to `false`. JSON / other formats that distinguish
// "missing field" from "required field" continue to work via `serde(default)`
// on the field itself.
impl<'de> serde::Deserialize<'de> for ColumnDef {
    fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        use serde::de::{MapAccess, SeqAccess, Visitor};
        use std::fmt;

        struct ColumnDefVisitor;

        impl<'de> Visitor<'de> for ColumnDefVisitor {
            type Value = ColumnDef;

            fn expecting(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
                f.write_str("a ColumnDef")
            }

            fn visit_seq<A>(self, mut seq: A) -> std::result::Result<ColumnDef, A::Error>
            where
                A: SeqAccess<'de>,
            {
                let name = seq
                    .next_element::<String>()?
                    .ok_or_else(|| serde::de::Error::invalid_length(0, &self))?;
                let column_type = seq
                    .next_element::<ColumnType>()?
                    .ok_or_else(|| serde::de::Error::invalid_length(1, &self))?;
                let nullable = seq
                    .next_element::<bool>()?
                    .ok_or_else(|| serde::de::Error::invalid_length(2, &self))?;
                let primary_key = seq
                    .next_element::<bool>()?
                    .ok_or_else(|| serde::de::Error::invalid_length(3, &self))?;
                let unique = seq.next_element::<bool>()?.unwrap_or_default();
                let default = seq.next_element::<Option<String>>()?.unwrap_or_default();
                let references = seq
                    .next_element::<Option<ForeignKeyReference>>()?
                    .unwrap_or_default();
                let expires = seq.next_element::<bool>()?.unwrap_or_default();
                // Trailing field. `Ok(None)` means the declared-length seq
                // ended naturally (legitimate for JSON paths). Decode errors
                // propagate — silently defaulting to `false` would let a
                // corrupt payload pose as a non-immutable column.
                let immutable = seq.next_element::<bool>()?.unwrap_or_default();
                Ok(ColumnDef {
                    name,
                    column_type,
                    nullable,
                    primary_key,
                    unique,
                    default,
                    references,
                    expires,
                    immutable,
                })
            }

            fn visit_map<A>(self, mut map: A) -> std::result::Result<ColumnDef, A::Error>
            where
                A: MapAccess<'de>,
            {
                let mut name: Option<String> = None;
                let mut column_type: Option<ColumnType> = None;
                let mut nullable: Option<bool> = None;
                let mut primary_key: Option<bool> = None;
                let mut unique: Option<bool> = None;
                let mut default: Option<Option<String>> = None;
                let mut references: Option<Option<ForeignKeyReference>> = None;
                let mut expires: Option<bool> = None;
                let mut immutable: Option<bool> = None;

                while let Some(key) = map.next_key::<String>()? {
                    match key.as_str() {
                        "name" => name = Some(map.next_value()?),
                        "column_type" => column_type = Some(map.next_value()?),
                        "nullable" => nullable = Some(map.next_value()?),
                        "primary_key" => primary_key = Some(map.next_value()?),
                        "unique" => unique = Some(map.next_value()?),
                        "default" => default = Some(map.next_value()?),
                        "references" => references = Some(map.next_value()?),
                        "expires" => expires = Some(map.next_value()?),
                        "immutable" => immutable = Some(map.next_value()?),
                        _ => {
                            let _: serde::de::IgnoredAny = map.next_value()?;
                        }
                    }
                }

                Ok(ColumnDef {
                    name: name.ok_or_else(|| serde::de::Error::missing_field("name"))?,
                    column_type: column_type
                        .ok_or_else(|| serde::de::Error::missing_field("column_type"))?,
                    nullable: nullable
                        .ok_or_else(|| serde::de::Error::missing_field("nullable"))?,
                    primary_key: primary_key
                        .ok_or_else(|| serde::de::Error::missing_field("primary_key"))?,
                    unique: unique.unwrap_or_default(),
                    default: default.unwrap_or_default(),
                    references: references.unwrap_or_default(),
                    expires: expires.unwrap_or_default(),
                    immutable: immutable.unwrap_or_default(),
                })
            }
        }

        const FIELDS: &[&str] = &[
            "name",
            "column_type",
            "nullable",
            "primary_key",
            "unique",
            "default",
            "references",
            "expires",
            "immutable",
        ];
        deserializer.deserialize_struct("ColumnDef", FIELDS, ColumnDefVisitor)
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct ForeignKeyReference {
    pub table: String,
    pub column: String,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub enum ColumnType {
    Integer,
    Real,
    Text,
    Boolean,
    Json,
    Uuid,
    Vector(usize),
    Timestamp,
    TxId,
}

impl TableMeta {
    pub fn estimated_bytes(&self) -> usize {
        let columns_bytes = self.columns.iter().fold(0usize, |acc, column| {
            acc.saturating_add(column.estimated_bytes())
        });
        let state_machine_bytes = self
            .state_machine
            .as_ref()
            .map(StateMachineConstraint::estimated_bytes)
            .unwrap_or(0);
        let dag_bytes = self.dag_edge_types.iter().fold(0usize, |acc, edge_type| {
            acc.saturating_add(32 + edge_type.len() * 16)
        });
        let unique_constraint_bytes =
            self.unique_constraints.iter().fold(0usize, |acc, columns| {
                acc.saturating_add(
                    24 + columns
                        .iter()
                        .map(|column| 16 + column.len() * 16)
                        .sum::<usize>(),
                )
            });
        let natural_key_bytes = self
            .natural_key_column
            .as_ref()
            .map(|column| 32 + column.len() * 16)
            .unwrap_or(0);
        let propagation_bytes = self.propagation_rules.iter().fold(0usize, |acc, rule| {
            acc.saturating_add(rule.estimated_bytes())
        });
        let expires_bytes = self
            .expires_column
            .as_ref()
            .map(|column| 32 + column.len() * 16)
            .unwrap_or(0);
        let indexes_bytes = self
            .indexes
            .iter()
            .fold(0usize, |acc, i| acc.saturating_add(i.estimated_bytes()));

        16 + columns_bytes
            + state_machine_bytes
            + dag_bytes
            + unique_constraint_bytes
            + natural_key_bytes
            + propagation_bytes
            + expires_bytes
            + indexes_bytes
            + self.default_ttl_seconds.map(|_| 8).unwrap_or(0)
            + 8
    }
}

impl PropagationRule {
    fn estimated_bytes(&self) -> usize {
        match self {
            PropagationRule::ForeignKey {
                fk_column,
                referenced_table,
                referenced_column,
                trigger_state,
                target_state,
                ..
            } => {
                24 + fk_column.len() * 16
                    + referenced_table.len() * 16
                    + referenced_column.len() * 16
                    + trigger_state.len() * 16
                    + target_state.len() * 16
            }
            PropagationRule::Edge {
                edge_type,
                trigger_state,
                target_state,
                ..
            } => 24 + edge_type.len() * 16 + trigger_state.len() * 16 + target_state.len() * 16,
            PropagationRule::VectorExclusion { trigger_state } => 16 + trigger_state.len() * 16,
        }
    }
}

impl StateMachineConstraint {
    fn estimated_bytes(&self) -> usize {
        let transitions_bytes = self.transitions.iter().fold(0usize, |acc, (from, tos)| {
            acc.saturating_add(
                32 + from.len() * 16 + tos.iter().map(|to| 16 + to.len() * 16).sum::<usize>(),
            )
        });
        24 + self.column.len() * 16 + transitions_bytes
    }
}

impl ColumnDef {
    fn estimated_bytes(&self) -> usize {
        let default_bytes = self
            .default
            .as_ref()
            .map(|value| 32 + value.len() * 16)
            .unwrap_or(0);
        let reference_bytes = self
            .references
            .as_ref()
            .map(|reference| 32 + reference.table.len() * 16 + reference.column.len() * 16)
            .unwrap_or(0);
        8 + self.name.len() * 16
            + self.column_type.estimated_bytes()
            + default_bytes
            + reference_bytes
            + 8
    }
}

impl ColumnType {
    fn estimated_bytes(&self) -> usize {
        match self {
            ColumnType::Integer => 16,
            ColumnType::Real => 16,
            ColumnType::Text => 16,
            ColumnType::Boolean => 16,
            ColumnType::Json => 24,
            ColumnType::Uuid => 16,
            ColumnType::Vector(_) => 24,
            ColumnType::Timestamp => 16,
            ColumnType::TxId => 8,
        }
    }
}