schema_guard 1.9.1

Schema Guard: Relation Database (Schema) Management tool
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
520
521
522
523
524
extern crate postgres;

use std::collections::{BTreeMap, HashMap, HashSet};
use std::result::Result;

use postgres::Transaction;
use serde::Serialize;

use crate::utils::{Named, OrderedHashMap};

/// information schema types: schema, table, column
// BTreeMap use to keep dump schema order
pub type InfoSchemaType = BTreeMap<String, HashMap<String, PgTable>>;
pub type InfoSchemaTypeS = OrderedHashMap<OrderedHashMap<PgTable>>;

/// information schema types: schema, (owner, table: name: owner)
pub type InfoSchemaOwnerType = HashMap<String, (String, HashMap<String, String>)>;

#[derive(Debug, Clone, Serialize)]
/// information schema data
pub struct PgSchema {
    pub schema_name: String,
    pub tables: OrderedHashMap<PgTable>,
}

impl Named for PgSchema {
    fn get_name(&self) -> String {
        self.schema_name.clone()
    }
}

impl Named for PgTable {
    fn get_name(&self) -> String {
        self.table_name.clone()
    }
}

#[derive(Debug, Clone, Serialize)]
/// information schema data
pub struct PgTable {
    pub table_name: String,
    /// column name,
    pub columns: HashMap<String, PgColumnDfn>,
    /// column name, foreign schema, table, column, fk name
    pub fks: HashMap<String, FKTable>,
    /// trigger name, trigger's schema
    pub triggers: HashMap<String, String>,
    pub sort_order: usize,
    pub table_comment: Option<String>,
    pub owner: Option<String>,
    // pub grant: HashMap<String, String>,
}

const _PRIVILEGES: [&str; 14] = [
    "SELECT",
    "INSERT",
    "UPDATE",
    "DELETE",
    "TRUNCATE",
    "REFERENCES",
    "TRIGGER",
    "CREATE",
    "CONNECT",
    "TEMPORARY",
    "EXECUTE",
    "USAGE",
    "SET",
    "ALTER SYSTEM"
];

/// information schema column data
#[derive(Debug, Clone, Serialize)]
pub struct PgColumnDfn {
    pub column_name: String,
    pub column_type: String,
    pub column_default: Option<String>,
    pub sql: Option<String>,
    pub fk: Option<(String, String)>,
    pub pk: bool,
    pub nullable: bool,
    pub sort_order: usize,
    pub column_comment: Option<String>,
    // pub grant: list<String>,
}

/// FK information loaded from DB
#[derive(Debug, Clone, Serialize)]
pub struct FKTable {
    pub schema: String,
    pub table: String,
    pub column: HashSet<String>,
    pub name: String,
    pub sql: String,
}

impl FKTable {
    pub(crate) fn columns(&self) -> String {
        let mut cs = String::new();
        for c in &self.column {
            if cs.len() > 0 {
                cs.push_str(", ");
            }
            cs.push_str(c.as_str())
        }
        cs
    }
}

impl PgColumnDfn {
    fn new(column_name: &str, column_type: String, column_def: &str, nullable: bool, sort_order: usize) -> Self {
        PgColumnDfn {
            column_name: column_name.into(),
            column_type,
            column_default: if column_def.len() > 0 { Some(column_def.into()) } else { None },
            sql: None,
            fk: None,
            pk: false,
            nullable,
            sort_order,
            column_comment: None,
        }
    }

    pub(crate) fn def(&self, ignore_pk: bool) -> String {
        let mut sql = format!("{} {}", self.column_name, self.column_type);
        if self.pk && !ignore_pk {
            sql.push_str(" primary key");
        }
        if !self.nullable {
            sql.push_str(" not null");
        }
        if let Some(def) = &self.column_default {
            if def.len() > 0 {
                sql.push_str(" default ");
                sql.push_str(def.as_str());
            }
        }
        if let Some(ssql) = &self.sql {
            if ssql.len() > 0 {
                sql.push_str(" ");
                sql.push_str(ssql.as_str());
            }
        }
        sql
    }
}


pub fn load_info_schema(db_name: &str, db: &mut Transaction) -> Result<InfoSchemaType, String> {
    let mut data = load_info_cc(db_name, db)?;
    let _ = load_info_fk(db_name, db, &mut data)?;
    let _ = load_info_tg(db_name, db, &mut data)?;
    Ok(data)
}


// SELECT table_catalog, table_schema, table_name, column_name, column_default, is_nullable, data_type, udt_name, character_maximum_length, numeric_precision, numeric_scale, ordinal_position from information_schema.columns where table_schema not in ('pg_catalog', 'information_schema') and table_name = table_catalog = $1
#[inline]
fn load_info_cc(db_name: &str, db: &mut Transaction) -> Result<InfoSchemaType, String> {
    let mut data: InfoSchemaType = Default::default();
    let result = db.query("SELECT table_catalog, table_schema, table_name, column_name, column_default, is_nullable, \
    data_type, udt_name, character_maximum_length, numeric_precision, numeric_scale, ordinal_position \
     from information_schema.columns where table_schema not in ('pg_catalog', 'information_schema') and table_catalog = $1 \
      order by 1,2,3, ordinal_position", &[&db_name])
        .map_err(|e| format!("on loading information_schema [{}]: {}", db_name, e))?;
    let mut sort_order = 0;
    for r in result {
        sort_order += 1;
        let _table_catalog: &str = r.get(0);
        let table_schema: &str = r.get(1);
        let table_name: &str = r.get(2);
        let column_name: &str = r.get(3);
        let column_default: Option<&str> = r.get(4);
        let nullable: &str = r.get(5);
        let data_type: &str = r.get(6);
        let udt_name: &str = r.get(7);
        let character_maximum_length: Option<i32> = r.get(8);
        let numeric_precision: Option<i32> = r.get(9);
        let numeric_scale: Option<i32> = r.get(10);
        let mut data_type = if udt_name.len() == 0 { data_type.to_string() } else { udt_name.to_string() };
        if data_type.to_lowercase().as_str() == "varchar" {
            if let Some(varchar_len) = character_maximum_length {
                data_type.push_str(format!("({})", varchar_len).as_str());
            }
        } else {
            if let Some(numeric) = numeric_precision {
                if let Some(scale) = numeric_scale {
                    if scale > 0 {
                        data_type = format!("NUMERIC({}, {})", numeric, scale);
                    }
                }
            }
        }
        #[cfg(debug_assertions)]
        {
            if column_name == "id" {
                // println!("{}.id= {}", table_name, column_default.unwrap_or("NA"));
            }
        }
        let column_data = PgColumnDfn::new(column_name, data_type,
                                           column_default.unwrap_or(""), nullable.to_lowercase() == "yes", sort_order);
        match data.get_mut(table_schema) {
            None => {
                let mut hd = HashMap::new();
                hd.insert(table_name.into(), PgTable::new(table_name, column_name, column_data, sort_order));
                data.insert(table_schema.into(), hd);
            }
            Some(s) => {
                match s.get_mut(table_name) {
                    None => {
                        s.insert(table_name.into(), PgTable::new(table_name, column_name, column_data, sort_order));
                    }
                    Some(hd) => {
                        hd.columns.insert(column_name.into(), column_data);
                    }
                }
            }
        }
    }

    for (schema, tbls) in &mut data {
        let mut query = String::new();
        let mut tables = String::new();
        for tn in tbls.keys() {
            if !query.is_empty() {
                query.push(',');
                tables.push(',');
            }
            query.push_str(format!("'{}.{}'::regclass", schema, tn).as_str());
            tables.push_str(format!("'{}.{}'", schema, tn).as_str());
        }
        if !query.is_empty() {
            let result = db.query(format!("SELECT * from
(SELECT tabs.table_schema, tabs.table_name,
    pg_catalog.obj_description(tabs.table_name::regclass::oid) as table_comment
    FROM information_schema.tables tabs
    WHERE tabs.table_schema not in ('pg_catalog', 'information_schema') AND tabs.table_catalog = $1
     and tabs.table_name in ({})
    ) as ist WHERE ist.table_comment is not null order by 1,2", tables).as_str(), &[&db_name])
                .map_err(|e| format!("on loading table_comment from information_schema [{}]: {}", db_name, e))?;
            for r in result {
                // let table_schema: &str = r.get(0);
                let table_name: &str = r.get(1);
                let table_comment: &str = r.get(2);
                if let Some(t) = tbls.get_mut(table_name) {
                    t.table_comment = Some(table_comment.to_string());
                }
            }

            let result = db.query("SELECT schemaname, tablename, tableowner from pg_tables where schemaname = $1 ",
                                  &[&schema])
                .map_err(|e| format!("on loading table_owner from information_schema [{}]: {}", db_name, e))?;
            for r in result {
                // let table_schema: &str = r.get(0);
                let table_name: &str = r.get(1);
                let table_owner: &str = r.get(2);
                if let Some(t) = tbls.get_mut(table_name) {
                    t.owner = Some(table_owner.to_string());
                }
            }

            let result = db.query(format!("select * from
(SELECT cols.table_schema, cols.table_name, cols.column_name, pg_catalog.col_description(cols.table_name::regclass::oid, cols.ordinal_position::int) as column_comment
FROM information_schema.columns cols
WHERE cols.table_schema not in ('pg_catalog', 'information_schema')  AND cols.table_catalog = $1
 AND cols.table_name in ({})
) as iss where iss.column_comment is not null", tables).as_str(), &[&db_name])
                .map_err(|e| format!("on loading table_comment from information_schema [{}]: {}", db_name, e))?;
            for r in result {
                // let table_schema: &str = r.get(0);
                let table_name: &str = r.get(1);
                let column_name: &str = r.get(2);
                let column_comment: &str = r.get(3);
                if let Some(t) = tbls.get_mut(table_name) {
                    if let Some(c) = t.columns.get_mut(column_name) {
                        c.column_comment = Some(column_comment.to_string());
                    }
                }
            }

            let result = db.query(format!("SELECT relname, a.attname, indisprimary, indisunique
                    FROM pg_index i
                    JOIN pg_class pc on pc.oid = i.indrelid
                    JOIN pg_attribute a ON a.attrelid = i.indrelid AND a.attnum = ANY(i.indkey)
                    WHERE (i.indisprimary or i.indisunique) and i.indrelid in ({})", query).as_str(), &[])
                .map_err(|e| format!("on loading information_schema pk/uniq: {}", e))?;
            for r in result {
                let table_name: &str = r.get(0);
                let col_name: &str = r.get(1);
                let indisprimary: bool = r.get(2);
                let indisunique: bool = r.get(3);
                if let Some(st) = tbls.get_mut(table_name) {
                    if let Some(ct) = st.columns.get_mut(col_name) {
                        if indisprimary {
                            ct.pk = true;
                            if let Some(cd) = &ct.column_default {
                                let seq = format!("{}_id_seq'::regclass)", table_name);
                                if !ct.nullable && ct.column_type.starts_with("int")
                                    && cd.starts_with("nextval('")
                                    && cd.ends_with(seq.as_str()) {
                                    ct.column_default = None;
                                    ct.column_type =
                                        if ct.column_type.as_str() == "int4" {
                                            "serial"
                                        } else {
                                            "bigserial"
                                        }.to_string();
                                }
                            }
                        }

                        if indisunique {
                            ct.sql = Some("UNIQUE".into());
                        }
                    }
                }
            }
        }
    }


    Ok(data)
}

#[inline]
fn load_info_tg(db_name: &str, db: &mut Transaction, data: &mut InfoSchemaType) -> Result<(), String> {
    match db.query("SELECT trigger_catalog, trigger_schema, trigger_name, event_object_catalog, event_object_schema, event_object_table \
        from information_schema.triggers where event_object_schema not in ('pg_catalog', 'information_schema') and trigger_catalog = $1 \
        order by created", &[&db_name]) {
        Err(e) => Err(format!("on loading information_schema.triggers: {}", e)),
        Ok(result) => {
            let mut sort_order = 0;
            for r in result {
                sort_order += 1;
                let trigger_catalog: &str = r.get(0);
                let trigger_schema: &str = r.get(1);
                let trigger_name: &str = r.get(2);
                let event_object_catalog: &str = r.get(3);
                let event_object_schema: &str = r.get(4);
                let event_object_table: &str = r.get(5);
                let trigger_data = format!("{} {} {}", trigger_catalog, trigger_schema, event_object_catalog);
                match data.get_mut(event_object_schema) {
                    None => {
                        let mut hd = HashMap::new();
                        hd.insert(event_object_table.into(), PgTable::newt(event_object_table, trigger_name, trigger_data, sort_order));
                        data.insert(event_object_schema.into(), hd);
                    }
                    Some(s) => {
                        match s.get_mut(event_object_table) {
                            None => {
                                s.insert(event_object_table.into(), PgTable::newt(event_object_table, trigger_name, trigger_data, sort_order));
                            }
                            Some(hd) => {
                                hd.triggers.insert(trigger_name.into(), trigger_data);
                            }
                        }
                    }
                }
            }
            Ok(())
        }
    }
}

const NO_ACTION: &str = "NO ACTION";

#[inline]
// db: &mut Transaction,
// db: &mut Client
fn load_info_fk(db_name: &str, db: &mut Transaction, data: &mut InfoSchemaType) -> Result<(), String> {
    match db.query("SELECT tc.table_schema,  tc.table_name, kcu.column_name,
 ccu.table_schema AS foreign_schema_name, ccu.table_name AS foreign_table_name, ccu.column_name AS foreign_column_name, tc.constraint_name,
 rc.match_option, rc.update_rule, rc.delete_rule
 FROM information_schema.table_constraints AS tc
 JOIN information_schema.key_column_usage AS kcu ON tc.constraint_name = kcu.constraint_name
 JOIN information_schema.constraint_column_usage AS ccu ON ccu.constraint_name = tc.constraint_name
 join information_schema.referential_constraints as rc on tc.constraint_name = rc.constraint_name
 WHERE constraint_type = 'FOREIGN KEY' and tc.table_catalog = $1", &[&db_name]) {
        Err(e) => Err(format!("on loading information_schema.fk: {}", e)),
        Ok(result) => {
            for r in result {
                let table_schema: &str = r.get(0);
                let table_name: &str = r.get(1);
                let column_name: &str = r.get(2);
                let foreign_schema_name: &str = r.get(3);
                let foreign_table_name: &str = r.get(4);
                let foreign_column_name: &str = r.get(5);
                let constraint_name: &str = r.get(6);
                let _match_option: &str = r.get(7);
                let update_rule: &str = r.get(8);
                let delete_rule: &str = r.get(9);
                let sql = if update_rule == NO_ACTION && delete_rule == NO_ACTION {
                    "".to_string()
                } else {
                    format!("ON UPDATE {} ON DELETE {}", update_rule, delete_rule)
                };
                if let Some(s) = data.get_mut(table_schema) {
                    if let Some(hd) = s.get_mut(table_name) {
                        if let Some(column) = hd.columns.get_mut(column_name) {
                            column.fk = Some((format!("{}.{}", foreign_schema_name, foreign_table_name),
                                              sql.clone()
                            ));
                        }
                        let constraint_name = constraint_name.to_string();

                        match hd.fks.get_mut(&constraint_name) {
                            None => {
                                let mut column = HashSet::new();
                                column.insert(foreign_column_name.to_string());
                                hd.fks.insert(column_name.into(), FKTable {
                                    schema: foreign_schema_name.to_string(),
                                    table: foreign_table_name.to_string(),
                                    column,
                                    name: constraint_name.to_string(),
                                    sql,
                                });
                            }
                            Some(fks) => {
                                fks.column.insert(foreign_column_name.to_string());
                            }
                        }
                    }
                }
            }
            Ok(())
        }
    }
}

#[inline]
pub fn load_info_schema_owner(db_name: &str, db: &mut Transaction) -> Result<InfoSchemaOwnerType, String> {
    let mut res = HashMap::new();
    match db.query("select schema_name, schema_owner from information_schema.schemata where schema_name not in ('information_schema', 'pg_catalog')", &[]) {
        Ok(schemas) => {
            for schema in schemas {
                let schema_name: &str = schema.get(0);
                let schema_owner: &str = schema.get(1);
                let mut tables = HashMap::new();
                match db.query("select t.table_name, u.usename
from information_schema.tables t
join pg_catalog.pg_class c on (t.table_name = c.relname)
join pg_catalog.pg_user u on (c.relowner = u.usesysid)
where t.table_schema = $1 and t.table_catalog = $2 ", &[&schema_name, &db_name]) {
                    Err(e) => { return Err(format!("on loading information_schema.owner: {}", e)); }
                    Ok(result) => {
                        for r in result {
                            let table_name: &str = r.get(0);
                            let table_owner: &str = r.get(1);
                            tables.insert(table_name.into(), table_owner.into());
                        }
                    }
                }
                res.insert(schema_name.into(), (schema_owner.into(), tables));
            }
            Ok(res)
        }
        Err(e) => Err(format!("on loading information schema owners: {}", e)),
    }
}

impl Default for PgTable {
    fn default() -> Self {
        PgTable {
            table_name: "".to_string(),
            columns: Default::default(),
            fks: Default::default(),
            triggers: Default::default(),
            sort_order: 0,
            table_comment: None,
            owner: None,
        }
    }
}

impl PgTable {
    /// pre loaded on information_schema.columns
    #[inline]
    fn new(table: &str, column: &str, column_data: PgColumnDfn, sort_order: usize) -> Self {
        let mut cls = HashMap::new();
        cls.insert(column.into(), column_data);
        PgTable {
            table_name: table.into(),
            columns: cls,
            sort_order,
            ..PgTable::default()
        }
    }

    /// should not called
    #[inline]
    fn newt(table: &str, trig: &str, trig_data: String, sort_order: usize) -> Self {
        let mut tgs = HashMap::new();
        tgs.insert(trig.into(), trig_data);
        PgTable {
            table_name: table.into(),
            triggers: tgs,
            sort_order,
            ..PgTable::default()
        }
    }

    /// проверяет колонки на РК, если несколько, то выдает готовый кусок SQL,
    /// если одна колонка, то будет написано в def() колонке
    /// возвращает только, если 2 колонки
    pub(crate) fn pks(&self) -> Option<String> {
        let mut pks = ", PRIMARY KEY (".to_string();
        let mut cnt = 0;
        for c in self.columns.values() {
            if c.pk {
                cnt += 1;
                if cnt > 1 {
                    pks.push_str(", ");
                }
                pks.push_str(c.column_name.as_str());
            }
        }
        if cnt > 1 {
            pks.push_str(") ");
            Some(pks)
        } else {
            None
        }
    }
}