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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

use pg_query::NodeEnum;

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

pub struct AddIndexNonConcurrent;

impl Rule for AddIndexNonConcurrent {
    fn id(&self) -> &'static str {
        "add-index-non-concurrent"
    }
    fn severity(&self) -> Severity {
        Severity::Error
    }

    fn check(&self, node: &NodeEnum, out: &mut Vec<RuleHit>) {
        if let NodeEnum::IndexStmt(stmt) = node {
            if !stmt.concurrent {
                out.push(RuleHit {
                    message: "CREATE INDEX without CONCURRENTLY takes a lock that blocks writes \
                              to the table for the entire build."
                        .into(),
                    guidance:
                        "Use CREATE INDEX CONCURRENTLY (outside a transaction block). A failed \
                               CONCURRENTLY build leaves an INVALID index: drop it with DROP INDEX \
                               CONCURRENTLY and retry, or rebuild with REINDEX INDEX CONCURRENTLY."
                            .into(),
                });
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::{lint_sql, LintOptions};

    #[test]
    fn flags_plain_create_index() {
        let findings = lint_sql("CREATE INDEX idx ON t (col)", &LintOptions::default()).unwrap();
        assert!(findings
            .iter()
            .any(|f| f.rule_id == "add-index-non-concurrent"));
    }

    #[test]
    fn ignores_concurrent_create_index() {
        let findings = lint_sql(
            "CREATE INDEX CONCURRENTLY idx ON t (col)",
            &LintOptions::default(),
        )
        .unwrap();
        assert!(findings
            .iter()
            .all(|f| f.rule_id != "add-index-non-concurrent"));
    }
}