schema-sql-generator 0.6.15

A set of tools to manage relational database schemas
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
466
467
use crate::common::generator_context::GeneratorContext;
use crate::common::sql_generator::{DefaultSqlGenerator, SqlGenerator};
use crate::common::sql_string::escape_sql_literal;
use crate::postgresql::postgres_function_generator::PostgresFunctionGenerator;
use crate::postgresql::postgres_index_generator::PostgresIndexGenerator;
use crate::postgresql::postgres_other_sql_generator::PostgresOtherSqlGenerator;
use crate::postgresql::postgres_procedure_generator::PostgresProcedureGenerator;
use crate::postgresql::postgres_relation_generator::PostgresRelationGenerator;
use crate::postgresql::postgres_table_generator::PostgresTableGenerator;
use crate::postgresql::postgres_trigger_generator::PostgresTriggerGenerator;
use crate::postgresql::postgres_util::to_snake_case;
use crate::postgresql::postgres_view_generator::PostgresViewGenerator;
use crate::sql_println;

pub struct PostgresGenerator {
    context: GeneratorContext,
    sql_generator: DefaultSqlGenerator,
}

impl PostgresGenerator {
    pub fn new(context: GeneratorContext) -> Self {
        let sql_generator = DefaultSqlGenerator::new(
            context.clone(),
            Box::new(PostgresTableGenerator::new(context.clone())),
            Box::new(PostgresRelationGenerator::new(context.clone())),
            Box::new(PostgresIndexGenerator::new(context.clone())),
            Box::new(PostgresFunctionGenerator::new(context.clone())),
            Box::new(PostgresViewGenerator::new(context.clone())),
            Box::new(PostgresProcedureGenerator::new(context.clone())),
            Box::new(PostgresTriggerGenerator::new(context.clone())),
            Box::new(PostgresOtherSqlGenerator::new(context.clone())),
        );

        Self {
            context : context.clone(),
            sql_generator,
        }
    }

    fn create_uuid_generator_function(&self) {
        let separator = self.context.settings().statement_separator().to_string();

        self.context.with_writer(|writer| {
            sql_println!(writer, "create or replace function generate_uuid() returns uuid language plpgsql volatile parallel unsafe as $$");
            sql_println!(writer, "declare");
            sql_println!(writer, "   -- The current UNIX timestamp in milliseconds");
            sql_println!(writer, "   unix_time_ms CONSTANT bigint NOT NULL DEFAULT (extract(epoch FROM clock_timestamp()) * 1000)::bigint;");
            sql_println!(writer, "");
            sql_println!(writer, "   -- The buffer used to create the UUID: the low 6 bytes (48 bits) of the timestamp, followed by 10 random bytes");
            sql_println!(writer, "   buffer bytea not null default substring(int8send(unix_time_ms) from 3) || gen_random_bytes(10);");
            sql_println!(writer, "begin");
            sql_println!(writer, "   -- Set the version nibble of byte 6 to 0111 (UUID v7), keeping the last 4 bits unchanged");
            sql_println!(writer, "   buffer = set_byte(buffer, 6, (get_byte(buffer, 6) & 15) | 112);");
            sql_println!(writer, "");
            sql_println!(writer, "   -- Set the top 2 bits of byte 8 to 10 (the UUID variant specified in RFC 4122), keeping the last 6 bits unchanged");
            sql_println!(writer,
                "   buffer = set_byte(buffer, 8, (get_byte(buffer, 8) & 63) | 128);",
            );
            sql_println!(writer, "");
            sql_println!(writer, "   return encode(buffer, 'hex')::uuid;");
            sql_println!(writer, "end");
            sql_println!(writer, "$${}", separator);
            sql_println!(writer, "");
        });
    }

    fn create_extensions(&self) {
        let separator = self.context.settings().statement_separator().to_string();
        let check_user = match self.context.settings().extension_check_user() {
            Some(user) => format!("'{}'", escape_sql_literal(user)),
            None => "CURRENT_USER".to_string(),
        };
        // generate_uuid() (created below in create_uuid_generator_function, when the target
        // version is older than 18's built-in uuidv7()) calls gen_random_bytes(), which lives
        // in pgcrypto - not citext/btree_gist. Without this, the function creates fine (its
        // body isn't resolved until first call) and fails on the first insert into a Uuid
        // column with "function gen_random_bytes(integer) does not exist" (H8).
        let needs_pgcrypto = self.context.settings().target_postgres_version() < 18;

        self.context.with_writer(|writer| {
            sql_println!(writer, "do $$");
            sql_println!(writer, "begin");
            sql_println!(writer, "   if (select usesuper from pg_user where usename = {}) then", check_user);
            if needs_pgcrypto {
                sql_println!(writer, "      create extension if not exists \"pgcrypto\";");
            }
            sql_println!(writer, "      create extension if not exists \"citext\";");
            sql_println!(writer, "      create extension if not exists \"btree_gist\";");
            sql_println!(writer, "   else");
            sql_println!(writer, "      raise notice 'Could not create extensions, user % does not have permission.', current_user;");
            sql_println!(writer, "   end if;");
            sql_println!(writer, "end;");
            sql_println!(writer, "$${}", separator);
            sql_println!(writer, "");
        });
    }

    /// Emits `create schema if not exists ...` for every non-default schema the model
    /// declares, so `create table {schema}.{table}` further down doesn't fail against a
    /// schema that was never created (C4). `public` is skipped - Postgres always has it.
    fn create_schemas(&self) {
        let separator = self.context.settings().statement_separator().to_string();
        let database_model = self.context.settings().database_model();

        let mut schema_names: Vec<&str> = database_model
            .schemas()
            .iter()
            .filter_map(|schema| schema.schema_name())
            .filter(|name| !name.eq_ignore_ascii_case("public"))
            .collect();
        schema_names.sort_unstable();
        schema_names.dedup_by(|a, b| a.eq_ignore_ascii_case(b));

        if schema_names.is_empty() {
            return;
        }

        self.context.with_writer(|writer| {
            for schema_name in schema_names {
                sql_println!(writer, "create schema if not exists {}{}", schema_name, separator);
            }
            sql_println!(writer, "");
        });
    }

    fn create_enum_types(&self) {
        let separator = self.context.settings().statement_separator().to_string();
        let database_model = self.context.settings().database_model();

        for schema in database_model.schemas() {
            for enum_type in schema.enum_types() {
                let enum_type_name = to_snake_case(enum_type.name());
                let values = enum_type
                    .values()
                    .iter()
                    .map(|v| format!("'{}'", escape_sql_literal(v.code())))
                    .collect::<Vec<_>>()
                    .join(",");

                self.context.with_writer(|writer| {
                    sql_println!(writer, "drop type if exists {} cascade{}", enum_type_name, separator);
                    sql_println!(writer, "create type {} as enum ({}){}", enum_type_name, values, separator);
                    sql_println!(writer, "");
                });
            }
        }
    }
}

impl SqlGenerator for PostgresGenerator {
    fn context(&self) -> &GeneratorContext {
        &self.context
    }

    fn output_header(&self) {
        self.create_schemas();
        if self.context.settings().target_postgres_version() < 18 {
            self.create_uuid_generator_function();
        }
        if self.context.settings().emit_postgres_extensions() {
            self.create_extensions();
        }
        self.create_enum_types();
    }

    fn output_tables(&self) {
        self.sql_generator.output_tables();
    }

    fn output_relations(&self) {
        self.sql_generator.output_relations();
    }

    fn output_indexes(&self) {
        self.sql_generator.output_indexes();
    }

    fn output_triggers(&self) {
        self.sql_generator.output_triggers();
    }

    fn output_functions(&self) {
        self.sql_generator.output_functions();
    }

    fn output_views(&self) {
        self.sql_generator.output_views();
    }

    fn output_procedures(&self) {
        self.sql_generator.output_procedures();
    }

    fn output_other_sql_top(&self) {
        self.sql_generator.output_other_sql_top();
    }

    fn output_other_sql_bottom(&self) {
        self.sql_generator.output_other_sql_bottom();
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::common::generate_options::GenerateOptions;
    use crate::common::print_writer::PrintWriter;
    use crate::common::sql_generator_settings::SqlGeneratorSettings;
    use crate::common::sql_writer::SqlWriter;
    use crate::common::test_support::SharedBuffer;
    use schema_model::builder::SchemaBuilder;
    use schema_model::model::database_model::DatabaseModel;
    use schema_model::model::enum_type::{EnumType, EnumValue};
    use schema_model::model::types::{BooleanMode, DatabaseType, ForeignKeyMode};
    use std::cell::RefCell;
    use std::rc::Rc;

    fn make_context_with_version(model: DatabaseModel, target_postgres_version: u32) -> (GeneratorContext, SharedBuffer) {
        make_context(model, target_postgres_version, true)
    }

    fn make_context(model: DatabaseModel, target_postgres_version: u32, emit_postgres_extensions: bool) -> (GeneratorContext, SharedBuffer) {
        let buffer = SharedBuffer::new();
        let mut options = GenerateOptions::new(
            Rc::new(model),
            Rc::new(RefCell::new(PrintWriter::new_auto_flush(Box::new(buffer.clone())))),
        );
        options.target_postgres_version = target_postgres_version;
        options.emit_postgres_extensions = emit_postgres_extensions;
        let settings = SqlGeneratorSettings::new(DatabaseType::Postgresql, &options);
        let writer = SqlWriter::new(options.writer.clone());
        (GeneratorContext::new(settings, writer), buffer)
    }

    #[test]
    fn output_header_includes_uuid_function_before_postgres_18() {
        let schema = SchemaBuilder::new(None::<&str>).build();
        let model = DatabaseModel::new(BooleanMode::Native, ForeignKeyMode::Relations, vec![schema]);
        let (ctx, buffer) = make_context_with_version(model, 17);

        let generator = PostgresGenerator::new(ctx);
        generator.output_header();

        let output = buffer.contents();
        assert!(output.contains("create or replace function generate_uuid()"));
    }

    #[test]
    fn output_header_omits_uuid_function_on_postgres_18_and_later() {
        let schema = SchemaBuilder::new(None::<&str>).build();
        let model = DatabaseModel::new(BooleanMode::Native, ForeignKeyMode::Relations, vec![schema]);
        let (ctx, buffer) = make_context_with_version(model, 18);

        let generator = PostgresGenerator::new(ctx);
        generator.output_header();

        let output = buffer.contents();
        assert!(!output.contains("create or replace function generate_uuid()"));
    }

    #[test]
    fn output_header_renders_enum_types_when_present() {
        let enum_type = EnumType::new(
            "status_type",
            vec![
                EnumValue::new("ACTIVE", Some("A".to_string())),
                EnumValue::new("INACTIVE", Some("I".to_string())),
            ],
        );
        let schema = SchemaBuilder::new(None::<&str>).add_enum_type(enum_type).build();
        let model = DatabaseModel::new(BooleanMode::Native, ForeignKeyMode::Relations, vec![schema]);
        let (ctx, buffer) = make_context_with_version(model, 18);

        let generator = PostgresGenerator::new(ctx);
        generator.output_header();

        let output = buffer.contents();
        assert!(output.contains("create type status_type as enum ('A','I')"));
    }

    #[test]
    fn output_header_omits_enum_ddl_when_no_enums_defined() {
        let schema = SchemaBuilder::new(None::<&str>).build();
        let model = DatabaseModel::new(BooleanMode::Native, ForeignKeyMode::Relations, vec![schema]);
        let (ctx, buffer) = make_context_with_version(model, 18);

        let generator = PostgresGenerator::new(ctx);
        generator.output_header();

        let output = buffer.contents();
        assert!(!output.contains("create type"));
    }

    #[test]
    fn output_header_creates_non_default_schemas() {
        let default_schema = SchemaBuilder::new(None::<&str>).build();
        let app_schema = SchemaBuilder::new(Some("app")).build();
        let model = DatabaseModel::new(BooleanMode::Native, ForeignKeyMode::Relations, vec![default_schema, app_schema]);
        let (ctx, buffer) = make_context_with_version(model, 18);

        let generator = PostgresGenerator::new(ctx);
        generator.output_header();

        let output = buffer.contents();
        assert!(output.contains("create schema if not exists app;"));
    }

    #[test]
    fn output_header_never_creates_the_public_schema() {
        // `public` always exists in Postgres; emitting `create schema if not exists public`
        // is harmless but noisy, so it's skipped.
        let schema = SchemaBuilder::new(Some("public")).build();
        let model = DatabaseModel::new(BooleanMode::Native, ForeignKeyMode::Relations, vec![schema]);
        let (ctx, buffer) = make_context_with_version(model, 18);

        let generator = PostgresGenerator::new(ctx);
        generator.output_header();

        let output = buffer.contents();
        assert!(!output.contains("create schema"));
    }

    #[test]
    fn output_header_omits_schema_creation_when_only_default_schema_present() {
        let schema = SchemaBuilder::new(None::<&str>).build();
        let model = DatabaseModel::new(BooleanMode::Native, ForeignKeyMode::Relations, vec![schema]);
        let (ctx, buffer) = make_context_with_version(model, 18);

        let generator = PostgresGenerator::new(ctx);
        generator.output_header();

        let output = buffer.contents();
        assert!(!output.contains("create schema"));
    }

    #[test]
    fn output_header_includes_extensions_block_by_default() {
        let schema = SchemaBuilder::new(None::<&str>).build();
        let model = DatabaseModel::new(BooleanMode::Native, ForeignKeyMode::Relations, vec![schema]);
        let (ctx, buffer) = make_context_with_version(model, 18);

        let generator = PostgresGenerator::new(ctx);
        generator.output_header();

        let output = buffer.contents();
        assert!(output.contains("create extension if not exists \"citext\""));
        assert!(output.contains("create extension if not exists \"btree_gist\""));
    }

    #[test]
    fn output_header_includes_pgcrypto_before_postgres_18() {
        let schema = SchemaBuilder::new(None::<&str>).build();
        let model = DatabaseModel::new(BooleanMode::Native, ForeignKeyMode::Relations, vec![schema]);
        let (ctx, buffer) = make_context_with_version(model, 17);

        let generator = PostgresGenerator::new(ctx);
        generator.output_header();

        let output = buffer.contents();
        assert!(output.contains("create extension if not exists \"pgcrypto\""));
    }

    #[test]
    fn output_header_omits_pgcrypto_on_postgres_18_and_later() {
        let schema = SchemaBuilder::new(None::<&str>).build();
        let model = DatabaseModel::new(BooleanMode::Native, ForeignKeyMode::Relations, vec![schema]);
        let (ctx, buffer) = make_context_with_version(model, 18);

        let generator = PostgresGenerator::new(ctx);
        generator.output_header();

        let output = buffer.contents();
        assert!(!output.contains("pgcrypto"));
    }

    #[test]
    fn output_header_omits_extensions_block_when_disabled() {
        let schema = SchemaBuilder::new(None::<&str>).build();
        let model = DatabaseModel::new(BooleanMode::Native, ForeignKeyMode::Relations, vec![schema]);
        let (ctx, buffer) = make_context(model, 18, false);

        let generator = PostgresGenerator::new(ctx);
        generator.output_header();

        let output = buffer.contents();
        assert!(!output.contains("create extension"));
    }

    #[test]
    fn output_header_checks_current_user_by_default() {
        let schema = SchemaBuilder::new(None::<&str>).build();
        let model = DatabaseModel::new(BooleanMode::Native, ForeignKeyMode::Relations, vec![schema]);
        let (ctx, buffer) = make_context_with_version(model, 18);

        let generator = PostgresGenerator::new(ctx);
        generator.output_header();

        let output = buffer.contents();
        assert!(output.contains("where usename = CURRENT_USER"));
    }

    #[test]
    fn output_header_checks_configured_extension_user() {
        let schema = SchemaBuilder::new(None::<&str>).build();
        let model = DatabaseModel::new(BooleanMode::Native, ForeignKeyMode::Relations, vec![schema]);
        let buffer = SharedBuffer::new();
        let mut options = GenerateOptions::new(
            Rc::new(model),
            Rc::new(RefCell::new(PrintWriter::new_auto_flush(Box::new(buffer.clone())))),
        );
        options.target_postgres_version = 18;
        options.extension_check_user = Some("schema_admin".to_string());
        let settings = SqlGeneratorSettings::new(DatabaseType::Postgresql, &options);
        let writer = SqlWriter::new(options.writer.clone());
        let ctx = GeneratorContext::new(settings, writer);

        let generator = PostgresGenerator::new(ctx);
        generator.output_header();

        let output = buffer.contents();
        assert!(output.contains("where usename = 'schema_admin'"));
        assert!(!output.contains("CURRENT_USER)"));
    }

    #[test]
    fn output_header_escapes_single_quote_in_configured_extension_user() {
        // Regression test: an unescaped embedded quote would break the generated SQL
        // string literal (or worse, let the value's content escape it).
        let schema = SchemaBuilder::new(None::<&str>).build();
        let model = DatabaseModel::new(BooleanMode::Native, ForeignKeyMode::Relations, vec![schema]);
        let buffer = SharedBuffer::new();
        let mut options = GenerateOptions::new(
            Rc::new(model),
            Rc::new(RefCell::new(PrintWriter::new_auto_flush(Box::new(buffer.clone())))),
        );
        options.target_postgres_version = 18;
        options.extension_check_user = Some("o'brien".to_string());
        let settings = SqlGeneratorSettings::new(DatabaseType::Postgresql, &options);
        let writer = SqlWriter::new(options.writer.clone());
        let ctx = GeneratorContext::new(settings, writer);

        let generator = PostgresGenerator::new(ctx);
        generator.output_header();

        let output = buffer.contents();
        assert!(output.contains("where usename = 'o''brien'"));
    }

    #[test]
    fn output_header_escapes_single_quote_in_enum_value_code() {
        // Regression test: an unescaped embedded quote in an enum value's code would
        // break the generated `create type ... as enum (...)` statement.
        let enum_type = EnumType::new(
            "status_type",
            vec![EnumValue::new("PRIME", Some("O'Brien".to_string()))],
        );
        let schema = SchemaBuilder::new(None::<&str>).add_enum_type(enum_type).build();
        let model = DatabaseModel::new(BooleanMode::Native, ForeignKeyMode::Relations, vec![schema]);
        let (ctx, buffer) = make_context_with_version(model, 18);

        let generator = PostgresGenerator::new(ctx);
        generator.output_header();

        let output = buffer.contents();
        assert!(output.contains("create type status_type as enum ('O''Brien')"));
    }
}