sabiql 1.9.0

A fast, driver-less TUI for browsing and editing PostgreSQL databases
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

use super::column::Column;
use super::foreign_key::ForeignKey;
use super::index::Index;
use super::rls::RlsInfo;
use super::trigger::Trigger;

fn make_qualified_name(schema: &str, name: &str) -> String {
    format!("{}.{}", schema, name)
}

fn make_display_name(schema: &str, name: &str, omit_public: bool) -> String {
    if omit_public && schema == "public" {
        name.to_string()
    } else {
        make_qualified_name(schema, name)
    }
}

#[derive(Debug, Clone)]
pub struct Table {
    pub schema: String,
    pub name: String,
    pub owner: Option<String>,
    pub columns: Vec<Column>,
    pub primary_key: Option<Vec<String>>,
    pub foreign_keys: Vec<ForeignKey>,
    pub indexes: Vec<Index>,
    pub rls: Option<RlsInfo>,
    pub triggers: Vec<Trigger>,
    pub row_count_estimate: Option<i64>,
    pub comment: Option<String>,
}

impl Table {
    pub fn qualified_name(&self) -> String {
        make_qualified_name(&self.schema, &self.name)
    }

    pub fn display_name(&self, omit_public: bool) -> String {
        make_display_name(&self.schema, &self.name, omit_public)
    }
}

#[derive(Debug, Clone)]
pub struct TableSummary {
    pub schema: String,
    pub name: String,
    pub row_count_estimate: Option<i64>,
    pub has_rls: bool,
    // Pre-computed for efficient case-insensitive filtering
    qualified_name_lower: String,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct TableSignature {
    pub schema: String,
    pub name: String,
    pub signature: String,
}

impl TableSignature {
    pub fn qualified_name(&self) -> String {
        make_qualified_name(&self.schema, &self.name)
    }
}

impl TableSummary {
    pub fn new(
        schema: String,
        name: String,
        row_count_estimate: Option<i64>,
        has_rls: bool,
    ) -> Self {
        let qualified_name_lower = make_qualified_name(&schema, &name).to_lowercase();
        Self {
            schema,
            name,
            row_count_estimate,
            has_rls,
            qualified_name_lower,
        }
    }

    pub fn qualified_name(&self) -> String {
        make_qualified_name(&self.schema, &self.name)
    }

    pub fn qualified_name_lower(&self) -> &str {
        &self.qualified_name_lower
    }

    pub fn display_name(&self, omit_public: bool) -> String {
        make_display_name(&self.schema, &self.name, omit_public)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    fn make_table(schema: &str, name: &str) -> Table {
        Table {
            schema: schema.to_string(),
            name: name.to_string(),
            owner: None,
            columns: Vec::new(),
            primary_key: None,
            foreign_keys: Vec::new(),
            indexes: Vec::new(),
            rls: None,
            triggers: Vec::new(),
            row_count_estimate: None,
            comment: None,
        }
    }

    fn make_summary(schema: &str, name: &str) -> TableSummary {
        TableSummary::new(schema.to_string(), name.to_string(), None, false)
    }

    mod qualified_name {
        use super::*;

        #[test]
        fn returns_schema_dot_name() {
            let table = make_table("public", "users");

            assert_eq!(table.qualified_name(), "public.users");
        }
    }

    mod display_name {
        use super::*;

        #[test]
        fn omit_public_true_returns_name_only() {
            let table = make_table("public", "users");

            assert_eq!(table.display_name(true), "users");
        }

        #[test]
        fn omit_public_false_returns_qualified() {
            let table = make_table("public", "users");

            assert_eq!(table.display_name(false), "public.users");
        }
    }

    mod summary {
        use super::*;

        #[test]
        fn display_name_omits_public() {
            let summary = make_summary("public", "orders");

            assert_eq!(summary.display_name(true), "orders");
        }

        #[test]
        fn display_name_keeps_non_public_schema() {
            let summary = make_summary("audit", "logs");

            assert_eq!(summary.display_name(true), "audit.logs");
        }

        #[test]
        fn qualified_name_lower_returns_lowercased() {
            let summary = make_summary("MySchema", "MyTable");

            assert_eq!(summary.qualified_name_lower(), "myschema.mytable");
        }
    }
}