activerecord-sqlserver-adapter 7.0.7 → 7.1.0.beta1

data/lib/active_record/connection_adapters/sqlserver_adapter.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "tiny_tds"
 require "base64"
 require "active_record"
 require "arel_sqlserver"
@@ -11,11 +12,13 @@ require "active_record/connection_adapters/sqlserver/core_ext/explain_subscriber
 require "active_record/connection_adapters/sqlserver/core_ext/attribute_methods"
 require "active_record/connection_adapters/sqlserver/core_ext/finder_methods"
 require "active_record/connection_adapters/sqlserver/core_ext/preloader"
+require "active_record/connection_adapters/sqlserver/core_ext/abstract_adapter"
 require "active_record/connection_adapters/sqlserver/version"
 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/savepoints"
 require "active_record/connection_adapters/sqlserver/transaction"
 require "active_record/connection_adapters/sqlserver/errors"
 require "active_record/connection_adapters/sqlserver/schema_creation"
@@ -39,7 +42,8 @@ module ActiveRecord
               SQLServer::Showplan,
               SQLServer::SchemaStatements,
               SQLServer::DatabaseLimits,
-              SQLServer::DatabaseTasks
+              SQLServer::DatabaseTasks,
+              SQLServer::Savepoints
 
       ADAPTER_NAME = "SQLServer".freeze
 
@@ -77,93 +81,38 @@ module ActiveRecord
         end
 
         def new_client(config)
-          case config[:mode]
-          when :dblib
-            require "tiny_tds"
-            dblib_connect(config)
+          TinyTds::Client.new(config)
+        rescue TinyTds::Error => error
+          if error.message.match(/database .* does not exist/i)
+            raise ActiveRecord::NoDatabaseError
           else
-            raise ArgumentError, "Unknown connection mode in #{config.inspect}."
+            raise
           end
         end
 
-        def dblib_connect(config)
-          TinyTds::Client.new(
-            dataserver:    config[:dataserver],
-            host:          config[:host],
-            port:          config[:port],
-            username:      config[:username],
-            password:      config[:password],
-            database:      config[:database],
-            tds_version:   config[:tds_version] || "7.3",
-            appname:       config_appname(config),
-            login_timeout: config_login_timeout(config),
-            timeout:       config_timeout(config),
-            encoding:      config_encoding(config),
-            azure:         config[:azure],
-            contained:     config[:contained]
-          ).tap do |client|
-            if config[:azure]
-              client.execute("SET ANSI_NULLS ON").do
-              client.execute("SET ANSI_NULL_DFLT_ON ON").do
-              client.execute("SET ANSI_PADDING ON").do
-              client.execute("SET ANSI_WARNINGS ON").do
-            else
-              client.execute("SET ANSI_DEFAULTS ON").do
-            end
-            client.execute("SET QUOTED_IDENTIFIER ON").do
-            client.execute("SET CURSOR_CLOSE_ON_COMMIT OFF").do
-            client.execute("SET IMPLICIT_TRANSACTIONS OFF").do
-            client.execute("SET TEXTSIZE 2147483647").do
-            client.execute("SET CONCAT_NULL_YIELDS_NULL ON").do
-          end
-        rescue TinyTds::Error => e
-          raise ActiveRecord::NoDatabaseError if e.message.match(/database .* does not exist/i)
-          raise e
-        end
-
-        def config_appname(config)
-          if instance_methods.include?(:configure_application_name)
-            ActiveSupport::Deprecation.warn <<~MSG.squish
-            Configuring the application name used by TinyTDS by overriding the
-            `ActiveRecord::ConnectionAdapters::SQLServerAdapter#configure_application_name`
-            instance method is no longer supported. The application name should configured
-            using the `appname` setting in the `database.yml` file instead. Consult the
-            README for further information."
-            MSG
-          end
-
-          config[:appname] || rails_application_name
-        end
-
         def rails_application_name
           Rails.application.class.name.split("::").first
         rescue
           nil # Might not be in a Rails context so we fallback to `nil`.
         end
+      end
 
-        def config_login_timeout(config)
-          config[:login_timeout].present? ? config[:login_timeout].to_i : nil
-        end
-
-        def config_timeout(config)
-          config[:timeout].present? ? config[:timeout].to_i / 1000 : nil
-        end
+      def initialize(...)
+        super
 
-        def config_encoding(config)
-          config[:encoding].present? ? config[:encoding] : nil
-        end
-      end
+        @config[:tds_version] = "7.3" unless @config[:tds_version]
+        @config[:appname] = self.class.rails_application_name unless @config[:appname]
+        @config[:login_timeout] = @config[:login_timeout].present? ? @config[:login_timeout].to_i : nil
+        @config[:timeout] = @config[:timeout].present? ? @config[:timeout].to_i / 1000 : nil
+        @config[:encoding] = @config[:encoding].present? ? @config[:encoding] : nil
 
-      def initialize(connection, logger, _connection_options, config)
-        super(connection, logger, config)
-        @connection_options = config
-        perform_connection_configuration
+        @connection_parameters ||= @config
       end
 
       # === Abstract Adapter ========================================== #
 
       def arel_visitor
-        Arel::Visitors::SQLServer.new self
+        Arel::Visitors::SQLServer.new(self)
       end
 
       def valid_type?(type)
@@ -171,13 +120,7 @@ module ActiveRecord
       end
 
       def schema_creation
-        SQLServer::SchemaCreation.new self
-      end
-
-      def self.database_exists?(config)
-        !!ActiveRecord::Base.sqlserver_connection(config)
-      rescue ActiveRecord::NoDatabaseError
-        false
+        SQLServer::SchemaCreation.new(self)
       end
 
       def supports_ddl_transactions?
@@ -228,12 +171,8 @@ module ActiveRecord
         true
       end
 
-      def supports_check_constraints?
-        true
-      end
-
       def supports_json?
-        @version_year >= 2016
+        version_year >= 2016
       end
 
       def supports_comments?
@@ -252,12 +191,16 @@ module ActiveRecord
         true
       end
 
+      def supports_common_table_expressions?
+        true
+      end
+
       def supports_lazy_transactions?
         true
       end
 
       def supports_in_memory_oltp?
-        @version_year >= 2014
+        version_year >= 2014
       end
 
       def supports_insert_returning?
@@ -276,50 +219,52 @@ module ActiveRecord
         false
       end
 
+      def return_value_after_insert?(column) # :nodoc:
+        column.is_primary? || column.is_identity?
+      end
+
       def disable_referential_integrity
         tables = tables_with_referential_integrity
-        tables.each { |t| do_execute "ALTER TABLE #{quote_table_name(t)} NOCHECK CONSTRAINT ALL" }
+        tables.each { |t| execute "ALTER TABLE #{quote_table_name(t)} NOCHECK CONSTRAINT ALL" }
         yield
       ensure
-        tables.each { |t| do_execute "ALTER TABLE #{quote_table_name(t)} CHECK CONSTRAINT ALL" }
+        tables.each { |t| execute "ALTER TABLE #{quote_table_name(t)} CHECK CONSTRAINT ALL" }
       end
 
       # === Abstract Adapter (Connection Management) ================== #
 
       def active?
-        return false unless @connection
-
-        raw_connection_do "SELECT 1"
-        true
+        @raw_connection&.active?
       rescue *connection_errors
         false
       end
 
-      def reconnect!
-        super
-        disconnect!
+      def reconnect
+        @raw_connection&.close rescue nil
+        @raw_connection = nil
+        @spid = nil
+        @collation = nil
+
         connect
       end
 
       def disconnect!
         super
-        case @connection_options[:mode]
-        when :dblib
-          @connection.close rescue nil
-        end
-        @connection = nil
+
+        @raw_connection&.close rescue nil
+        @raw_connection = nil
         @spid = nil
         @collation = nil
       end
 
-      def clear_cache!
+      def clear_cache!(...)
         @view_information = nil
         super
       end
 
       def reset!
         reset_transaction
-        do_execute "IF @@TRANCOUNT > 0 ROLLBACK TRANSACTION"
+        execute "IF @@TRANCOUNT > 0 ROLLBACK TRANSACTION"
       end
 
       # === Abstract Adapter (Misc Support) =========================== #
@@ -360,7 +305,7 @@ module ActiveRecord
       end
 
       def database_prefix
-        @connection_options[:database_prefix]
+        @connection_parameters[:database_prefix]
       end
 
       def database_prefix_identifier(name)
@@ -376,7 +321,7 @@ module ActiveRecord
       end
 
       def inspect
-        "#<#{self.class} version: #{version}, mode: #{@connection_options[:mode]}, azure: #{sqlserver_azure?.inspect}>"
+        "#<#{self.class} version: #{version}, azure: #{sqlserver_azure?.inspect}>"
       end
 
       def combine_bind_parameters(from_clause: [], join_clause: [], where_clause: [], having_clause: [], limit: nil, offset: nil)
@@ -390,6 +335,12 @@ module ActiveRecord
         version_year
       end
 
+      def check_version # :nodoc:
+        if schema_cache.database_version < 2012
+          raise "Your version of SQL Server (#{database_version}) is too old. SQL Server Active Record supports 2012 or higher."
+        end
+      end
+
       class << self
         protected
 
@@ -517,7 +468,7 @@ module ActiveRecord
       # === SQLServer Specific (Connection Management) ================ #
 
       def connection_errors
-        @connection_errors ||= [].tap do |errors|
+        @raw_connection_errors ||= [].tap do |errors|
           errors << TinyTds::Error if defined?(TinyTds::Error)
         end
       end
@@ -538,32 +489,44 @@ module ActiveRecord
       end
 
       def version_year
-        return 2016 if sqlserver_version =~ /vNext/
-
-        /SQL Server (\d+)/.match(sqlserver_version).to_a.last.to_s.to_i
-      rescue StandardError
-        2016
+        @version_year ||= begin
+          if sqlserver_version =~ /vNext/
+            2016
+          else
+            /SQL Server (\d+)/.match(sqlserver_version).to_a.last.to_s.to_i
+          end
+        rescue StandardError
+          2016
+        end
       end
 
       def sqlserver_version
-        @sqlserver_version ||= _raw_select("SELECT @@version", fetch: :rows).first.first.to_s
+        @sqlserver_version ||= _raw_select("SELECT @@version", @raw_connection, fetch: :rows).first.first.to_s
       end
 
       private
 
       def connect
-        @connection = self.class.new_client(@connection_options)
-        perform_connection_configuration
+        @raw_connection = self.class.new_client(@connection_parameters)
       end
 
-      def perform_connection_configuration
-        configure_connection_defaults
-        configure_connection if self.respond_to?(:configure_connection)
-      end
+      def configure_connection
+        if @config[:azure]
+          @raw_connection.execute("SET ANSI_NULLS ON").do
+          @raw_connection.execute("SET ANSI_NULL_DFLT_ON ON").do
+          @raw_connection.execute("SET ANSI_PADDING ON").do
+          @raw_connection.execute("SET ANSI_WARNINGS ON").do
+        else
+          @raw_connection.execute("SET ANSI_DEFAULTS ON").do
+        end
+
+        @raw_connection.execute("SET QUOTED_IDENTIFIER ON").do
+        @raw_connection.execute("SET CURSOR_CLOSE_ON_COMMIT OFF").do
+        @raw_connection.execute("SET IMPLICIT_TRANSACTIONS OFF").do
+        @raw_connection.execute("SET TEXTSIZE 2147483647").do
+        @raw_connection.execute("SET CONCAT_NULL_YIELDS_NULL ON").do
 
-      def configure_connection_defaults
-        @spid = _raw_select("SELECT @@SPID", fetch: :rows).first.first
-        @version_year = version_year
+        @spid = _raw_select("SELECT @@SPID", @raw_connection, fetch: :rows).first.first
 
         initialize_dateformatter
         use_database

data/lib/active_record/connection_adapters/sqlserver_column.rb

@@ -17,6 +17,7 @@ module ActiveRecord
         def is_identity?
           is_identity
         end
+        alias_method :auto_incremented_by_db?, :is_identity?
 
         def is_primary?
           is_primary

data/lib/active_record/sqlserver_base.rb

@@ -7,16 +7,7 @@ module ActiveRecord
     end
 
     def sqlserver_connection(config) #:nodoc:
-      config = config.symbolize_keys
-      config.reverse_merge!(mode: :dblib)
-      config[:mode] = config[:mode].to_s.downcase.underscore.to_sym
-
-      sqlserver_adapter_class.new(
-        sqlserver_adapter_class.new_client(config),
-        logger,
-        nil,
-        config
-        )
+      sqlserver_adapter_class.new(config)
     end
   end
 end

data/lib/active_record/tasks/sqlserver_database_tasks.rb

@@ -10,8 +10,7 @@ module ActiveRecord
     class SQLServerDatabaseTasks
       DEFAULT_COLLATION = "SQL_Latin1_General_CP1_CI_AS"
 
-      delegate :connection, :establish_connection, :clear_active_connections!,
-               to: ActiveRecord::Base
+      delegate :connection, :establish_connection, to: ActiveRecord::Base
 
       def self.using_database_configurations?
         true
@@ -53,6 +52,10 @@ module ActiveRecord
         create true
       end
 
+      def clear_active_connections!
+        ActiveRecord::Base.connection_handler.clear_active_connections!
+      end
+
       def structure_dump(filename, extra_flags)
         server_arg = "-S #{Shellwords.escape(configuration_hash[:host])}"
         server_arg += ":#{Shellwords.escape(configuration_hash[:port])}" if configuration_hash[:port]

data/lib/arel/visitors/sqlserver.rb

@@ -64,39 +64,6 @@ module Arel
         super
       end
 
-      def visit_Arel_Nodes_HomogeneousIn(o, collector)
-        collector.preparable = false
-
-        collector << quote_table_name(o.table_name) << "." << quote_column_name(o.column_name)
-
-        if o.type == :in
-          collector << " IN ("
-        else
-          collector << " NOT IN ("
-        end
-
-        values = o.casted_values
-
-        if values.empty?
-          collector << @connection.quote(nil)
-        elsif @connection.prepared_statements
-          # Monkey-patch start. Add query attribute bindings rather than just values.
-          column_name = o.column_name
-          column_type = o.attribute.relation.type_for_attribute(o.column_name)
-          # Use cast_type on encrypted attributes. Don't encrypt them again
-          column_type = column_type.cast_type if column_type.is_a?(ActiveRecord::Encryption::EncryptedAttributeType)
-          attrs = values.map { |value| ActiveRecord::Relation::QueryAttribute.new(column_name, value, column_type) }
-
-          collector.add_binds(attrs, &bind_block)
-          # Monkey-patch end.
-        else
-          collector.add_binds(values, &bind_block)
-        end
-
-        collector << ")"
-        collector
-      end
-
       def visit_Arel_Nodes_SelectStatement(o, collector)
         @select_statement = o
         distinct_One_As_One_Is_So_Not_Fetch o

data/test/cases/adapter_test_sqlserver.rb

@@ -19,7 +19,6 @@ class AdapterTestSQLServer < ActiveRecord::TestCase
     string = connection.inspect
     _(string).must_match %r{ActiveRecord::ConnectionAdapters::SQLServerAdapter}
     _(string).must_match %r{version\: \d.\d}
-    _(string).must_match %r{mode: dblib}
     _(string).must_match %r{azure: (true|false)}
     _(string).wont_match %r{host}
     _(string).wont_match %r{password}
@@ -102,16 +101,18 @@ class AdapterTestSQLServer < ActiveRecord::TestCase
   it "test bad connection" do
     assert_raise ActiveRecord::NoDatabaseError do
       db_config = ActiveRecord::Base.configurations.configs_for(env_name: "arunit", name: "primary")
-      configuration = db_config.configuration_hash.merge(database: "inexistent_activerecord_unittest")
-      ActiveRecord::Base.sqlserver_connection configuration
+      configuration = db_config.configuration_hash.merge(database: "nonexistent_activerecord_unittest")
+
+      connection = ActiveRecord::Base.sqlserver_connection configuration
+      connection.exec_query("SELECT 1")
     end
   end
 
   it "test database exists returns false if database does not exist" do
     db_config = ActiveRecord::Base.configurations.configs_for(env_name: "arunit", name: "primary")
-    configuration = db_config.configuration_hash.merge(database: "inexistent_activerecord_unittest")
+    configuration = db_config.configuration_hash.merge(database: "nonexistent_activerecord_unittest")
     assert_not ActiveRecord::ConnectionAdapters::SQLServerAdapter.database_exists?(configuration),
-               "expected database to not exist"
+               "expected database #{configuration[:database]} to not exist"
   end
 
   it "test database exists returns true when the database exists" do
@@ -306,7 +307,7 @@ class AdapterTestSQLServer < ActiveRecord::TestCase
   end
 
   describe "database statements" do
-    it "run the database consistency checker useroptions command" do
+    it "run the database consistency checker 'user_options' command" do
       skip "on azure" if connection_sqlserver_azure?
       keys = [:textsize, :language, :isolation_level, :dateformat]
       user_options = connection.user_options
@@ -345,7 +346,7 @@ class AdapterTestSQLServer < ActiveRecord::TestCase
       assert_equal "tinyint", connection.type_to_sql(:integer, limit: 1)
     end
 
-    it "create bigints when limit is greateer than 4" do
+    it "create bigints when limit is greater than 4" do
       assert_equal "bigint", connection.type_to_sql(:integer, limit: 5)
       assert_equal "bigint", connection.type_to_sql(:integer, limit: 6)
       assert_equal "bigint", connection.type_to_sql(:integer, limit: 7)