safe-migrate 0.2.1

Lint PostgreSQL migrations against live database statistics to prevent blocking locks
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

use serde::{Deserialize, Serialize};
use std::collections::HashMap;

// ... (TableIdentity, IndexIdentity, AlterAction, MigrationOp, SpannedOp remain exactly the same) ...

#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct TableIdentity {
    pub schema: Option<String>,
    pub name: String,
}

impl TableIdentity {
    pub fn canonical_key(&self, default_schema: &str) -> String {
        let schema_name = self.schema.as_deref().unwrap_or(default_schema);
        format!("{}.{}", schema_name, self.name)
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct IndexIdentity {
    pub schema: Option<String>,
    pub name: String,
}

impl IndexIdentity {
    pub fn canonical_key(&self, default_schema: &str) -> String {
        let schema_name = self.schema.as_deref().unwrap_or(default_schema);
        format!("{}.{}", schema_name, self.name)
    }
}

#[non_exhaustive]
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub enum AlterAction {
    AddColumn,
    DropColumn,
    AlterColumnUnspecified,
    Other,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub enum MigrationOp {
    CreateTable(TableIdentity),
    DropTable(TableIdentity),
    CreateIndex {
        index_name: Option<String>,
        table: TableIdentity,
        concurrently: bool,
    },
    DropIndex {
        indexes: Vec<IndexIdentity>,
        concurrently: bool,
    },
    AlterTable {
        table: TableIdentity,
        actions: Vec<AlterAction>,
    },
    Ignored(String),
    Unknown {
        raw: String,
        reason: String,
    },
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct SpannedOp {
    pub op: MigrationOp,
    pub start: u32,
    pub end: u32,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub enum LockTier {
    Tier1,
    Tier2,
    Tier3,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct CacheEntry {
    pub estimated_rows: u64,
    pub relpages: Option<u64>,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct CacheData {
    pub last_updated: u64,
    pub tables: HashMap<String, CacheEntry>,
    pub indexes: HashMap<String, String>,
}

// FIX: Added rule_name and recipe to the output
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct LintRecord {
    pub file: String,
    pub start: u32,
    pub end: u32,
    pub tier: LockTier,
    pub op: MigrationOp,
    pub message: String,
    pub rule_name: String,
    pub recipe: String,
}