invr 0.2.1

Declarative data validation engine using invariants executed on Polars DataFrames.
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

///
/// Represents all invariant types supported by the Polars execution engine.
///
/// Each `PolarsKind` corresponds to a specific validation rule.
///
/// Execution model:
/// - `plan(kind)` builds a Polars `Expr`
/// - The expression is executed lazily
/// - The result metric is converted into a `Violation` via `map()`
///
/// Categories are grouped by semantic domain:
/// - Nullability
/// - Uniqueness
/// - Row count
/// - Structure
/// - Numeric
/// - Date / Time
/// - String
/// - Domain
/// - Statistical
/// - Relational
/// - Custom
///
/// This enum is intentionally explicit (instead of dynamic strings)
/// to improve type safety, discoverability, and AI-readability.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum PolarsKind {
    /// Nullability constraints
    NotNull,
    NullRatioMax,

    /// Uniqueness constraints
    Unique,
    CompositeUnique,
    DuplicateRatioMax,

    /// Dataset row count constraints
    RowCountMin,
    RowCountMax,
    RowCountBetween,

    /// Column structure and schema constraints
    ColumnExists,
    ColumnMissing,
    DTypeIs,
    SchemaEquals,

    /// Numeric value constraints
    ValueMin,
    ValueMax,
    ValueBetween,
    MeanBetween,
    StdDevMax,
    SumBetween,

    /// Date and time constraints
    DateBetween,
    NoFutureDates,
    MonotonicIncreasing,
    NoGapsInSequence,

    /// String-based constraints
    RegexMatch,
    StringLengthMin,
    StringLengthMax,
    StringLengthBetween,

    /// Domain / allowed value constraints
    AllowedValues,
    ForbiddenValues,

    /// Statistical and distribution-based constraints
    OutlierRatioMax,
    PercentileBetween,

    /// Relational / cross-column constraints
    ForeignKey,
    ColumnEquals,
    ConditionalNotNull,

    /// Custom Polars expression constraint
    CustomExpr,
}