schema-sql-generator 0.6.0

A set of tools to manage relational database schemas
Documentation
use crate::common::generator_context::GeneratorContext;
use crate::common::sql_string::escape_sql_literal;
use crate::common::view_generator::ViewGenerator;
use crate::sql_println;
use schema_model::model::view::View;

pub struct SqlServerViewGenerator {
    context: GeneratorContext,
}

impl SqlServerViewGenerator {
    pub fn new(context: GeneratorContext) -> Self {
        Self { context }
    }

}

impl ViewGenerator for SqlServerViewGenerator {
    fn output_views(&self) {
        let database_model = self.context.settings().database_model();
        let database_type = self.context.settings().database_type();
        let separator = self.context.settings().statement_separator();

        let views: Vec<View> = database_model
            .schemas()
            .iter()
            .flat_map(|schema| schema.views(database_type))
            .collect();

        if !views.is_empty() {
            self.context.with_writer(|writer| {
                for view in views {
                    let view_name = view.fully_qualified_view_name(database_type);
                    sql_println!(writer, "/* {} */", view_name);
                    sql_println!(writer, "if object_id('{}', 'V') is not null", escape_sql_literal(&view_name));
                    sql_println!(writer, "   drop view {}{}", view_name, separator);
                    sql_println!(writer, "create view {} as", view_name);
                    sql_println!(writer, "   {}{}", view.sql(), separator);
                    sql_println!(writer, "");
                }
            });
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::common::test_support::make_context;
    use schema_model::builder::SchemaBuilder;
    use schema_model::model::database_model::DatabaseModel;
    use schema_model::model::types::{BooleanMode, DatabaseType, ForeignKeyMode};

    #[test]
    fn output_views_maps_public_schema_to_dbo() {
        let view = View::new(Some("public"), "active_users", "select * from users where active = 1", None);
        let schema = SchemaBuilder::new(Some("public")).add_view(view).build();
        let model = DatabaseModel::new(BooleanMode::Native, ForeignKeyMode::Relations, vec![schema]);
        let (ctx, buffer) = make_context(model, DatabaseType::SqlServer);

        let generator = SqlServerViewGenerator::new(ctx);
        generator.output_views();

        let output = buffer.contents();
        assert!(output.contains("dbo.active_users"));
        assert!(!output.contains("public.active_users"));
        assert!(output.contains("if object_id('dbo.active_users', 'V') is not null"));
        assert!(output.contains("create view dbo.active_users as"));
    }

    #[test]
    fn output_views_preserves_non_public_schema_name() {
        let view = View::new(Some("app"), "active_users", "select 1", None);
        let schema = SchemaBuilder::new(Some("app")).add_view(view).build();
        let model = DatabaseModel::new(BooleanMode::Native, ForeignKeyMode::Relations, vec![schema]);
        let (ctx, buffer) = make_context(model, DatabaseType::SqlServer);

        let generator = SqlServerViewGenerator::new(ctx);
        generator.output_views();

        assert!(buffer.contents().contains("create view app.active_users as"));
    }

    #[test]
    fn output_views_uses_dbo_when_schema_is_none() {
        let view = View::new(Option::<&str>::None, "active_users", "select 1", None);
        let schema = SchemaBuilder::new(None::<&str>).add_view(view).build();
        let model = DatabaseModel::new(BooleanMode::Native, ForeignKeyMode::Relations, vec![schema]);
        let (ctx, buffer) = make_context(model, DatabaseType::SqlServer);

        let generator = SqlServerViewGenerator::new(ctx);
        generator.output_views();

        assert!(buffer.contents().contains("create view dbo.active_users as"));
    }

    #[test]
    fn output_views_escapes_single_quote_in_view_name() {
        // Regression test: an unescaped embedded quote would break the generated
        // object_id existence-check SQL string literal.
        let view = View::new(None::<&str>, "o'brien", "select 1", None);
        let schema = SchemaBuilder::new(None::<&str>).add_view(view).build();
        let model = DatabaseModel::new(BooleanMode::Native, ForeignKeyMode::Relations, vec![schema]);
        let (ctx, buffer) = make_context(model, DatabaseType::SqlServer);

        let generator = SqlServerViewGenerator::new(ctx);
        generator.output_views();

        assert!(buffer.contents().contains("if object_id('dbo.o''brien', 'V') is not null"));
    }

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

        let generator = SqlServerViewGenerator::new(ctx);
        generator.output_views();

        assert_eq!(buffer.contents(), "");
    }
}