pgsafe 0.8.6

Static safety linter for PostgreSQL DDL migrations — catches unsafe schema changes before they lock or break production.
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

use pg_query::protobuf::ConstrType;
use pg_query::NodeEnum;

use super::Rule;
use crate::{RuleHit, Severity};

pub struct AddExclusionConstraint;

impl Rule for AddExclusionConstraint {
    fn id(&self) -> &'static str {
        "add-exclusion-constraint"
    }
    fn severity(&self) -> Severity {
        Severity::Error
    }
    fn check(&self, node: &NodeEnum, out: &mut Vec<RuleHit>) {
        for c in super::constraints_being_added(node) {
            if matches!(
                ConstrType::try_from(c.contype),
                Ok(ConstrType::ConstrExclusion)
            ) {
                out.push(RuleHit {
                    message: "ALTER TABLE ... ADD CONSTRAINT ... EXCLUDE builds an index under an \
                              ACCESS EXCLUSIVE lock, scanning the whole table."
                        .into(),
                    guidance: "Adding an exclusion constraint locks the table while it builds the index. \
                               Add it during a low-traffic window; on a large table, weigh whether the \
                               constraint is necessary."
                        .into(),
                });
            }
        }
    }
}