pgcrab 0.1.0

Linting and documentation generation tool for Postgres database schemas
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

// SPDX-FileCopyrightText: 2025 Olivier 'reivilibre'
//
// SPDX-License-Identifier: GPL-3.0-or-later

//! Schema lint rules taken from [`pg-index-health-sql`].
//! Not all rules were adopted. Some are instead part of the 'Do Not Do This' set.
//!
//! [`pg-index-health-sql`]: https://github.com/mfvanek/pg-index-health-sql

use crate::make_lint;

use super::{
    macros::{loc_foreign_key, loc_foreign_keys, loc_index, loc_indexes, loc_object, loc_table},
    SchemaDiagnostic, SchemaDiagnosticRule,
};
use eyre::WrapErr;
use postgres::Transaction;

make_lint!(
    lint_possible_object_name_truncation,
    possible_object_name_truncation,
    PossibleObjectNameTruncation,
    loc_object
);

make_lint!(
    lint_duplicate_indexes,
    duplicate_indexes,
    DuplicateIndexes,
    loc_indexes
);

make_lint!(
    lint_duplicate_foreign_keys,
    duplicate_foreign_keys,
    DuplicateForeignKeys,
    loc_foreign_keys
);

make_lint!(
    lint_foreign_key_without_index,
    foreign_key_without_index,
    ForeignKeyWithoutIndex,
    loc_foreign_key
);

make_lint!(
    lint_foreign_key_with_unmatched_column_type,
    foreign_key_with_unmatched_column_type,
    ForeignKeyWithUnmatchedColumnType,
    loc_foreign_key
);

make_lint!(
    lint_index_with_redundant_where_clause,
    index_with_redundant_where_clause,
    IndexWithRedundantWhereClause,
    loc_index
);

make_lint!(
    lint_overlapping_indexes,
    overlapping_indexes,
    OverlappingIndexes,
    loc_indexes
);

make_lint!(
    lint_overlapping_foreign_keys,
    overlapping_foreign_keys,
    OverlappingForeignKeys,
    loc_foreign_keys
);

make_lint!(
    lint_table_without_primary_key,
    table_without_primary_key,
    TableWithoutPrimaryKey,
    loc_table
);

make_lint!(
    lint_btree_index_on_array_column,
    btree_index_on_array_column,
    BtreeIndexOnArrayColumn,
    loc_index
);

make_lint!(
    lint_index_with_boolean,
    index_with_boolean,
    IndexWithBoolean,
    loc_index
);

// TODO:
// indexes_with_timestamp_in_the_middle.sql NOT SURE

pub const LINTS: &[fn(&mut Transaction) -> eyre::Result<Vec<SchemaDiagnostic>>] = &[
    lint_possible_object_name_truncation,
    lint_duplicate_indexes,
    lint_duplicate_foreign_keys,
    lint_foreign_key_without_index,
    lint_foreign_key_with_unmatched_column_type,
    lint_index_with_redundant_where_clause,
    lint_overlapping_indexes,
    lint_overlapping_foreign_keys,
    lint_table_without_primary_key,
    lint_btree_index_on_array_column,
    lint_index_with_boolean,
];