omnigraph-compiler 0.5.0

Schema/query compiler for Omnigraph. Zero Lance dependency.
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

//! Diagnostic types for the schema-lint chassis (MR-694).
//!
//! Every schema-migration diagnostic carries a stable code (`OG-XXX-NNN`),
//! a family grouping (DS / MF / CD / …), and a safety tier
//! (safe / validated / destructive). The code is the public identity;
//! external tooling and operators reference rules by code, not by message.
//!
//! This module is the chassis-level vocabulary. The concrete code catalog
//! lives in [`super::codes`]; emission sites are in
//! `catalog::schema_plan` and (future) other lint passes.

/// Family groupings for schema-lint rules. Mirrors the Atlas analyzer
/// families (DS / MF / CD / BC / NM) plus four omnigraph-native families
/// for vector/embedding (VE), edge topology (ED), lock/cost (LK), and
/// non-linear branch divergence (NL). Ownership (OW) is reserved for
/// per-resource Cedar policy integration (MR-722).
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum Family {
    /// Destructive — data-loss class. Always requires explicit opt-in.
    DS,
    /// Maybe-fail — data-dependent, may fail on existing rows.
    MF,
    /// Constraint deletion — invariant relaxation; consumer-warning.
    CD,
    /// Backward incompatible — rename or shape change that breaks clients.
    BC,
    /// Naming conventions.
    NM,
    /// Ownership — per-resource access control.
    OW,
    /// Non-linear — branch-merge schema-state divergence.
    NL,
    /// Vector / embedding — omnigraph-native.
    VE,
    /// Edge / graph topology — omnigraph-native.
    ED,
    /// Lock duration / cost — omnigraph-native.
    LK,
}

impl Family {
    pub fn prefix(self) -> &'static str {
        match self {
            Self::DS => "DS",
            Self::MF => "MF",
            Self::CD => "CD",
            Self::BC => "BC",
            Self::NM => "NM",
            Self::OW => "OW",
            Self::NL => "NL",
            Self::VE => "VE",
            Self::ED => "ED",
            Self::LK => "LK",
        }
    }
}

/// Tier classification for a migration step. Determines apply-path
/// behavior:
/// - `Safe`: applies without scan or flag.
/// - `Validated`: requires a single-pass scan of existing rows; fails on
///   the first violation.
/// - `Destructive`: requires explicit `--allow-data-loss` (or equivalent
///   opt-in) at apply time.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum SafetyTier {
    Safe,
    Validated,
    Destructive,
}

/// Severity for a diagnostic at the user-facing surface. Defaults are set
/// per code in [`super::codes`]; operators override via `omnigraph.yaml`
/// (planned for a follow-up PR).
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum Severity {
    /// Blocks apply.
    Error,
    /// Reported but doesn't block.
    Warn,
    /// Informational; doesn't block.
    Info,
}