lix 0.12.1

Embeddable version control for apps and AI agents.
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

#[derive(Clone, Debug, Eq, PartialEq)]
pub(crate) struct PublicColumn {
    pub(crate) id: usize,
    pub(crate) name: String,
    /// Whether a row returned by the public SQL surface may contain SQL NULL.
    ///
    /// This is a SQL surface contract, not a copy of the provider's Arrow
    /// field. Provider schemas also serve planning and write normalization and
    /// can therefore be more permissive than the values a public read emits.
    pub(crate) read_nullable: bool,
    pub(crate) role: PublicColumnRole,
    pub(crate) write: PublicColumnWrite,
    pub(crate) insert_policy: PublicColumnInsertPolicy,
    pub(crate) column_default: Option<String>,
}

impl PublicColumn {
    pub(crate) fn public(name: impl Into<String>, read_nullable: bool) -> Self {
        Self {
            id: 0,
            name: name.into(),
            read_nullable,
            role: PublicColumnRole::Public,
            write: PublicColumnWrite::READ_WRITE,
            insert_policy: PublicColumnInsertPolicy::Required,
            column_default: None,
        }
    }

    pub(crate) fn public_insert_only(name: impl Into<String>, read_nullable: bool) -> Self {
        Self {
            id: 0,
            name: name.into(),
            read_nullable,
            role: PublicColumnRole::Public,
            write: PublicColumnWrite {
                insert: true,
                update: false,
            },
            insert_policy: PublicColumnInsertPolicy::Required,
            column_default: None,
        }
    }

    pub(crate) fn public_read_only(name: impl Into<String>, read_nullable: bool) -> Self {
        Self {
            id: 0,
            name: name.into(),
            read_nullable,
            role: PublicColumnRole::Public,
            write: PublicColumnWrite::READ_ONLY,
            insert_policy: PublicColumnInsertPolicy::ReadOnly,
            column_default: None,
        }
    }

    pub(crate) fn hidden(name: impl Into<String>, read_nullable: bool) -> Self {
        Self {
            id: 0,
            name: name.into(),
            read_nullable,
            role: PublicColumnRole::Hidden,
            write: PublicColumnWrite::READ_ONLY,
            insert_policy: PublicColumnInsertPolicy::ReadOnly,
            column_default: None,
        }
    }

    pub(crate) fn optional_on_insert(mut self) -> Self {
        self.insert_policy = PublicColumnInsertPolicy::Optional;
        self
    }

    pub(crate) fn conditional_on_insert(mut self) -> Self {
        self.insert_policy = PublicColumnInsertPolicy::Conditional;
        self
    }

    pub(crate) fn with_default(mut self, default: impl Into<String>) -> Self {
        self.insert_policy = PublicColumnInsertPolicy::Default;
        self.column_default = Some(default.into());
        self
    }

    pub(crate) fn is_public(&self) -> bool {
        self.role == PublicColumnRole::Public
    }

    pub(crate) fn with_id(mut self, id: usize) -> Self {
        self.id = id;
        self
    }

    pub(crate) fn is_insertable(&self) -> bool {
        self.write.insert
    }

    pub(crate) fn is_updatable(&self) -> bool {
        self.write.update
    }
}

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub(crate) enum PublicColumnInsertPolicy {
    ReadOnly,
    Required,
    Optional,
    Conditional,
    Default,
}

impl PublicColumnInsertPolicy {
    pub(crate) fn as_str(self) -> &'static str {
        match self {
            Self::ReadOnly => "READ_ONLY",
            Self::Required => "REQUIRED",
            Self::Optional => "OPTIONAL",
            Self::Conditional => "CONDITIONAL",
            Self::Default => "DEFAULT",
        }
    }
}

#[derive(Clone, Debug, Eq, PartialEq)]
pub(crate) enum PublicColumnRole {
    Public,
    Hidden,
}

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub(crate) struct PublicColumnWrite {
    insert: bool,
    update: bool,
}

impl PublicColumnWrite {
    const READ_WRITE: Self = Self {
        insert: true,
        update: true,
    };
    const READ_ONLY: Self = Self {
        insert: false,
        update: false,
    };
}