Class: Mkxms::Mssql::AdoptionScriptWriter::ForeignKeyAdoptionChecks

Inherits:
IndentedStringBuilder show all
Includes:
SqlStringManipulators
Defined in:
lib/mkxms/mssql/adoption_script_writer.rb

Constant Summary

Constants included from SqlStringManipulators

SqlStringManipulators::MSSQL

Constants inherited from IndentedStringBuilder

IndentedStringBuilder::NAMED_SUBSTITUTIONS

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from SqlStringManipulators

#bit_test, #boolean_desc, #dedent, #stresc, #strlit, #unquoted_identifier

Methods inherited from IndentedStringBuilder

dsl, #dsl, #each, #indented, #puts, #to_s

Constructor Details

#initialize(keys, error_sql_proc) ⇒ ForeignKeyAdoptionChecks

Returns a new instance of ForeignKeyAdoptionChecks.



671
672
673
674
675
676
677
678
679
680
 
# File 'lib/mkxms/mssql/adoption_script_writer.rb', line 671

def initialize(keys, error_sql_proc)
  super()
  
  @error_sql_proc = error_sql_proc
  @named_keys = keys.reject {|k| k.unnamed?}
  @unnamed_keys = keys.select {|k| k.unnamed?}
  
  add_named_key_tests
  add_unnamed_key_tests
end

Instance Attribute Details

#named_keys ⇒ Object (readonly)

Returns the value of attribute named_keys.



682
683
684
 
# File 'lib/mkxms/mssql/adoption_script_writer.rb', line 682

def named_keys
  @named_keys
end

#unnamed_keys ⇒ Object (readonly)

Returns the value of attribute unnamed_keys.



682
683
684
 
# File 'lib/mkxms/mssql/adoption_script_writer.rb', line 682

def unnamed_keys
  @unnamed_keys
end

Instance Method Details

#add_named_key_tests ⇒ Object 



688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
 
# File 'lib/mkxms/mssql/adoption_script_writer.rb', line 688

def add_named_key_tests
  table = 'expected_named_foreign_keys'
  dsl {
    # Create a temporary table
    puts dedent %Q{
      CREATE TABLE [xmigra].[#{table}] (
        [name] NVARCHAR(150) NOT NULL,
        [position] INTEGER NOT NULL,
        [from_table] NVARCHAR(300) NOT NULL,
        [from_column] NVARCHAR(150) NOT NULL,
        [to_table] NVARCHAR(300) NOT NULL,
        [to_column] NVARCHAR(150) NOT NULL
      );
      GO
    }
    
    # Insert a record for each column linkage for each named foreign key
    named_keys.each do |fkey|
      fkey.links.each.with_index do |cols, i|
        values = [
          strlit(fkey.name),
          i + 1,
          strlit(fkey.qualified_table),
          strlit(cols[0]),
          strlit(fkey.references.join '.'),
          strlit(cols[1])
        ]
        puts dedent(%Q{
          INSERT INTO [xmigra].[#{table}] (name, position, from_table, from_column, to_table, to_column)
          VALUES (%s);
        } % [values.join(', ')])
      end
    end
    
    # Write an adoption error for each missing/misdefined foreign key
    puts dedent %Q{
      WITH
        MissingLinks AS (
          SELECT
            [name],
            [position],
            [from_table],
            [from_column],
            [to_table],
            [to_column]
          FROM [xmigra].[#{table}]
          EXCEPT
          SELECT
            QUOTENAME(fk.name) AS name,
            RANK() OVER(PARTITION BY fk.object_id ORDER BY fkc.constraint_column_id ASC) AS position,
            QUOTENAME(s.name) + N'.' + QUOTENAME(t.name) AS from_table,
            QUOTENAME(from_col.name) AS from_col,
            QUOTENAME(rs.name) + N'.' + QUOTENAME(r.name) AS to_table,
            QUOTENAME(to_col.name) AS to_col
          FROM sys.foreign_keys fk
          JOIN sys.tables t ON fk.parent_object_id = t.object_id
          JOIN sys.schemas s ON t.schema_id = s.schema_id
          JOIN sys.objects r ON fk.referenced_object_id = r.object_id
          JOIN sys.schemas rs ON r.schema_id = rs.schema_id
          JOIN sys.foreign_key_columns fkc ON fk.object_id = fkc.constraint_object_id
          JOIN sys.columns from_col
            ON fk.parent_object_id = from_col.object_id
            AND fkc.parent_column_id = from_col.column_id
          JOIN sys.columns to_col
            ON fk.referenced_object_id = to_col.object_id
            AND fkc.referenced_column_id = to_col.column_id
        )
      INSERT INTO [xmigra].[adoption_errors] ([message])
      SELECT DISTINCT
        N'Constraint ' + ml.[name] + N' on ' + ml.[from_table] + N' (referencing' + ml.[to_table] + N') does not have the expected definition.'
      FROM MissingLinks ml;
      GO
    }
    
    # Drop the temporary table
    puts "DROP TABLE [xmigra].[#{table}];\nGO"
  }
end

#add_unnamed_key_tests ⇒ Object 



767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
 
# File 'lib/mkxms/mssql/adoption_script_writer.rb', line 767

def add_unnamed_key_tests
  table = 'expected_unnamed_foreign_keys'
  dsl {
    # Create a temporary table
    puts dedent %Q{
      CREATE TABLE [xmigra].[#{table}] (
        [position] INTEGER NOT NULL,
        [from_table] NVARCHAR(300) NOT NULL,
        [from_column] NVARCHAR(150) NOT NULL,
        [to_table] NVARCHAR(300) NOT NULL,
        [to_column] NVARCHAR(150) NOT NULL
      );
      GO
    }
    
    # Insert a record for each column linkage for each unnamed foreign key
    unnamed_keys.each do |fkey|
      fkey.links.each.with_index do |cols, i|
        values = [
          i + 1,
          strlit(fkey.qualified_table),
          strlit(cols[0]),
          strlit(fkey.references.join '.'),
          strlit(cols[1])
        ]
        puts dedent(%Q{
          INSERT INTO [xmigra].[#{table}] (position, from_table, from_column, to_table, to_column)
          VALUES (%s);
        } % [values.join(', ')])
      end
    end
    
    # Write an adoption error for each missing/misdefined key
    puts dedent %Q{
      WITH
        MissingLinks AS (
          SELECT
            [position],
            [from_table],
            [from_column],
            [to_table],
            [to_column]
          FROM [xmigra].[#{table}]
          EXCEPT
          SELECT
            RANK() OVER(PARTITION BY fk.object_id ORDER BY fkc.constraint_column_id ASC) AS position,
            QUOTENAME(s.name) + N'.' + QUOTENAME(t.name) AS from_table,
            QUOTENAME(from_col.name) AS from_col,
            QUOTENAME(rs.name) + N'.' + QUOTENAME(r.name) AS to_table,
            QUOTENAME(to_col.name) AS to_col
          FROM sys.foreign_keys fk
          JOIN sys.tables t ON fk.parent_object_id = t.object_id
          JOIN sys.schemas s ON t.schema_id = s.schema_id
          JOIN sys.objects r ON fk.referenced_object_id = r.object_id
          JOIN sys.schemas rs ON r.schema_id = rs.schema_id
          JOIN sys.foreign_key_columns fkc ON fk.object_id = fkc.constraint_object_id
          JOIN sys.columns from_col
            ON fk.parent_object_id = from_col.object_id
            AND fkc.parent_column_id = from_col.column_id
          JOIN sys.columns to_col
            ON fk.referenced_object_id = to_col.object_id
            AND fkc.referenced_column_id = to_col.column_id
        )
      INSERT INTO [xmigra].[adoption_errors] ([message])
      SELECT DISTINCT
        N'Expected constraint on ' + ml.[from_table] + N' (referencing ' + ml.[to_table] + N') not found.'
      FROM MissingLinks ml;
      GO
    }
    
    # Drop the temporary table
    puts "DROP TABLE [xmigra].[#{table}];\nGO"
  }
end

#error_sql(s) ⇒ Object 



684
685
686
 
# File 'lib/mkxms/mssql/adoption_script_writer.rb', line 684

def error_sql(s)
  @error_sql_proc.call(s)
end