waypoint-core 0.4.0

Lightweight, Flyway-compatible SQL migration library for PostgreSQL and MySQL
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

//! Baseline an existing database at a specific version.

#[cfg(feature = "postgres")]
use tokio_postgres::Client;

use crate::config::WaypointConfig;
#[cfg(feature = "postgres")]
use crate::db;
use crate::db::DbClient;
use crate::error::{Result, WaypointError};
use crate::history;

/// Execute the baseline command (PostgreSQL legacy entry).
///
/// 1. Fail if history table already has entries
/// 2. Create history table
/// 3. Insert a single baseline row
#[cfg(feature = "postgres")]
pub async fn execute(
    client: &Client,
    config: &WaypointConfig,
    baseline_version: Option<&str>,
    baseline_description: Option<&str>,
) -> Result<()> {
    let table = &config.migrations.table;

    db::acquire_advisory_lock(client, table).await?;

    let result = execute_inner_pg(client, config, baseline_version, baseline_description).await;

    if let Err(e) = db::release_advisory_lock(client, table).await {
        log::error!("Failed to release advisory lock: {}", e);
    }

    result
}

#[cfg(feature = "postgres")]
async fn execute_inner_pg(
    client: &Client,
    config: &WaypointConfig,
    baseline_version: Option<&str>,
    baseline_description: Option<&str>,
) -> Result<()> {
    let schema = &config.migrations.schema;
    let table = &config.migrations.table;
    let version = baseline_version.unwrap_or(&config.migrations.baseline_version);
    let description = baseline_description.unwrap_or("<< Waypoint Baseline >>");

    history::create_history_table(client, schema, table).await?;

    if history::has_entries(client, schema, table).await? {
        return Err(WaypointError::BaselineExists);
    }

    let installed_by = config
        .migrations
        .installed_by
        .as_deref()
        .unwrap_or("waypoint");

    history::insert_applied_migration(
        client,
        schema,
        table,
        Some(version),
        description,
        "BASELINE",
        "<< Waypoint Baseline >>",
        None,
        installed_by,
        0,
        true,
    )
    .await?;

    log::info!(
        "Successfully baselined schema; version={}, schema={}",
        version,
        schema
    );
    Ok(())
}

/// Execute the baseline command (dialect-aware entry).
pub async fn execute_db(
    client: &DbClient,
    config: &WaypointConfig,
    baseline_version: Option<&str>,
    baseline_description: Option<&str>,
) -> Result<()> {
    let table = &config.migrations.table;

    client.acquire_lock(table).await?;

    let result = execute_inner_db(client, config, baseline_version, baseline_description).await;

    if let Err(e) = client.release_lock(table).await {
        log::error!("Failed to release advisory lock: {}", e);
    }

    result
}

async fn execute_inner_db(
    client: &DbClient,
    config: &WaypointConfig,
    baseline_version: Option<&str>,
    baseline_description: Option<&str>,
) -> Result<()> {
    let schema = client.resolve_schema(&config.migrations.schema).await?;
    let table = &config.migrations.table;
    let version = baseline_version.unwrap_or(&config.migrations.baseline_version);
    let description = baseline_description.unwrap_or("<< Waypoint Baseline >>");

    history::create_history_table_db(client, &schema, table).await?;

    if history::has_entries_db(client, &schema, table).await? {
        return Err(WaypointError::BaselineExists);
    }

    let installed_by = config
        .migrations
        .installed_by
        .as_deref()
        .unwrap_or("waypoint");

    history::insert_applied_migration_db(
        client,
        &schema,
        table,
        Some(version),
        description,
        "BASELINE",
        "<< Waypoint Baseline >>",
        None,
        installed_by,
        0,
        true,
    )
    .await?;

    log::info!(
        "Successfully baselined schema; version={}, schema={}",
        version,
        schema
    );
    Ok(())
}