DatabaseTasks support for all tasks! Uses FreeTDS defncopy for structure dump.

Author: metaskills

CHANGELOG.md

@@ -1,4 +1,11 @@
 
+## v4.2.2
+
+#### Added
+
+* DatabaseTasks support for all tasks! Uses FreeTDS `defncopy` for structure dump.
+
+
 ## v4.2.1
 
 #### Fixed

README.md

@@ -8,14 +8,7 @@
 
 ## Code Name Kantishna
 
-The SQL Server adapter for ActiveRecord. If you need the adapter for SQL Server 2008 or 2005, you are still in the right spot. Just install the latest 3.2.x to 4.1.x version of the adapter. We follow a rational versioning policy that tracks ActiveRecord. That means that our 4.2.x version of the adapter is only for the latest 4.2 version of Rails. We also have stable branches for each major/minor release of ActiveRecord.
-
-
-#### Testing Rake Tasks Support
-
-This is a long story, but if you are not working with a legacy database and you can trust your schema.rb to setup your local development or test database, then we have adapter level support for rails :db rake tasks. Please read this wiki page for full details.
-
-http://wiki.github.com/rails-sqlserver/activerecord-sqlserver-adapter/rails-db-rake-tasks
+The SQL Server adapter for ActiveRecord v4.2 using SQL Server 2012 or higher. If you need the adapter for SQL Server 2008 or 2005, you are still in the right spot. Just install the latest 3.2.x to 4.1.x version of the adapter. We follow a rational versioning policy that tracks ActiveRecord. That means that our 4.2.x version of the adapter is only for the latest 4.2 version of Rails. We also have stable branches for each major/minor release of ActiveRecord.
 
 
 #### Executing Stored Procedures

lib/active_record/connection_adapters/sqlserver/database_statements.rb

@@ -192,71 +192,6 @@ def newsequentialid_function
           select_value 'SELECT NEWSEQUENTIALID()'
         end
 
-        # === SQLServer Specific (Rake/Test Helpers) ==================== #
-
-        def recreate_database
-          remove_database_connections_and_rollback do
-            do_execute "EXEC sp_MSforeachtable 'DROP TABLE ?'"
-          end
-        end
-
-        def recreate_database!(database = nil)
-          database ||= current_database
-          drop_database(database)
-          create_database(database)
-        ensure
-          use_database(database)
-        end
-
-        def drop_database(database)
-          retry_count = 0
-          max_retries = 1
-          name = SQLServer::Utils.extract_identifiers(database)
-          begin
-            do_execute "
-              USE master
-              IF EXISTS (
-                SELECT * FROM [sys].[databases]
-                WHERE name = #{quote(name.object)}
-              ) DROP DATABASE #{name}
-            ".squish
-          rescue ActiveRecord::StatementInvalid => err
-            if err.message =~ /because it is currently in use/i
-              raise if retry_count >= max_retries
-              retry_count += 1
-              remove_database_connections_and_rollback(database)
-              retry
-            elsif err.message =~ /does not exist/i
-              nil
-            else
-              raise
-            end
-          end
-        end
-
-        def create_database(database, options = {})
-          name = SQLServer::Utils.extract_identifiers(database)
-          options = {collation: @connection_options[:collation]}.merge!(options.symbolize_keys)
-          options = options.select { |_, v| v.present? }
-          option_string = options.inject("") do |memo, (key, value)|
-            memo += case key
-            when :collation
-              " COLLATE #{value}"
-            else
-              ""
-            end
-          end
-          do_execute "CREATE DATABASE #{name}#{option_string}"
-        end
-
-        def current_database
-          select_value 'SELECT DB_NAME()'
-        end
-
-        def charset
-          select_value "SELECT SERVERPROPERTY('SqlCharSetName')"
-        end
-
 
         protected
 

lib/active_record/connection_adapters/sqlserver/database_tasks.rb

@@ -0,0 +1,44 @@
+module ActiveRecord
+  module ConnectionAdapters
+    module SQLServer
+      module DatabaseTasks
+
+        def create_database(database, options = {})
+          name = SQLServer::Utils.extract_identifiers(database)
+          options = {collation: @connection_options[:collation]}.merge!(options.symbolize_keys)
+          options = options.select { |_, v| v.present? }
+          option_string = options.inject("") do |memo, (key, value)|
+            memo += case key
+            when :collation
+              " COLLATE #{value}"
+            else
+              ""
+            end
+          end
+          do_execute "CREATE DATABASE #{name}#{option_string}"
+        end
+
+        def drop_database(database)
+          name = SQLServer::Utils.extract_identifiers(database)
+          do_execute "DROP DATABASE #{name}"
+        end
+
+        def current_database
+          select_value 'SELECT DB_NAME()'
+        end
+
+        def charset
+          select_value "SELECT DATABASEPROPERTYEX(DB_NAME(), 'SqlCharSetName')"
+        end
+
+        def collation
+          select_value "SELECT DATABASEPROPERTYEX(DB_NAME(), 'Collation')"
+        end
+
+      end
+    end
+  end
+end
+
+
+

lib/active_record/connection_adapters/sqlserver_adapter.rb

@@ -10,6 +10,7 @@
 require 'active_record/connection_adapters/sqlserver/type'
 require 'active_record/connection_adapters/sqlserver/database_limits'
 require 'active_record/connection_adapters/sqlserver/database_statements'
+require 'active_record/connection_adapters/sqlserver/database_tasks'
 require 'active_record/connection_adapters/sqlserver/transaction'
 require 'active_record/connection_adapters/sqlserver/errors'
 require 'active_record/connection_adapters/sqlserver/schema_cache'
@@ -21,6 +22,7 @@
 require 'active_record/connection_adapters/sqlserver/utils'
 require 'active_record/sqlserver_base'
 require 'active_record/connection_adapters/sqlserver_column'
+require 'active_record/tasks/sqlserver_database_tasks'
 
 module ActiveRecord
   module ConnectionAdapters
@@ -31,7 +33,8 @@ class SQLServerAdapter < AbstractAdapter
               SQLServer::DatabaseStatements,
               SQLServer::Showplan,
               SQLServer::SchemaStatements,
-              SQLServer::DatabaseLimits
+              SQLServer::DatabaseLimits,
+              SQLServer::DatabaseTasks
 
       ADAPTER_NAME = 'SQLServer'.freeze
 
@@ -250,6 +253,8 @@ def translate_exception(e, message)
           InvalidForeignKey.new(message, e)
         when /has been chosen as the deadlock victim/i
           DeadlockVictim.new(message, e)
+        when /database .* does not exist/i
+          NoDatabaseError.new(message, e)
         else
           super
         end
@@ -350,16 +355,6 @@ def initialize_dateformatter
         ::Time::DATE_FORMATS[:_sqlserver_dateformat] = dateformat
       end
 
-      def remove_database_connections_and_rollback(database = nil)
-        name = SQLServer::Utils.extract_identifiers(database || current_database)
-        do_execute "ALTER DATABASE #{name} SET SINGLE_USER WITH ROLLBACK IMMEDIATE"
-        begin
-          yield
-        ensure
-          do_execute "ALTER DATABASE #{name} SET MULTI_USER"
-        end if block_given?
-      end
-
     end
   end
 end

lib/active_record/tasks/sqlserver_database_tasks.rb

@@ -0,0 +1,131 @@
+require 'active_record/tasks/database_tasks'
+require 'shellwords'
+require 'ipaddr'
+require 'socket'
+
+module ActiveRecord
+  module Tasks
+
+    class SQLServerDatabaseTasks
+
+      DEFAULT_COLLATION = 'SQL_Latin1_General_CP1_CI_AS'
+
+      delegate :connection, :establish_connection, :clear_active_connections!,
+               to: ActiveRecord::Base
+
+      def initialize(configuration)
+        @configuration = configuration
+      end
+
+      def create(master_established = false)
+        establish_master_connection unless master_established
+        connection.create_database configuration['database'], configuration.merge('collation' => default_collation)
+        establish_connection configuration
+      rescue ActiveRecord::StatementInvalid => error
+        if /database .* already exists/i === error.message
+          raise DatabaseAlreadyExists
+        else
+          raise
+        end
+      end
+
+      def drop
+        establish_master_connection
+        connection.drop_database configuration['database']
+      end
+
+      def charset
+        connection.charset
+      end
+
+      def collation
+        connection.collation
+      end
+
+      def purge
+        clear_active_connections!
+        drop
+        create true
+      end
+
+      def structure_dump(filename)
+        command = [
+          "defncopy",
+          "-S #{Shellwords.escape(configuration['host'])}",
+          "-D #{Shellwords.escape(configuration['database'])}",
+          "-U #{Shellwords.escape(configuration['username'])}",
+          "-P #{Shellwords.escape(configuration['password'])}",
+          "-o #{Shellwords.escape(filename)}",
+        ]
+        table_args = connection.tables.map { |t| Shellwords.escape(t) }
+        command.concat(table_args)
+        view_args = connection.views.map { |v| Shellwords.escape(v) }
+        command.concat(view_args)
+        raise 'Error dumping database' unless Kernel.system(command.join(' '))
+        dump = File.read(filename)
+        dump.gsub!(/^USE .*$\nGO\n/, '')                      # Strip db USE statements
+        dump.gsub!(/^GO\n/, '')                               # Strip db GO statements
+        dump.gsub!(/nvarchar\(8000\)/, 'nvarchar(4000)')      # Fix nvarchar(8000) column defs
+        dump.gsub!(/nvarchar\(-1\)/, 'nvarchar(max)')         # Fix nvarchar(-1) column defs
+        dump.gsub!(/text\(\d+\)/, 'text')                     # Fix text(16) column defs
+        File.open(filename, "w") { |file| file.puts dump }
+      end
+
+      def structure_load(filename)
+        connection.execute File.read(filename)
+      end
+
+
+      private
+
+      def configuration
+        @configuration
+      end
+
+      def default_collation
+        configuration['collation'] || DEFAULT_COLLATION
+      end
+
+      def establish_master_connection
+        establish_connection configuration.merge('database' => 'master')
+      end
+
+    end
+
+    module DatabaseTasksSQLServer
+
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+
+        LOCAL_IPADDR = [
+          IPAddr.new('192.168.0.0/16'),
+          IPAddr.new('10.0.0.0/8'),
+          IPAddr.new('172.16.0.0/12')
+        ]
+
+        private
+
+        def local_database?(configuration)
+          super || local_ipaddr?(configuration_host_ip(configuration))
+        end
+
+        def configuration_host_ip(configuration)
+          return nil unless configuration['host']
+          Socket::getaddrinfo(configuration['host'], 'echo', Socket::AF_INET)[0][3]
+        end
+
+        def local_ipaddr?(host_ip)
+          return false unless host_ip
+          LOCAL_IPADDR.any? { |ip| ip.include?(host_ip) }
+        end
+
+      end
+
+    end
+
+    DatabaseTasks.register_task %r{sqlserver}, SQLServerDatabaseTasks
+    DatabaseTasks.send :include, DatabaseTasksSQLServer
+
+  end
+end

test/cases/coerced_tests.rb

@@ -222,6 +222,20 @@ module ConnectionAdapters
 
 
 
+module ActiveRecord
+  class DatabaseTasksCreateAllTest < ActiveRecord::TestCase
+    # We extend `local_database?` so that common VM IPs can be used.
+    coerce_tests! :test_ignores_remote_databases, :test_warning_for_remote_databases
+  end
+  class DatabaseTasksDropAllTest < ActiveRecord::TestCase
+    # We extend `local_database?` so that common VM IPs can be used.
+    coerce_tests! :test_ignores_remote_databases, :test_warning_for_remote_databases
+  end
+end
+
+
+
+
 class DefaultScopingTest < ActiveRecord::TestCase
 
   # We are not doing order duplicate removal anymore.