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

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

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

pub struct AddColumnIdentity;

impl Rule for AddColumnIdentity {
    fn id(&self) -> &'static str {
        "add-column-identity"
    }
    fn severity(&self) -> Severity {
        Severity::Error
    }
    fn check(&self, node: &NodeEnum, out: &mut Vec<RuleHit>) {
        for col in super::columns_being_added(node) {
            // Both GENERATED ALWAYS / BY DEFAULT AS IDENTITY produce a ConstrIdentity
            // constraint; GENERATED ... STORED is ConstrGenerated and does not match.
            if super::column_has_constraint(col, ConstrType::ConstrIdentity) {
                out.push(RuleHit {
                    message:
                        "ADD COLUMN ... GENERATED AS IDENTITY creates a sequence and rewrites \
                              every existing row under an ACCESS EXCLUSIVE lock."
                            .into(),
                    guidance:
                        "Add a plain nullable integer column, backfill existing rows in batches, \
                               then attach the identity/sequence — do not add an identity column \
                               directly to a populated table."
                            .into(),
                });
            }
        }
    }
}