pgdo-cli 0.5.6

The convenience of SQLite – but with PostgreSQL (Command-line application)
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

use std::path::PathBuf;

use clap::Args;

use pgdo::cluster::DATABASE_POSTGRES;
use pgdo::runtime::constraint::Constraint;

#[derive(Args, Debug, Default)]
pub struct ClusterArgs {
    /// The directory in which the cluster lives.
    #[clap(
        short = 'D',
        long = "datadir",
        env = "PGDATA",
        value_name = "PGDATA",
        default_value = "cluster",
        display_order = 1
    )]
    pub dir: PathBuf,
}

#[derive(Args, Debug, Default)]
pub struct ClusterModeArgs {
    /// Run the cluster in a "safer" or "faster" mode.
    ///
    /// DANGER! Choosing "faster-but-less-safe" makes the cluster faster but it
    /// can lead to unrecoverable data corruption in the event of a power
    /// failure or system crash.
    ///
    /// The mode is STICKY. Running with a mode reconfigures the cluster, and it
    /// will continue to run in that mode. To find out which mode the cluster is
    /// configured for, open a `psql` shell (e.g. `pgdo shell`) and run `SHOW
    /// fsync; SHOW full_page_writes; SHOW synchronous_commit;`.
    #[clap(long = "mode", display_order = 4)]
    pub mode: Option<ClusterMode>,
}

#[derive(Args, Debug, Default)]
pub struct DatabaseArgs {
    /// The database to connect to.
    #[clap(
        short = 'd',
        long = "database",
        env = "PGDATABASE",
        value_name = "PGDATABASE",
        default_value = DATABASE_POSTGRES,
        display_order = 2
    )]
    pub name: String,
}

#[derive(Args, Debug, Default)]
pub struct RuntimeArgs {
    /// Select the default runtime, used when creating new clusters.
    #[clap(
        long = "runtime-default",
        value_name = "CONSTRAINT",
        display_order = 80
    )]
    pub fallback: Option<Constraint>,
}

#[derive(Args, Debug, Default)]
pub struct LifecycleArgs {
    /// Destroy the cluster after use. WARNING: This will DELETE THE DATA
    /// DIRECTORY. The default is to NOT destroy the cluster.
    #[clap(long = "destroy", display_order = 100)]
    pub destroy: bool,
}

// ----------------------------------------------------------------------------

#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, clap::ValueEnum)]
pub enum ClusterMode {
    /// Resets fsync, full_page_writes, and synchronous_commit to defaults.
    #[value(name = "slower-but-safer", alias = "safe")]
    Slow,

    /// Disable fsync, full_page_writes, and synchronous_commit. DANGER!
    #[value(name = "faster-but-less-safe", alias = "fast")]
    Fast,
}

#[cfg(test)]
mod tests {
    use super::ClusterModeArgs;

    #[test]
    fn test_cluster_mode_args_default() {
        let default = ClusterModeArgs::default();
        assert_eq!(default.mode, None);
    }
}