activerecord-sqlserver-adapter 2.3.24 → 3.0.0

data/CHANGELOG

@@ -1,112 +1,9 @@
 
-* 2.3.24 *
+MASTER
 
-* Create a #configure_application_name method that can be overridden for unique TinyTDS app names
-  to show up in SQL Server's activity monitor.
+* 3.0.0
 
-
-* 2.3.23 *
-
-* Create a #configure_connection method that can be overridden. Think "SET TEXTSIZE...".
-
-* Fixed the #finish_statement_handle to cancel the TinyTDS connection if needed.
-
-* Fix the #indexes method to fail gracefully if sp_helptext permissions fail.
-
-
-* 2.3.22 *
-
-* Make #rollback_db_transaction smarter.
-
- 
-* 2.3.21 *
-
-* Add support/test around handling of float/real column types [Lucas Maxwell]
-
-
-* 2.3.20 *
-
-* Fixes quote column names and passes tests for ActiveRecord 2.3.14.
-
-
-* 2.3.19 *
-
-* Allow drop_database to be called even when DB does not exist.
-
-
-* 2.3.18 *
-
-* Warn of possible permission problems if "EXEC sp_helptext..." does not work view. Fixes #73.
-
-* Fix returning of auto-increment identity for TinyTDS driver. [Gregory McIntyre / puyo]
-
-
-* 2.3.17 *
-
-* Allow TinyTDS/DBLIB mode to pass down :host/:port config options.
-
-
-* 2.3.16 *
-
-* TinyTDS enhancements for lost connections. Default connection mode.
-
-
-* 2.3.15 *
-
-* Version bump due to bad 2.3.14 release.
-
-
-* 2.3.14 *
-
-* Flatten sp_helpconstraint when looking for constraints just in case fks are present. Issue #64.
-
-* Properly quote table names when reflecting on views.
-
-* Add "dead or not enabled" to :dblib's lost connection messages.
-
-
-* 2.3.13 *
-
-* Fixed native database type memoization, now at connection instance level. Fix #execute_procedure for :dblib mode to return indifferent access rows too. Misc test case fixes for 2000 & 2005 need for using coerced Time vs Date type. Fix SQL Server 2000's lack of using TinyTds' native affected rows for UPDATE statements, revert to raw SQL. 
-
-* Make login timeout and query timeout backward database.yml friendly for :dblib mode.
-
-
-* 2.3.12 *
-
-* Add multiple results set support with #execute_procedure for :dblib mode. [Ken Collins]
-
-* Allow unicode conditions strings to be quoted correctly. Like 3.0 branch. [Ken Collins]
-
-* Simplify encoding support. [Ken Collins]
-
-* Add binary timestamp datatype handling. [Erik Bryn]
-
-
-* 2.3.11
-
-* Add TinyTds/dblib connection mode. [Ken Collins]
-
-
-* 2.3.10
-
-* Fix DSN'less code. [Erik Bryn]
-
-
-* 2.3.9
-
-* Support DSN'less connections. Resolves ticket 38. 
-
-* Support upcoming ruby odbc 0.99992
-
-* Include new raw connection interfaces developed and optimized under the 3.0 branch.
-
-* The remove_column conforms to ArgumentError exceptions. [Ken Collins]
-
-* Add support for default function values in schema reflection. Allows for uniqueidentifier default 
-values like NEWID(). These are not automatically inserted into the INSERT statement as of yet, that 
-could be done user side on a before save callback now. Includes new #newid_function and 
-#newsequentialid_function on the connection for helping. Resolves tikcet #42. [Ken Collins]
+* Release rails 3 version!
 
 
 * 2.3.8
@@ -123,7 +20,7 @@ could be done user side on a before save callback now. Includes new #newid_funct
 
 * Allow DNS's to not contain a database and use what is in database.yml [Marco Mastrodonato]
 
-* Rake tasks methods for vanallia rails :db namespace parity. [Ken Collins]
+* Rake tasks methods for vanilla rails :db namespace parity. [Ken Collins]
 
 * IronRuby integrated security fixes [Jimmy Schementi]
 
@@ -148,7 +45,7 @@ could be done user side on a before save callback now. Includes new #newid_funct
 
 * Qualify INFORMATION_SCHEMA.COLUMNS with a correct period DB name if present.
 
-* Allow adapter to return multipe results sets, for example from stored procedures. [Chris Hall]
+* Allow adapter to return multiple results sets, for example from stored procedures. [Chris Hall]
 
 
 * 2.3.4

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2008
+Copyright (c) 2008-2010
  
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,54 +1,32 @@
 
-== Rails SQL Server 2000, 2005 and 2008 Adapter
+== SQL Server 2005 and 2008 Adapter For ActiveRecord
 
-The SQL Server adapter for rails is back for ActiveRecord 2.2 and up! We are currently passing all tests and hope to continue to do so moving forward. 
+The SQL Server adapter for ActiveRecord.
 
 
 == What's New
 
-* New dblib connection mode using TinyTds!
-* Integration with rails :db namespaced rake tasks.
-* IronRuby support using ADONET connection mode.
-* Direct ODBC mode. No DBI anymore, means around 20% faster!
-* Now supports SQL Server 2008 too!
-* Fully tested under 1.9!!! Correctly encodes/decodes UTF-8 types in ruby 1.9 too.
-* Now supports both rails 2.2 & 2.3!!!
-* An ActiveRecord::Base.execute_procedure method that can be used by classes.
-* Enabled support for DDL transactions.
-* Micro second support. Time#usec is automatically converted to SQL Server's 3.33 millisecond limitation.
-* Datetime data types before type casting are represented correctly. For example: 1998-01-01 23:59:59.997
-* Implementation for #disable_referential_integrity used by ActiveRecord's Fixtures class.
-* Pessimistic locking suppot. See the #add_lock! method for details.
-* Enabled #case_sensitive_equality_operator used by unique validations.
-* Unicode character support for nchar, nvarchar and ntext data types. Configuration option for defaulting all string data types to the unicode safe types.
-* View support for table names, identity inserts, and column defaults.
-* A block method to run queries within a specific isolation level.
-* Automatically reconnects to lost database connections.
+* Version 3.x now supports rails 3!
 
 
 ==== 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 you 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/2000-2005-adapter/rails-db-rake-tasks
-
-
-==== SQL Server 2008 Support
-
-Because this adapter is primarily coded to SQL Server 2000/2005, it does not take advantage of many of the things in 2008 that would speed up the code. At some point in the future there will be a branch of this code that is specifically targeted for 2008. That adapter version will remove much of the dirty innards of this version that are meant to code around many previous SQL Server 2000/2005 short comings, the biggest being no limit/offset.
-
+http://wiki.github.com/rails-sqlserver/activerecord-sqlserver-adapter/rails-db-rake-tasks
 
 
 ==== Date/Time Data Type Hinting
 
-Both SQL Server 2000 and 2005 do not include native data types for just 'date' or 'time', it only has 'datetime'. To pass the ActiveRecord tests we implemented two simple class methods that can teach your models to coerce column information to be cast correctly. Simply past a list of symbols to either the <tt>coerce_sqlserver_date</tt> or <tt>coerce_sqlserver_time</tt> methods that correspond to 'datetime' columns that need to be cast correctly.
+SQL Server 2005 does not include a native data type for just 'date' or 'time', it only has 'datetime'. To pass the ActiveRecord tests we implemented two simple class methods that can teach your models to coerce column information to be cast correctly. Simply pass a list of symbols to either the <tt>coerce_sqlserver_date</tt> or <tt>coerce_sqlserver_time</tt> methods that correspond to 'datetime' columns that need to be cast correctly.
 
   class Topic < ActiveRecord::Base
     coerce_sqlserver_date :last_read
     coerce_sqlserver_time :bonus_time
   end
 
-This implementation has some limitations. To date we can only coerce date/time types for models that conform to the expected ActiveRecord class to table naming convention. So a table of 'foo_bar_widgets' will look for coerced types in the FooBarWidget class if it exists.
+This implementation has some limitations. To date we can only coerce date/time types for models that conform to the expected ActiveRecord class to table naming conventions. So a table of 'foo_bar_widgets' will look for coerced column types in the FooBarWidget class.
+
 
 ==== Executing Stored Procedures
 
@@ -56,6 +34,7 @@ Every class that sub classes ActiveRecord::Base will now have an execute_procedu
 
   Account.execute_procedure :update_totals, 'admin', nil, true
 
+
 ==== Native Data Type Support
 
 Currently the following custom data types have been tested for schema definitions.
@@ -64,8 +43,8 @@ Currently the following custom data types have been tested for schema definition
 * nchar
 * nvarchar
 * ntext
-* varchar(max) for SQL Server 2005 only.
-* nvarchar(max) for SQL Server 2005 only.
+* varchar(max)
+* nvarchar(max)
 
 For example:
 
@@ -78,41 +57,30 @@ For example:
     t.column :body2_utf8,     :nvarchar_max   # Creates nvarchar(max)
   end
 
-Manually creating a varchar(max) on SQL Server 2005 is not necessary since this is the default type created when specifying a :text field. As time goes on we will be testing other SQL Server specific data types are handled correctly when created in a migration.
+Manually creating a varchar(max) is not necessary since this is the default type created when specifying a :text field. As time goes on we will be testing other SQL Server specific data types are handled correctly when created in a migration.
 
 
 ==== Native Text/String/Binary Data Type Accessor
 
-To pass the ActiveRecord tests we had to implement an class accessor for the native type created for :text columns. By default any :text column created by migrations will create these native types.
-
-* SQL Server 2000 is 'text'
-* SQL Server 2005 is 'varchar(max)'
-
-During testing this type is set to 'varchar(8000)' for SQL Server 2000. The reason is that rails expects to be able to use SQL = operators on text data types and this is not possible with a native 'text' data type in SQL Server. The default 'varchar(max)' for SQL Server 2005 can be queried using the SQL = operator and has plenty of storage space which is why we made it the default for 2005. If for some reason you want to change the data type created during migrations for any SQL Server version, you can configure this line to your liking in a config/initializers file.
+To pass the ActiveRecord tests we had to implement an class accessor for the native type created for :text columns. By default any :text column created by migrations will create a 'varchar(max)' data type. This type can be queried using the SQL = operator and has plenty of storage space which is why we made it the default. If for some reason you want to change the data type created during migrations you can configure this line to your liking in a config/initializers file.
 
   ActiveRecord::ConnectionAdapters::SQLServerAdapter.native_text_database_type = 'varchar(8000)'
-  
-Also, there is a class attribute setter for the native string database type. This is the same for both SQL Server 2000 and 2005, 'varchar'. However in can be used instead of the #enable_default_unicode_types below for finer grain control over which types you want unicode safe when adding or changing the schema.
+
+Also, there is a class attribute setter for the native string database type. This is the same for all SQL Server versions, 'varchar'. However it can be used instead of the #enable_default_unicode_types below for finer grain control over which types you want unicode safe when adding or changing the schema.
 
   ActiveRecord::ConnectionAdapters::SQLServerAdapter.native_string_database_type = 'nvarchar'
 
-By default any :binary column created by migrations will create these native types
+By default any :binary column created by migrations will create a 'varbinary(max)' data type. This too can be set using an initializer.
 
-* SQL Server 2000 is 'image'
-* SQL Server 2005 is 'varbinary(max)'
+  ActiveRecord::ConnectionAdapters::SQLServerAdapter.native_binary_database_type = 'image'
 
 
 ====  Setting Unicode Types As Default
 
-By default the adapter will use non-unicode safe data types for :string and :text types when DEFINING or CHANGING the schema. If you choose, you can set the following class attribute in a config/initializers file that will change this behavior. When set to true it has the equivalent meaning as the two lower items. These examples show detail level alternatives to achieve similar effects.
+By default the adapter will use non-unicode safe data types for :string and :text types when defining/changing the schema. If you choose, you can set the following class attribute in a config/initializers file that will change this behavior. When set to true it has the equivalent meaning as the two lower items. These examples show detail level alternatives to achieve similar effects.
   
   ActiveRecord::ConnectionAdapters::SQLServerAdapter.enable_default_unicode_types = true
   
-  # SQL Server 2000
-  ActiveRecord::ConnectionAdapters::SQLServerAdapter.native_text_database_type = 'ntext'
-  ActiveRecord::ConnectionAdapters::SQLServerAdapter.native_string_database_type = 'nvarchar'
-  
-  # SQL Server 2005
   ActiveRecord::ConnectionAdapters::SQLServerAdapter.native_text_database_type = 'nvarchar(max)'
   ActiveRecord::ConnectionAdapters::SQLServerAdapter.native_string_database_type = 'nvarchar'
 
@@ -121,10 +89,11 @@ It is important to remember that unicode types in SQL Server have approximately
 
 ====  Schema Information Logging
 
-By default all queries to the INFORMATION_SCHEMA table is silenced. If you think logging these queries are useful, you can enable it by adding this like to a config/initializers file.
+By default all queries to the INFORMATION_SCHEMA table is silenced. If you think logging these queries are useful, you can enable it by adding this like to a initializer file.
 
   ActiveRecord::ConnectionAdapters::SQLServerAdapter.log_info_schema_queries = true
 
+
 ==== Auto Connecting
 
 By default the adapter will auto connect to lost DB connections. For every query it will retry at intervals of 2, 4, 8, 16 and 32 seconds. During each retry it will callback out to ActiveRecord::Base.did_retry_sqlserver_connection(connection,count). When all retries fail, it will callback to ActiveRecord::Base.did_lose_sqlserver_connection(connection). Both implementations of these methods are to write to the rails logger, however, they make great override points for notifications like Hoptoad. If you want to disable automatic reconnections use the following in an initializer.
@@ -134,22 +103,23 @@ By default the adapter will auto connect to lost DB connections. For every query
 
 == Versions
 
-It is our goal to match the adapter version with each version of rails. However we will track our own tiny version independent of ActiveRecord. For example, an adapter version of 2.2.x will work on any 2.2.x version of ActiveRecord. This convention will be used in both the Git tags as well as the Rubygems versioning.
+It is our goal to match the adapter version with each version of rails. However we will track our own tiny version independent of ActiveRecord. For example, an adapter version of 2.3.x will work on any 2.3.x version of ActiveRecord. Version 3.x will track ActiveRecord 3. This convention will be used in both the Git tags as well as the gems versioning.
 
 
 == Installation
 
-You will need Ruby ODBC. If you are using the adapter under 1.9, then you need at least ruby-odbc version 0.9996. ODBC is the preferred mode, however if you are using IronRuby you can use the ADONET connection mode which uses native System.Data connection. Other connection modes may be supported, possibly a straight FreeTDS layer. The sky is the limit now and we have a code that can be accept these optional transports. If you are interested in helping, open a ticket and submit a patch. Or start a conversation on the Google Group.
+You will need Ruby ODBC. If you are using the adapter under 1.9, then you need at least ruby-odbc version 0.99992. ODBC is the preferred mode, however if you are using IronRuby you can use the ADONET connection mode which uses native System.Data connection. Other connection modes may be supported, possibly a straight FreeTDS layer. The sky is the limit for optional transports. If you are interested in helping, open a ticket and submit a patch. Or start a conversation on the Google Group.
 
   $ gem install activerecord-sqlserver-adapter
 
-Optionally configure your gem dependencies in your rails environment.rb file.
+Optionally configure your gem dependencies in your Gemfile.
 
-  config.gem 'activerecord-sqlserver-adapter', :version => 'x.x.xx'
+  gem 'activerecord-sqlserver-adapter', '3.x.xx'
 
-Here are some external links for libraries and/or tutorials on how to install any other additional components to use this adapter. If you know of a good one that we can include here, just let us know.
+If you have any troubles installing the lower level libraries for the adapter, please consult the wiki pages for various platform installation guides. Tons of good info can be found and we ask that you contribute too!
+
+http://wiki.github.com/rails-sqlserver/activerecord-sqlserver-adapter/platform-installation
 
-* http://www.ch-werner.de/rubyodbc/
 
 
 == IronRuby ADONET Mode
@@ -165,28 +135,30 @@ Currently IronRuby is passing most of the ActiveRecord and Adapter tests. Here i
 http://gist.github.com/381101
 
 
+
 == Contributing
 
 If you’d like to contribute a feature or bugfix, thanks! To make sure your fix/feature has a high chance of being added, please read the following guidelines. First, ask on the Google list, IRC, or post a ticket on github issues. Second, make sure there are tests! We will not accept any patch that is not tested. Please read the RUNNING_UNIT_TESTS file for the details of how to run the unit tests.
 
-* Github: http://github.com/rails-sqlserver
+* Github: http://github.com/rails-sqlserver/activerecord-sqlserver-adapter
 * Google Group: http://groups.google.com/group/rails-sqlserver-adapter
 * IRC Room: #rails-sqlserver on irc.freenode.net
 
 
-== Credits
 
-Many many people have contributed. If you do not see your name here and it should be let us know.
+== Credits & Contributions
+
+Many many people have contributed. If you do not see your name here and it should be let us know. Also, many thanks go out to those that have pledged financial contributions.
 
 * Ken Collins
-* Erik Bryn
 * Murray Steele
 * Shawn Balestracci
 * Joe Rafaniello
 * Tom Ward
 
 
+
 == License
 
-Copyright © 2008. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.
+Copyright © 2008-2010. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.
 

data/lib/active_record/connection_adapters/sqlserver/core_ext/active_record.rb

@@ -0,0 +1,57 @@
+require 'active_record/version'
+
+module ActiveRecord
+  module ConnectionAdapters
+    module Sqlserver
+      module CoreExt
+        module ActiveRecord
+
+          def self.included(klass)
+            klass.extend ClassMethods
+            class << klass
+              alias_method_chain :reset_column_information, :sqlserver_cache_support
+            end
+          end
+
+          module ClassMethods
+
+            def execute_procedure(proc_name, *variables)
+              if connection.respond_to?(:execute_procedure)
+                connection.execute_procedure(proc_name,*variables)
+              else
+                []
+              end
+            end
+
+            def coerce_sqlserver_date(*attributes)
+              write_inheritable_attribute :coerced_sqlserver_date_columns, Set.new(attributes.map(&:to_s))
+            end
+
+            def coerce_sqlserver_time(*attributes)
+              write_inheritable_attribute :coerced_sqlserver_time_columns, Set.new(attributes.map(&:to_s))
+            end
+
+            def coerced_sqlserver_date_columns
+              read_inheritable_attribute(:coerced_sqlserver_date_columns) || []
+            end
+
+            def coerced_sqlserver_time_columns
+              read_inheritable_attribute(:coerced_sqlserver_time_columns) || []
+            end
+
+            def reset_column_information_with_sqlserver_cache_support
+              connection.send(:initialize_sqlserver_caches) if connection.respond_to?(:sqlserver?)
+              reset_column_information_without_sqlserver_cache_support
+            end
+
+          end
+
+        end
+      end
+    end
+  end
+end
+
+
+ActiveRecord::Base.send :include, ActiveRecord::ConnectionAdapters::Sqlserver::CoreExt::ActiveRecord
+

data/lib/active_record/connection_adapters/sqlserver/core_ext/odbc.rb

@@ -0,0 +1,57 @@
+module ActiveRecord
+  module ConnectionAdapters
+    module Sqlserver
+      module CoreExt
+        module ODBC
+
+          module TimeStamp
+            
+            def to_sqlserver_string
+              date, time, nanoseconds = to_s.split(' ')
+              "#{date} #{time}.#{sprintf("%03d",nanoseconds.to_i/1000000)}"
+            end
+            
+          end
+
+          module Statement
+            
+            def finished?
+              begin
+                connected?
+                false
+              rescue *Database.parent_modules_error_exceptions
+                true
+              end
+            end
+            
+          end
+
+          module Database
+            
+            def self.parent_modules
+              @parent_module ||= ['ODBC','ODBC_UTF8','ODBC_NONE'].map{ |odbc_ns| odbc_ns.constantize rescue nil }.compact
+            end
+            
+            def self.parent_modules_error_exceptions
+              @parent_modules_error_exceptions ||= parent_modules.map { |odbc_ns| "::#{odbc_ns}::Error".constantize }
+            end
+            
+            def run_block(*args)
+              yield sth = run(*args)
+              sth.drop
+            end
+            
+          end
+
+        end
+      end
+    end
+  end
+end
+
+['ODBC','ODBC_UTF8','ODBC_NONE'].map{ |odbc_ns| odbc_ns.constantize rescue nil }.compact.each do |ns|
+  ns::TimeStamp.send :include, ActiveRecord::ConnectionAdapters::Sqlserver::CoreExt::ODBC::TimeStamp
+  ns::Statement.send :include, ActiveRecord::ConnectionAdapters::Sqlserver::CoreExt::ODBC::Statement
+  ns::Database.send :include, ActiveRecord::ConnectionAdapters::Sqlserver::CoreExt::ODBC::Database
+end
+