qail 0.27.10

Schema-first database toolkit - migrations, diff, lint, and query generation
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
104
105
106
107
108
109
110

//! Types, enums, structs, and constants for the migration apply system.

use std::path::PathBuf;

/// Apply filter for phased migration execution.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum ApplyPhase {
    All,
    Expand,
    Backfill,
    Contract,
}

impl ApplyPhase {
    pub(super) fn allows(self, phase: MigrationPhase) -> bool {
        match self {
            Self::All => true,
            Self::Expand => phase == MigrationPhase::Expand,
            Self::Backfill => phase == MigrationPhase::Backfill,
            Self::Contract => phase == MigrationPhase::Contract,
        }
    }
}

impl std::fmt::Display for ApplyPhase {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::All => write!(f, "all"),
            Self::Expand => write!(f, "expand"),
            Self::Backfill => write!(f, "backfill"),
            Self::Contract => write!(f, "contract"),
        }
    }
}

/// Expand/Backfill/Contract phase for a discovered migration file.
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord)]
pub(crate) enum MigrationPhase {
    Expand = 0,
    Backfill = 1,
    Contract = 2,
}

impl std::fmt::Display for MigrationPhase {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Expand => write!(f, "expand"),
            Self::Backfill => write!(f, "backfill"),
            Self::Contract => write!(f, "contract"),
        }
    }
}

/// A discovered migration, from either flat or subdirectory layout.
#[derive(Clone)]
pub(crate) struct MigrationFile {
    /// Group key (timestamp/name without phase suffix)
    pub(crate) group_key: String,
    /// Sort key (directory/file name prefix)
    pub(crate) sort_key: String,
    /// Display name
    pub(crate) display_name: String,
    /// Full path to the .qail file
    pub(crate) path: PathBuf,
    /// Workflow phase this file belongs to
    pub(crate) phase: MigrationPhase,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(super) enum BackfillTransformOp {
    Lower,
    Upper,
    Trim,
    Initcap,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub(super) enum BackfillTransform {
    Identity,
    Lower,
    Upper,
    Trim,
    Initcap,
    Pipeline(Vec<BackfillTransformOp>),
}

#[derive(Debug, Clone)]
pub(super) struct BackfillSpec {
    pub(super) table: String,
    pub(super) pk_column: String,
    pub(super) set_column: String,
    pub(super) source_column: String,
    pub(super) transform: BackfillTransform,
    pub(super) where_null_column: Option<String>,
    pub(super) chunk_size: usize,
}

#[derive(Debug, Clone, Copy, Default)]
pub(super) struct BackfillRun {
    pub(super) resumed: bool,
    pub(super) rows_updated: i64,
    pub(super) chunks: i64,
}

/// Direction for migration
#[derive(Clone, Copy)]
pub enum MigrateDirection {
    Up,
    Down,
}