pgsafe 0.9.0

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

use pg_query::NodeEnum;

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

/// The serial pseudo-types. Each is sugar for a sequence + `nextval` default +
/// NOT NULL, so adding one to a populated table rewrites every row.
const SERIAL_TYPES: &[&str] = &[
    "serial",
    "serial2",
    "serial4",
    "serial8",
    "smallserial",
    "bigserial",
];

pub struct AddColumnSerial;

impl Rule for AddColumnSerial {
    fn id(&self) -> &'static str {
        "add-column-serial"
    }
    fn severity(&self) -> Severity {
        Severity::Error
    }
    fn check(&self, node: &NodeEnum, out: &mut Vec<RuleHit>) {
        for col in super::columns_being_added(node) {
            let Some(type_name) = col.type_name.as_ref() else {
                continue;
            };
            // Serial pseudo-types parse as a single, unqualified name; real types
            // are schema-qualified (e.g. ["pg_catalog", "int8"]).
            if type_name.names.len() != 1 {
                continue;
            }
            let is_serial = matches!(
                type_name.names.first().and_then(|n| n.node.as_ref()),
                Some(NodeEnum::String(s))
                    if SERIAL_TYPES.iter().any(|t| t.eq_ignore_ascii_case(&s.sval))
            );
            if is_serial {
                out.push(RuleHit {
                    message: "ADD COLUMN with a serial type (e.g. bigserial) creates a sequence and \
                              rewrites every existing row under an ACCESS EXCLUSIVE lock."
                        .into(),
                    guidance: "Add a plain nullable integer column (e.g. bigint), create the sequence \
                               and backfill existing rows in batches, then ALTER COLUMN ... SET DEFAULT \
                               nextval(...) and add NOT NULL via the safe two-step — do not add serial \
                               directly to a populated table."
                        .into(),
                    fix: None,
                });
            }
        }
    }
}