Schema reflection now finds primary key for all occasions. Fixed #60 [Boško Ivanišević]

Author: metaskills

CHANGELOG

@@ -1,6 +1,8 @@
 
 * 3.1.0 *
 
+* Schema reflection now finds primary key for all occasions. Fixed #60 [Boško Ivanišević]
+
 * Allow complex order objects to not be molested by our visitor overrides. Fixes #99
 
 * Default unicode datatypes!

lib/active_record/connection_adapters/sqlserver/schema_statements.rb

@@ -7,15 +7,20 @@ def native_database_types
           @native_database_types ||= initialize_native_database_types.freeze
         end
 
-        def tables(name = nil)
+        def tables(name = nil, schema = nil)
           info_schema_query do
-            select_values "SELECT #{lowercase_schema_reflection_sql('TABLE_NAME')} FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_TYPE = 'BASE TABLE' AND TABLE_NAME <> 'dtproperties' AND TABLE_SCHEMA = schema_name()"
+            select_values "SELECT #{lowercase_schema_reflection_sql('TABLE_NAME')} FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_TYPE = 'BASE TABLE' AND TABLE_NAME <> 'dtproperties' AND TABLE_SCHEMA = #{schema.blank? ? "schema_name()" : "#{quote(schema)}"}"
           end
         end
+        
+        def tables_in_schema(table_schema)
+          table_schema.blank? ? [] : tables(nil,table_schema)
+        end
 
         def table_exists?(table_name)
+          table_schema = unqualify_table_schema(table_name)
           unquoted_table_name = unqualify_table_name(table_name)
-          super || tables.include?(unquoted_table_name) || views.include?(unquoted_table_name)
+          super || tables.include?(unquoted_table_name) || views.include?(unquoted_table_name) || tables_in_schema(table_schema).include?(unquoted_table_name)
         end
 
         def indexes(table_name, name = nil)
@@ -150,36 +155,41 @@ def initialize_native_database_types
             :ss_timestamp => { :name => 'timestamp' }
           }
         end
-        
+
         def column_definitions(table_name)
           db_name = unqualify_db_name(table_name)
           db_name_with_period = "#{db_name}." if db_name
           table_schema = unqualify_table_schema(table_name)
           table_name = unqualify_table_name(table_name)
           sql = %{
-            SELECT
+            SELECT DISTINCT 
             #{lowercase_schema_reflection_sql('columns.TABLE_NAME')} AS table_name,
             #{lowercase_schema_reflection_sql('columns.COLUMN_NAME')} AS name,
             columns.DATA_TYPE AS type,
             columns.COLUMN_DEFAULT AS default_value,
             columns.NUMERIC_SCALE AS numeric_scale,
             columns.NUMERIC_PRECISION AS numeric_precision,
+            columns.ordinal_position,
             CASE
               WHEN columns.DATA_TYPE IN ('nchar','nvarchar') THEN columns.CHARACTER_MAXIMUM_LENGTH
               ELSE COL_LENGTH(columns.TABLE_SCHEMA+'.'+columns.TABLE_NAME, columns.COLUMN_NAME)
-            END AS length,
+            END AS [length],
             CASE
               WHEN columns.IS_NULLABLE = 'YES' THEN 1
               ELSE NULL
-            END AS is_nullable,
-            CASE
-              WHEN COLUMNPROPERTY(OBJECT_ID(columns.TABLE_SCHEMA+'.'+columns.TABLE_NAME), columns.COLUMN_NAME, 'IsIdentity') = 0 THEN NULL
-              ELSE 1
-            END AS is_identity
+            END AS [is_nullable],
+            CASE 
+              WHEN CCU.COLUMN_NAME IS NOT NULL AND TC.CONSTRAINT_TYPE = N'PRIMARY KEY' THEN 1
+              WHEN COLUMNPROPERTY(OBJECT_ID(columns.TABLE_SCHEMA+'.'+columns.TABLE_NAME), columns.COLUMN_NAME, 'IsIdentity') = 1 THEN 1
+              ELSE NULL
+            END AS [is_identity]
             FROM #{db_name_with_period}INFORMATION_SCHEMA.COLUMNS columns
+            LEFT OUTER JOIN #{db_name_with_period}INFORMATION_SCHEMA.TABLE_CONSTRAINTS AS TC ON TC.TABLE_NAME = columns.TABLE_NAME AND TC.CONSTRAINT_TYPE = N'PRIMARY KEY' 
+            LEFT OUTER JOIN #{db_name_with_period}INFORMATION_SCHEMA.CONSTRAINT_COLUMN_USAGE AS CCU ON TC.CONSTRAINT_NAME = CCU.CONSTRAINT_NAME AND CCU.COLUMN_NAME = columns.COLUMN_NAME
             WHERE columns.TABLE_NAME = @0
               AND columns.TABLE_SCHEMA = #{table_schema.blank? ? "schema_name()" : "@1"}
             ORDER BY columns.ordinal_position
+            
           }.gsub(/[ \t\r\n]+/,' ')
           binds = [['table_name', table_name]]
           binds << ['table_schema',table_schema] unless table_schema.blank?
@@ -213,6 +223,7 @@ def column_definitions(table_name)
                                    match_data ? match_data[1] : nil
                                  end
             ci[:null] = ci[:is_nullable].to_i == 1 ; ci.delete(:is_nullable)
+            ci[:is_identity] = ci[:is_identity].to_i == 1
             ci
           end
         end
@@ -361,7 +372,7 @@ def set_identity_insert(table_name, enable = true)
         end
 
         def identity_column(table_name)
-          columns(table_name).detect(&:is_identity?)
+          columns(table_name).detect(&:primary) || columns(table_name).detect(&:is_identity?)
         end
 
       end

lib/active_record/connection_adapters/sqlserver_adapter.rb

@@ -55,6 +55,7 @@ class SQLServerColumn < Column
       def initialize(name, default, sql_type = nil, null = true, sqlserver_options = {})
         @sqlserver_options = sqlserver_options.symbolize_keys
         super(name, default, sql_type, null)
+        @primary = @sqlserver_options[:is_identity]
       end
 
       class << self

test/cases/adapter_test_sqlserver.rb

@@ -540,7 +540,6 @@ def setup
 
         should 'find identity column' do
           assert CustomersView.columns_hash['id'].primary
-          assert CustomersView.columns_hash['id'].is_identity?
         end
 
         should 'find default values' do
@@ -573,7 +572,6 @@ def setup
 
         should 'find identity column' do
           assert StringDefaultsView.columns_hash['id'].primary
-          assert StringDefaultsView.columns_hash['id'].is_identity?
         end
 
         should 'find default values' do

test/cases/schema_test_sqlserver.rb

@@ -10,12 +10,31 @@ def read_schema_name(table_name)
     @connection.instance_eval { unqualify_table_schema(table_name) }
   end  
 
+  context 'When table is dbo schema' do
+  
+    should 'find primary key for tables with odd schema' do
+      assert_equal 'legacy_id', @connection.primary_key('natural_pk_data')
+      assert SqlServerNaturalPkData.columns_hash['legacy_id'].primary
+    end
+  
+  end
+  
   context 'When table is in non-dbo schema' do
 
+    should 'work with #table_exists?' do
+      assert @connection.tables_in_schema('test').include?('sql_server_schema_natural_id')
+      assert @connection.table_exists?('test.sql_server_schema_natural_id')
+    end
+    
+    should 'find primary key for tables with odd schema' do
+      assert_equal 'legacy_id', @connection.primary_key('test.sql_server_schema_natural_id')
+      assert SqlServerNaturalPkDataSchema.columns_hash['legacy_id'].primary
+    end
+    
     should "have only one identity column" do
       columns = @connection.columns("test.sql_server_schema_identity")
       assert_equal 2, columns.size 
-      assert_equal 1, columns.select{|column| column.is_identity? }.size
+      assert_equal 1, columns.select{ |c| c.primary }.size
     end                                   
 
     should "read only column properties for table in specific schema" do
@@ -25,9 +44,9 @@ def read_schema_name(table_name)
       assert_equal 7, test_columns.size    
       assert_equal 2, dbo_columns.size
       assert_equal 2, columns.size
-      assert_equal 1, test_columns.select{|column| column.is_identity? }.size             
-      assert_equal 1, dbo_columns.select{|column| column.is_identity? }.size             
-      assert_equal 1, columns.select{|column| column.is_identity? }.size                 
+      assert_equal 1, test_columns.select{ |c| c.primary }.size
+      assert_equal 1, dbo_columns.select{ |c| c.primary }.size
+      assert_equal 1, columns.select{ |c| c.primary }.size
     end  
 
     should "return schema name in all cases" do                                 
@@ -47,6 +66,7 @@ def read_schema_name(table_name)
     end
 
   end
-          
+  
+  
 end
 

test/cases/sqlserver_helper.rb

@@ -35,6 +35,8 @@ class NumericData < ActiveRecord::Base ; self.table_name = 'numeric_data' ; end
 class CustomersView < ActiveRecord::Base ; self.table_name = 'customers_view' ; end
 class StringDefaultsView < ActiveRecord::Base ; self.table_name = 'string_defaults_view' ; end
 class StringDefaultsBigView < ActiveRecord::Base ; self.table_name = 'string_defaults_big_view' ; end
+class SqlServerNaturalPkData < ActiveRecord::Base ; self.table_name = 'natural_pk_data' ; end
+class SqlServerNaturalPkDataSchema < ActiveRecord::Base ; self.table_name = 'test.sql_server_schema_natural_id' ; end
 class SqlServerQuotedTable < ActiveRecord::Base ; self.table_name = 'quoted-table' ; end
 class SqlServerQuotedView1 < ActiveRecord::Base ; self.table_name = 'quoted-view1' ; end
 class SqlServerQuotedView2 < ActiveRecord::Base ; self.table_name = 'quoted-view2' ; end

test/schema/sqlserver_specific_schema.rb

@@ -71,13 +71,22 @@
     t.column :tinyint, :tinyint
     t.column :guid, :uniqueidentifier
   end
+  execute %|ALTER TABLE [sql_server_edge_schemas] ADD [guid_newid] uniqueidentifier DEFAULT NEWID();|
+  execute %|ALTER TABLE [sql_server_edge_schemas] ADD [guid_newseqid] uniqueidentifier DEFAULT NEWSEQUENTIALID();| unless sqlserver_azure?
 
   create_table :no_pk_data, :force => true, :id => false do |t|
     t.string :name
   end
 
-  execute %|ALTER TABLE [sql_server_edge_schemas] ADD [guid_newid] uniqueidentifier DEFAULT NEWID();|
-  execute %|ALTER TABLE [sql_server_edge_schemas] ADD [guid_newseqid] uniqueidentifier DEFAULT NEWSEQUENTIALID();| unless sqlserver_azure?
+  execute "IF EXISTS(SELECT * FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_NAME = 'natural_pk_data') DROP TABLE natural_pk_data"
+  execute <<-NATURALPKTABLESQL
+    CREATE TABLE natural_pk_data(
+    	parent_id int,
+    	name nvarchar(255),
+    	description nvarchar(1000),
+    	legacy_id nvarchar(10) NOT NULL PRIMARY KEY,
+    )
+  NATURALPKTABLESQL
 
   create_table 'quoted-table', :force => true do |t|
   end
@@ -110,9 +119,11 @@
 
 
   # Another schema.
+  
   create_table :sql_server_schema_columns, :force => true do |t|
     t.column :field1 , :integer
   end
+  
   execute "IF NOT EXISTS(SELECT * FROM sys.schemas WHERE name = 'test') EXEC sp_executesql N'CREATE SCHEMA test'"
   execute "IF EXISTS(SELECT * FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_NAME = 'sql_server_schema_columns' and TABLE_SCHEMA = 'test') DROP TABLE test.sql_server_schema_columns"
   execute <<-SIMILIARTABLEINOTHERSCHEMA
@@ -126,6 +137,7 @@
     	n_description nvarchar(1000)
     )
   SIMILIARTABLEINOTHERSCHEMA
+  
   execute "IF EXISTS(SELECT * FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_NAME = 'sql_server_schema_identity' and TABLE_SCHEMA = 'test') DROP TABLE test.sql_server_schema_identity"
   execute <<-SIMILIARTABLEINOTHERSCHEMA
     CREATE TABLE test.sql_server_schema_identity(
@@ -134,6 +146,16 @@
     )
   SIMILIARTABLEINOTHERSCHEMA
 
+  execute "IF EXISTS(SELECT * FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_NAME = 'sql_server_schema_natural_id' and TABLE_SCHEMA = 'test') DROP TABLE test.sql_server_schema_natural_id"
+  execute <<-NATURALPKTABLESQLINOTHERSCHEMA
+    CREATE TABLE test.sql_server_schema_natural_id(
+    	parent_id int,
+    	name nvarchar(255),
+    	description nvarchar(1000),
+    	legacy_id nvarchar(10) NOT NULL PRIMARY KEY,
+    )
+  NATURALPKTABLESQLINOTHERSCHEMA
+  
 
   # Azure needs clustered indexes
   if sqlserver_azure?