migratrom 0.2.0

Declarative, self-verifying database migrations (core engine).
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
//! The SQL-generation seam.
//!
//! [`SqlDialect`] abstracts every database-specific string the engine emits.
//! Shared quoting/column rendering is provided as default methods; existence
//! probes, index/history DDL, and locking are implemented per dialect.
//! Both [`PostgresDialect`] and [`SqliteDialect`] live in the core crate.

use async_trait::async_trait;

use super::{catalog, columns, identifiers};
use crate::db::Db;
use crate::error::Result;
use crate::types::{ColumnDef, DialectCapabilities};

#[async_trait]
/// Database-specific SQL generator used by migration builders and the runner.
///
/// Applications normally use [`PostgresDialect`] or [`SqliteDialect`]. Implement
/// this trait only to integrate a database engine without a built-in dialect.
pub trait SqlDialect: Send + Sync {
    /// Return the stable human-readable dialect name used in errors.
    fn name(&self) -> &str;
    /// Return the features this dialect can express.
    fn capabilities(&self) -> DialectCapabilities;

    // --- Shared quoting / rendering (identical across dialects) ---
    /// Quote an SQL identifier.
    fn quote_ident(&self, name: &str) -> String {
        identifiers::quote_ident(name)
    }
    /// Quote an SQL string literal.
    fn quote_literal(&self, value: &str) -> String {
        identifiers::quote_literal(value)
    }
    /// Render a schema-qualified relation name.
    fn qualified(&self, schema: &str, name: &str) -> String {
        identifiers::qualified(schema, name)
    }
    /// Render a comma-separated, quoted identifier list.
    fn quote_ident_list(&self, names: &[String]) -> String {
        identifiers::quote_ident_list(names)
    }
    /// Render one column definition for a table or add-column statement.
    fn render_column_def(&self, column: &ColumnDef) -> String {
        columns::render_column_def(column)
    }
    /// Render a comma-separated list of column definitions.
    fn render_column_list(&self, columns: &[ColumnDef]) -> String {
        columns::render_column_list(columns)
    }

    // --- Per-dialect SQL ---
    /// Generate `CREATE INDEX` SQL for the supplied relation and columns.
    fn create_index_sql(
        &self,
        schema: &str,
        table: &str,
        index_name: &str,
        columns: &[String],
        concurrently: bool,
    ) -> String;

    /// Generate a boolean probe for a table, index, or equivalent relation.
    fn table_exists_sql(&self, schema: &str, table: &str, negate: bool) -> String;
    /// Generate a boolean probe for a column.
    fn column_exists_sql(&self, schema: &str, table: &str, column: &str, negate: bool) -> String;
    /// Generate a boolean probe for a named constraint.
    fn constraint_exists_sql(&self, schema: &str, table: &str, name: &str, negate: bool) -> String;
    /// Generate a boolean probe for a table primary key.
    fn primary_key_exists_sql(&self, schema: &str, table: &str, negate: bool) -> String;
    /// Generate a boolean probe for a named check constraint.
    fn check_constraint_exists_sql(
        &self,
        schema: &str,
        table: &str,
        name: &str,
        negate: bool,
    ) -> String;
    /// Generate a boolean probe for a schema.
    fn schema_exists_sql(&self, schema: &str, negate: bool) -> String;
    /// Generate a boolean probe for an installed extension.
    fn extension_exists_sql(&self, name: &str, negate: bool) -> String;
    /// Generate a boolean probe for an enum type.
    fn enum_type_exists_sql(&self, schema: &str, name: &str, negate: bool) -> String;
    /// Generate a boolean probe for an enum label.
    fn enum_label_exists_sql(
        &self,
        schema: &str,
        type_name: &str,
        value: &str,
        negate: bool,
    ) -> String;
    /// Generate a boolean probe for a regular view.
    fn view_exists_sql(&self, schema: &str, name: &str, negate: bool) -> String;
    /// Generate a boolean probe for a materialized view.
    fn matview_exists_sql(&self, schema: &str, name: &str, negate: bool) -> String;
    /// Generate a boolean probe for whether a column has a default.
    fn column_default_set_sql(
        &self,
        schema: &str,
        table: &str,
        column: &str,
        negate: bool,
    ) -> String;
    /// Generate a boolean probe for whether a column is `NOT NULL`.
    fn column_not_null_sql(&self, schema: &str, table: &str, column: &str, negate: bool) -> String;

    /// Generate SQL that creates the migration history table.
    fn create_history_table_sql(&self, name: &str) -> String;

    /// Acquire the dialect's migration lock using `db`.
    async fn acquire_lock(&self, db: &dyn Db, key: i64) -> Result<()>;
    /// Release the dialect's migration lock using `db`.
    async fn release_lock(&self, db: &dyn Db, key: i64) -> Result<()>;
}

const POSTGRES_CAPABILITIES: DialectCapabilities = DialectCapabilities {
    enum_types: true,
    sequences: true,
    materialized_views: true,
    extensions: true,
    concurrent_indexes: true,
    schemas: true,
    advisory_locks: true,
    add_check_constraints: true,
    add_primary_key_constraints: true,
    add_unique_constraints: true,
    add_foreign_keys: true,
    alter_column_default: true,
    alter_column_not_null: true,
};

const SQLITE_CAPABILITIES: DialectCapabilities = DialectCapabilities {
    enum_types: false,
    sequences: false,
    materialized_views: false,
    extensions: false,
    concurrent_indexes: false,
    schemas: false,
    advisory_locks: false,
    add_check_constraints: false,
    add_primary_key_constraints: false,
    add_unique_constraints: false,
    add_foreign_keys: false,
    alter_column_default: false,
    alter_column_not_null: false,
};

/// PostgreSQL dialect: full feature set, catalog-backed existence probes,
/// advisory locking.
#[derive(Clone, Copy, Debug, Default)]
pub struct PostgresDialect;

#[async_trait]
impl SqlDialect for PostgresDialect {
    fn name(&self) -> &str {
        "postgres"
    }
    fn capabilities(&self) -> DialectCapabilities {
        POSTGRES_CAPABILITIES
    }

    fn create_index_sql(
        &self,
        schema: &str,
        table: &str,
        index_name: &str,
        columns: &[String],
        concurrently: bool,
    ) -> String {
        let concurrently_sql = if concurrently { " CONCURRENTLY" } else { "" };
        format!(
            "CREATE INDEX{} {} ON {} ({})",
            concurrently_sql,
            self.quote_ident(index_name),
            self.qualified(schema, table),
            self.quote_ident_list(columns)
        )
    }

    fn table_exists_sql(&self, schema: &str, table: &str, negate: bool) -> String {
        catalog::regclass_exists_sql(schema, table, negate)
    }
    fn column_exists_sql(&self, schema: &str, table: &str, column: &str, negate: bool) -> String {
        catalog::column_exists_sql(schema, table, column, negate)
    }
    fn constraint_exists_sql(&self, schema: &str, table: &str, name: &str, negate: bool) -> String {
        catalog::constraint_exists_sql(schema, table, name, negate)
    }
    fn primary_key_exists_sql(&self, schema: &str, table: &str, negate: bool) -> String {
        catalog::primary_key_exists_sql(schema, table, negate)
    }
    fn check_constraint_exists_sql(
        &self,
        schema: &str,
        table: &str,
        name: &str,
        negate: bool,
    ) -> String {
        catalog::check_constraint_exists_sql(schema, table, name, negate)
    }
    fn schema_exists_sql(&self, schema: &str, negate: bool) -> String {
        catalog::schema_exists_sql(schema, negate)
    }
    fn extension_exists_sql(&self, name: &str, negate: bool) -> String {
        catalog::extension_exists_sql(name, negate)
    }
    fn enum_type_exists_sql(&self, schema: &str, name: &str, negate: bool) -> String {
        catalog::enum_type_exists_sql(schema, name, negate)
    }
    fn enum_label_exists_sql(
        &self,
        schema: &str,
        type_name: &str,
        value: &str,
        negate: bool,
    ) -> String {
        catalog::enum_label_exists_sql(schema, type_name, value, negate)
    }
    fn view_exists_sql(&self, schema: &str, name: &str, negate: bool) -> String {
        catalog::view_exists_sql(schema, name, negate)
    }
    fn matview_exists_sql(&self, schema: &str, name: &str, negate: bool) -> String {
        catalog::matview_exists_sql(schema, name, negate)
    }
    fn column_default_set_sql(
        &self,
        schema: &str,
        table: &str,
        column: &str,
        negate: bool,
    ) -> String {
        catalog::column_default_set_sql(schema, table, column, negate)
    }
    fn column_not_null_sql(&self, schema: &str, table: &str, column: &str, negate: bool) -> String {
        catalog::column_not_null_sql(schema, table, column, negate)
    }

    fn create_history_table_sql(&self, name: &str) -> String {
        format!(
            "CREATE TABLE IF NOT EXISTS {} (
        id          bigint PRIMARY KEY,
        parent_id   bigint,
        applied_at  timestamptz NOT NULL DEFAULT now(),
        operations  text NOT NULL,
        checksum    text NOT NULL
      )",
            self.quote_ident(name)
        )
    }

    async fn acquire_lock(&self, db: &dyn Db, key: i64) -> Result<()> {
        db.execute(&format!("SELECT pg_advisory_lock({key})")).await
    }
    async fn release_lock(&self, db: &dyn Db, key: i64) -> Result<()> {
        db.execute(&format!("SELECT pg_advisory_unlock({key})"))
            .await
    }
}

/// SQLite dialect: pragma/`sqlite_master`-backed probes, no advanced features,
/// no advisory locks.
#[derive(Clone, Copy, Debug, Default)]
pub struct SqliteDialect;

/// SQLite returns 0/1 for unsupported probes so checks stay well-formed.
fn unsupported_probe(negate: bool) -> String {
    if negate {
        "SELECT 1".to_string()
    } else {
        "SELECT 0".to_string()
    }
}

fn exists_select(exists: &str, negate: bool) -> String {
    if negate {
        format!("SELECT NOT {exists}")
    } else {
        format!("SELECT {exists}")
    }
}

#[async_trait]
impl SqlDialect for SqliteDialect {
    fn name(&self) -> &str {
        "sqlite"
    }
    fn capabilities(&self) -> DialectCapabilities {
        SQLITE_CAPABILITIES
    }

    fn create_index_sql(
        &self,
        schema: &str,
        table: &str,
        index_name: &str,
        columns: &[String],
        _concurrently: bool,
    ) -> String {
        format!(
            "CREATE INDEX {} ON {} ({})",
            self.qualified(schema, index_name),
            self.quote_ident(table),
            self.quote_ident_list(columns)
        )
    }

    fn table_exists_sql(&self, schema: &str, table: &str, negate: bool) -> String {
        let exists = format!(
            "EXISTS (
    SELECT 1 FROM {}.sqlite_master
    WHERE name = {}
      AND type IN ('table', 'index', 'view')
  )",
            self.quote_ident(schema),
            self.quote_literal(table)
        );
        exists_select(&exists, negate)
    }

    fn column_exists_sql(&self, _schema: &str, table: &str, column: &str, negate: bool) -> String {
        let exists = format!(
            "EXISTS (
    SELECT 1 FROM pragma_table_info({})
    WHERE name = {}
  )",
            self.quote_literal(table),
            self.quote_literal(column)
        );
        exists_select(&exists, negate)
    }

    fn constraint_exists_sql(
        &self,
        _schema: &str,
        _table: &str,
        _name: &str,
        negate: bool,
    ) -> String {
        unsupported_probe(negate)
    }

    fn primary_key_exists_sql(&self, _schema: &str, table: &str, negate: bool) -> String {
        let exists = format!(
            "EXISTS (
    SELECT 1 FROM pragma_table_info({})
    WHERE pk > 0
  )",
            self.quote_literal(table)
        );
        exists_select(&exists, negate)
    }

    fn check_constraint_exists_sql(
        &self,
        _schema: &str,
        _table: &str,
        _name: &str,
        negate: bool,
    ) -> String {
        unsupported_probe(negate)
    }

    fn schema_exists_sql(&self, schema: &str, negate: bool) -> String {
        let exists = format!(
            "EXISTS (
    SELECT 1 FROM pragma_database_list
    WHERE name = {}
  )",
            self.quote_literal(schema)
        );
        exists_select(&exists, negate)
    }

    fn extension_exists_sql(&self, _name: &str, negate: bool) -> String {
        unsupported_probe(negate)
    }
    fn enum_type_exists_sql(&self, _schema: &str, _name: &str, negate: bool) -> String {
        unsupported_probe(negate)
    }
    fn enum_label_exists_sql(
        &self,
        _schema: &str,
        _type_name: &str,
        _value: &str,
        negate: bool,
    ) -> String {
        unsupported_probe(negate)
    }

    fn view_exists_sql(&self, schema: &str, name: &str, negate: bool) -> String {
        let exists = format!(
            "EXISTS (
    SELECT 1 FROM {}.sqlite_master
    WHERE name = {}
      AND type = 'view'
  )",
            self.quote_ident(schema),
            self.quote_literal(name)
        );
        exists_select(&exists, negate)
    }

    fn matview_exists_sql(&self, _schema: &str, _name: &str, negate: bool) -> String {
        unsupported_probe(negate)
    }

    fn column_default_set_sql(
        &self,
        _schema: &str,
        table: &str,
        column: &str,
        negate: bool,
    ) -> String {
        let exists = format!(
            "EXISTS (
    SELECT 1 FROM pragma_table_info({})
    WHERE name = {}
      AND dflt_value IS NOT NULL
  )",
            self.quote_literal(table),
            self.quote_literal(column)
        );
        exists_select(&exists, negate)
    }

    fn column_not_null_sql(
        &self,
        _schema: &str,
        table: &str,
        column: &str,
        negate: bool,
    ) -> String {
        let exists = format!(
            "EXISTS (
    SELECT 1 FROM pragma_table_info({})
    WHERE name = {}
      AND \"notnull\" = 1
  )",
            self.quote_literal(table),
            self.quote_literal(column)
        );
        exists_select(&exists, negate)
    }

    fn create_history_table_sql(&self, name: &str) -> String {
        format!(
            "CREATE TABLE IF NOT EXISTS {} (
        id          INTEGER PRIMARY KEY,
        parent_id   INTEGER,
        applied_at  TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
        operations  TEXT NOT NULL,
        checksum    TEXT NOT NULL
      )",
            self.quote_ident(name)
        )
    }

    async fn acquire_lock(&self, _db: &dyn Db, _key: i64) -> Result<()> {
        Ok(())
    }
    async fn release_lock(&self, _db: &dyn Db, _key: i64) -> Result<()> {
        Ok(())
    }
}