activerecord-sqlserver-adapter 4.1.8 → 4.2.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6738a943e243e64280e1fade7fc29860c8636816
-  data.tar.gz: c658b0ba20835d87f42398f680fccca5e0fcf716
+  metadata.gz: 4761029202d3adf1b562330d1931f922e8310897
+  data.tar.gz: 7476ee98b07671b29729e87265a0b3f77e573af6
 SHA512:
-  metadata.gz: faaf430a3992e4910a8c3b4b8f1254ff3c0f46469ee9a5a68c616976366d8725f53afd21173e359e367999348e4f570599f9b8286f07f6a0b3f15094f5662002
-  data.tar.gz: a7c9a880f68ea2f90e0e28d74e5acd95ed5bc17562afee82e1d0cd5742671be64a39159bb282100a792e6b85b3d4bb593bb6dd2bcb7516cd430784646d8c2133
+  metadata.gz: d8a5024c099b455c09abdeeb00469f7d3a397943897ea25d1f225221c51bcc5ccd329b059746e8c6972dd4cd0456aa16d581b67c6c7d74a84f1a5d6cc2706f79
+  data.tar.gz: eeb7cbf4bcc2972682e0bbe653a1ccfd4b50251f85e1b595551de4142403be72247633441e63622da7658c1540da6472c0130f769ddbf1b63bf267ba7b4218fc

data/.gitignore

@@ -0,0 +1,15 @@
+nbproject/
+debug.log
+.DS_Store
+pkg/
+doc/
+*.gem
+.bundle
+Gemfile.lock
+test/profile/output/*
+.rvmrc
+.rbenv-version
+.idea
+coverage/*
+.flooignore
+.floo

data/CHANGELOG.md

@@ -0,0 +1,60 @@
+
+## v4.2.0
+
+#### Added
+
+* New `ActiveRecord::Type` objects. See `active_record/connection_adapters/sqlserver/type` dir.
+* Aliased `ActiveRecord::Type::SQLServer` to `ActiveRecord::ConnectionAdapters::SQLServer::Type`
+* New `SQLServer::Utils::Name` object for decomposing and quoting SQL Server names/identifiers.
+* Support for most all SQL Server types in schema statements and dumping.
+* Support create table with query from relation or select statement.
+
+#### Changed
+
+* The `create_database` now takes an options hash. Only key/value now is `collation`. Unknown keys just use raw values for SQL.
+* Complete rewrite of our Arel visitor. Focuing on 2012 and upward so we can make FETCH happen.
+* Testing enhancements.
+  * Guard support, check our Guardfile.
+  * Use `ARTest` namespace with `SQLServer` module for our helpers/objects.
+  * Simple 2012 schmea addition and extensive column/type_cast object tests.
+* Follow Rails convention and remove varying character default limits.
+* The `cs_equality_operator` is now s class configuration property only.
+* The `with_identity_insert_enabled(table_name)` is now public.
+* Use ActiveRecord tranasaction interface vs our own `run_with_isolation_level`.
+* Turn on bulk `supports_bulk_alter?`.
+
+#### Deprecated
+
+* n/a
+
+#### Removed
+
+* SQL Server versions < 2012 which do not support OFFSET and FETCH. http://bit.ly/1B5Bwsd
+* The `enable_default_unicode_types` option. Default to national types all the time.
+* Native type configs for older DB support. Includes the following with new default value:
+  * native_string_database_type => `nvarchar`
+  * native_text_database_type   => `nvarchar(max)`
+  * native_binary_database_type => `varbinary(max)`
+* Various version and inspection methods removed. These include:
+  * database_version
+  * database_year
+  * product_level
+  * product_version
+  * edition
+* Removed tests for old issue #164. Handled by core types now.
+* The `activity_stats` method. Please put this in a gem if needed.
+* We no longer use regular expressions to fix identity inserts. Use ActiveRecord or public ID insert helper.
+* All auto reconnect and SQL retry logic. Got too complicated and stood in the way of AR's pool. Speed boost too.
+* The adapter will no longer try to remove duplicate order by clauses. Use relation `reorder`, `unscope`, etc.
+* We no longer use regular expressions to remove identity columns from updates. Now with `attributes_for_update` AR hook.
+
+#### Fixed
+
+* Default lock is now "WITH(UPDLOCK)". Fixes #368
+* Better bind types & params for `sp_executesql`. Fixes #239.
+
+#### Security
+
+* The connection's `inspect` method no longer returns sensitive connection info. Very basic now.
+
+

data/Gemfile

@@ -0,0 +1,45 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'bcrypt'
+
+if RbConfig::CONFIG["host_os"] =~ /darwin/
+  gem 'terminal-notifier-guard'
+end
+
+if ENV['RAILS_SOURCE']
+  gemspec path: ENV['RAILS_SOURCE']
+else
+  # Need to get rails source beacause the gem doesn't include tests
+  version = ENV['RAILS_VERSION'] || begin
+    require 'net/http'
+    require 'yaml'
+    spec = eval(File.read('activerecord-sqlserver-adapter.gemspec'))
+    version = spec.dependencies.detect{ |d|d.name == 'activerecord' }.requirement.requirements.first.last.version
+    major, minor, tiny = version.split('.')
+    uri = URI.parse "http://rubygems.org/api/v1/versions/activerecord.yaml"
+    YAML.load(Net::HTTP.get(uri)).select do |data|
+      a, b, c = data['number'].split('.')
+      !data['prerelease'] && major == a && (minor.nil? || minor == b)
+    end.first['number']
+  end
+  gem 'rails', git: "git://github.com/rails/rails.git", tag: "v#{version}"
+end
+
+if ENV['AREL']
+  gem 'arel', path: ENV['AREL']
+end
+
+group :tinytds do
+  if ENV['TINYTDS_SOURCE']
+    gem 'tiny_tds', path: ENV['TINYTDS_SOURCE']
+  else
+    # TODO: [Rails4] Change back... segfault caused by tiny_tds 0.6.1
+    gem 'tiny_tds', git:"https://github.com/rails-sqlserver/tiny_tds.git"
+  end
+end
+
+group :odbc do
+  gem 'ruby-odbc'
+end
+

data/Guardfile

@@ -0,0 +1,29 @@
+
+require_relative 'test/support/paths_sqlserver'
+
+clearing :on
+notification :terminal_notifier if defined?(TerminalNotifier)
+ignore %r{debug\.log}
+
+ar_lib  = File.join ARTest::SQLServer.root_activerecord, 'lib'
+ar_test = File.join ARTest::SQLServer.root_activerecord, 'test'
+
+guard :minitest, {
+  all_on_start: false,
+  autorun: false,
+  include: ['lib', 'test', ar_lib, ar_test],
+  test_folders: ['test'],
+  test_file_patterns: ["*_test.rb", "*_test_sqlserver.rb"]
+} do
+  # Our project watchers.
+  if ENV['TEST_FILES']
+    ENV['TEST_FILES'].split(',').map(&:strip).each do |file|
+      watch(%r{.*}) { file }
+    end
+  else
+    watch(%r{^test/cases/\w+_test_sqlserver\.rb$})
+    watch(%r{^test/cases/coerced_tests\.rb$}) { "test/cases/coerced_tests.rb" }
+    watch(%r{^lib/active_record/connection_adapters/sqlserver/([^/]+)\.rb$})  { |m| "test/cases/#{m[1]}_test_sqlserver.rb" }
+    watch(%r{^test/cases/helper_sqlserver\.rb$}) { 'test' }
+  end
+end

data/MIT-LICENSE

@@ -1,5 +1,5 @@
-Copyright (c) 2008-2011
- 
+Copyright (c) 2008-2015
+
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
 "Software"), to deal in the Software without restriction, including
@@ -7,14 +7,14 @@ without limitation the rights to use, copy, modify, merge, publish,
 distribute, sublicense, and/or sell copies of the Software, and to
 permit persons to whom the Software is furnished to do so, subject to
 the following conditions:
- 
+
 The above copyright notice and this permission notice shall be
 included in all copies or substantial portions of the Software.
- 
+
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,193 @@
+
+# ActiveRecord SQL Server Adapter. For SQL Server 2012 And Higher.
+
+[![Gem Version](http://img.shields.io/gem/v/activerecord-sqlserver-adapter.svg?style=flat)](https://rubygems.org/gems/activerecord-sqlserver-adapter)
+[![Gitter chat](https://img.shields.io/badge/%E2%8A%AA%20GITTER%20-JOIN%20CHAT%20%E2%86%92-brightgreen.svg?style=flat)](https://gitter.im/rails-sqlserver/activerecord-sqlserver-adapter)
+
+![kantishna-wide](https://cloud.githubusercontent.com/assets/2381/5895051/aa6a57e0-a4e1-11e4-95b9-23627af5876a.jpg)
+
+## 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
+
+
+#### Executing Stored Procedures
+
+Every class that sub classes ActiveRecord::Base will now have an execute_procedure class method to use. This method takes the name of the stored procedure which can be a string or symbol and any number of variables to pass to the procedure. Arguments will automatically be quoted per the connection's standards as normal. For example:
+
+```ruby
+Account.execute_procedure :update_totals, 'admin', nil, true
+# Or with named parameters.
+Account.execute_procedure :update_totals, named: 'params'
+```
+
+
+#### Native Data Type Support
+
+We support every data type supported by FreeTDS and then a few more. All simplified Rails types in migrations will coorespond to a matching SQL Server national data type. Here is a basic chart. Always check the `initialize_native_database_types` method for an updated list.
+
+```ruby
+integer:      { name: 'int', limit: 4 }
+bigint:       { name: 'bigint' }
+boolean:      { name: 'bit' }
+decimal:      { name: 'decimal' }
+money:        { name: 'money' }
+smallmoney:   { name: 'smallmoney' }
+float:        { name: 'float' }
+real:         { name: 'real' }
+date:         { name: 'date' }
+datetime:     { name: 'datetime' }
+timestamp:    { name: 'datetime' }
+time:         { name: 'time' }
+char:         { name: 'char' }
+varchar:      { name: 'varchar', limit: 8000 }
+varchar_max:  { name: 'varchar(max)' }
+text_basic:   { name: 'text' }
+nchar:        { name: 'nchar' }
+string:       { name: 'nvarchar', limit: 4000 }
+text:         { name: 'nvarchar(max)' }
+ntext:        { name: 'ntext' }
+binary_basic: { name: 'binary' }
+varbinary:    { name: 'varbinary', limit: 8000 }
+binary:       { name: 'varbinary(max)' }
+uuid:         { name: 'uniqueidentifier' }
+ss_timestamp: { name: 'timestamp' }
+```
+
+
+#### Force Schema To Lowercase
+
+Although it is not necessary, the Ruby convention is to use lowercase method names. If your database schema is in upper or mixed case, we can force all table and column names during the schema reflection process to be lowercase. Add this to your config/initializers file for the adapter.
+
+```ruby
+ActiveRecord::ConnectionAdapters::SQLServerAdapter.lowercase_schema_reflection = true
+```
+
+
+#### Schemas & Users
+
+Depending on your user and schema setup, it may be needed to use a table name prefix of `dbo.`. So something like this in your initializer file for ActiveRecord or the adapter.
+
+```ruby
+ActiveRecord::Base.table_name_prefix = 'dbo.'
+```
+
+
+#### Configure Connection & App Name
+
+We currently conform to an unpublished and non-standard AbstractAdapter interface to configure connections made to the database. To do so, just override the `configure_connection` method in an initializer like so. In this case below we are setting the `TEXTSIZE` to 64 megabytes. Also, TinyTDS supports an application name when it logs into SQL Server. This can be used to identify the connection in SQL Server's activity monitor. By default it will use the `appname` from your database.yml file or a lowercased version of your Rails::Application name. It is now possible to define a `configure_application_name` method that can give you per instance details. Below shows how you might use this to get the process id and thread id of the current connection.
+
+```ruby
+module ActiveRecord
+  module ConnectionAdapters
+    class SQLServerAdapter < AbstractAdapter
+
+      def configure_connection
+        raw_connection_do "SET TEXTSIZE #{64.megabytes}"
+      end
+
+      def configure_application_name
+        "myapp_#{$$}_#{Thread.current.object_id}".to(29)
+      end
+
+    end
+  end
+end
+```
+
+#### Explain Support (SHOWPLAN)
+
+The 3.2 version of the adapter support ActiveRecord's explain features. In SQL Server, this is called the showplan. By default we use the `SHOWPLAN_ALL` option and format it using a simple table printer. So the following ruby would log the plan table below it.
+
+```ruby
+Car.where(id: 1).explain
+```
+
+```
+EXPLAIN for: SELECT [cars].* FROM [cars] WHERE [cars].[id] = 1
++----------------------------------------------------+--------+--------+--------+----------------------+----------------------+----------------------------------------------------+----------------------------------------------------+--------------+---------------------+----------------------+------------+---------------------+----------------------------------------------------+----------+----------+----------+--------------------+
+| StmtText                                           | StmtId | NodeId | Parent | PhysicalOp           | LogicalOp            | Argument                                           | DefinedValues                                      | EstimateRows | EstimateIO          | EstimateCPU          | AvgRowSize | TotalSubtreeCost    | OutputList                                         | Warnings | Type     | Parallel | EstimateExecutions |
++----------------------------------------------------+--------+--------+--------+----------------------+----------------------+----------------------------------------------------+----------------------------------------------------+--------------+---------------------+----------------------+------------+---------------------+----------------------------------------------------+----------+----------+----------+--------------------+
+| SELECT [cars].* FROM [cars] WHERE [cars].[id] = 1  |      1 |      1 |      0 | NULL                 | NULL                 | 2                                                  | NULL                                               |          1.0 | NULL                | NULL                 | NULL       | 0.00328309996984899 | NULL                                               | NULL     | SELECT   | false    | NULL               |
+|   |--Clustered Index Seek(OBJECT:([activerecord... |      1 |      2 |      1 | Clustered Index Seek | Clustered Index Seek | OBJECT:([activerecord_unittest].[dbo].[cars].[P... | [activerecord_unittest].[dbo].[cars].[id], [act... |          1.0 | 0.00312500004656613 | 0.000158099996042438 |        278 | 0.00328309996984899 | [activerecord_unittest].[dbo].[cars].[id], [act... | NULL     | PLAN_ROW | false    |                1.0 |
++----------------------------------------------------+--------+--------+--------+----------------------+----------------------+----------------------------------------------------+----------------------------------------------------+--------------+---------------------+----------------------+------------+---------------------+----------------------------------------------------+----------+----------+----------+--------------------+
+```
+
+You can configure a few options to your needs. First is the max column width for the logged table. The default value is 50 characters. You can change it like so.
+
+```ruby
+ActiveRecord::ConnectionAdapters::SQLServer::Showplan::PrinterTable.max_column_width = 500
+```
+
+Another configuration is the showplan option. Some might find the XML format more useful. If you have Nokogiri installed, we will format the XML string. I will gladly accept pathches that make the XML printer more useful!
+
+```ruby
+ActiveRecord::ConnectionAdapters::SQLServerAdapter.showplan_option = 'SHOWPLAN_XML'
+```
+**NOTE:** The method we utilize to make SHOWPLANs work is very brittle to complex SQL. There is no getting around this as we have to deconstruct an already prepared statement for the sp_executesql method. If you find that explain breaks your app, simple disable it. Do not open a github issue unless you have a patch.  Please [consult the Rails guides](http://guides.rubyonrails.org/active_record_querying.html#running-explain) for more info.
+
+
+## Versions
+
+The adapter follows a rational versioning policy that also tracks ActiveRecord's major and minor version. That means the latest 3.1.x version of the adapter will always work for the latest 3.1.x version of ActiveRecord.
+
+
+## Installation
+
+The adapter has no strict gem dependencies outside of ActiveRecord. You will have to pick a connection mode, the default is dblib which uses the TinyTDS gem. Just bundle the gem and the adapter will use it.
+
+```ruby
+gem 'tiny_tds'
+gem 'activerecord-sqlserver-adapter', '~> 4.2.0'
+```
+
+If you want to use ruby ODBC, please use the latest least. 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
+
+
+## Contributing
+
+If you would 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 Gitter, 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/activerecord-sqlserver-adapter
+* Gitter: https://gitter.im/rails-sqlserver/activerecord-sqlserver-adapter
+
+
+## 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.
+
+
+## Contributers
+Up-to-date list of contributors: http://github.com/rails-sqlserver/activerecord-sqlserver-adapter/contributors
+
+* metaskills (Ken Collins)
+* Annaswims (Annaswims)
+* wbond (Will Bond)
+* Thirdshift (Garrett Hart)
+* h-lame (Murray Steele)
+* vegantech
+* cjheath (Clifford Heath)
+* fryguy (Jason Frey)
+* jrafanie (Joe Rafaniello)
+* nerdrew (Andrew Ryan)
+* snowblink (Jonathan Lim)
+* koppen (Jakob Skjerning)
+* ebryn (Erik Bryn)
+* adzap (Adam Meehan)
+* neomindryan (Ryan Findley)
+* jeremydurham (Jeremy Durham)
+
+
+## License
+
+Copyright © 2008-2015. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.
+

data/RUNNING_UNIT_TESTS.md

@@ -0,0 +1,95 @@
+
+# How To Run The Test!
+
+This process is much easier than it has been before!
+
+
+## TL;DR
+
+Default testing uses DBLIB with TinyTDS.
+
+* Setup two databases in SQL Server, [activerecord_unittest] and [activerecord_unittest2]
+* Create a [rails] user with an empty password and give it a [db_owner] role to both DBs. Some tests require a server role of [sysadmin] too.
+  - http://twitpic.com/9bsiyp/full
+  - http://twitpic.com/9bsj7z/full
+  - http://twitpic.com/9bsjdx/full
+  - http://twitpic.com/9bsjl7/full
+* $ bundle install
+* $ bundle exec rake test ACTIVERECORD_UNITTEST_HOST='my.db.net'
+
+
+## Creating the test databases
+
+The default names for the test databases are `activerecord_unittest` and `activerecord_unittest2`. If you want to use another database name then be sure to update the connection file that matches your connection method in test/connections/native_sqlserver_#{connection_method}/connection.rb. Define a user named 'rails' in SQL Server with all privileges granted for the test databases. Use an empty password for said user.
+
+The connection files make certain assumptions. For instance, the ODBC connection assumes you have a DSN setup that matches the name of the default database names. Remember too you have to set an environment variable for the DSN of the adapter, see the connection.rb file that matches your connection mode for details.
+
+
+## Cloning The Repos
+
+The tests of this adapter depend on the existence of the Rails which are automatically cloned for you with bundler. However you can clone Rails from git://github.com/rails/rails.git and set the `RAILS_SOURCE` environment variable so bundler will use another local path instead.
+
+```
+$ git clone git://github.com/rails-sqlserver/activerecord-sqlserver-adapter.git
+```
+
+Suggest just letting bundler do all the work and assuming there is a git tag for the Rails version, you can set `RAILS_VERSION` before bundling.
+
+```
+$ export RAILS_VERSION='4.2.0'
+$ bundle install
+```
+
+
+## Configure DB Connection
+
+Please consult the `test/config.yml` file which is used to parse the configuration options for the DB connections when running tests. This file has overrides for any connection mode that you can set using simple environment variables. Assuming you are using FreeTDS 0.91 and above
+
+```
+$ export ACTIVERECORD_UNITTEST_HOST='my.db.net'   # Defaults to localhost
+$ export ACTIVERECORD_UNITTEST_PORT='1533'        # Defaults to 1433
+```
+
+If you have FreeTDS installed and/or want to use a named dataserver in your freetds.conf file
+
+```
+$ export ACTIVERECORD_UNITTEST_DATASERVER='mydbname'
+```
+
+These can be passed down to rake too.
+
+```
+$ bundle exec rake test ACTIVERECORD_UNITTEST_HOST='my.db.net'
+```
+
+
+## Bundling
+
+Now with that out of the way you can run "bundle install" to hook everything up. Our tests use bundler to setup the load paths correctly. The default mode is DBLIB using TinyTDS. It is important to use bundle exec so we can wire up the ActiveRecord test libs correctly.
+
+```
+$ bundle exec rake test
+```
+
+
+## Testing Options
+
+The Gemfile contains groups for `:tinytds` and `:odbc`. By default it will install both gems  which allows you to run the full test suite in either connection mode. If for some reason any one of these is problematic or of no concern, you could always opt out of bundling either gem with something like this.
+
+```
+$ bundle install --without odbc
+```
+
+You can run different connection modes using the following rake commands. Again, the DBLIB connection mode using TinyTDS is the default test task.
+
+```
+$ bundle exec rake test:dblib
+$ bundle exec rake test:odbc
+```
+
+By default, Bundler will download the Rails git repo and use the git tag that matches the dependency version in our gemspec. If you want to test another version of Rails, you can either temporarily change the :tag for Rails in the Gemfile. Likewise, you can clone the Rails repo your self to another directory and use the `RAILS_SOURCE` environment variable.
+
+
+## Current Expected Failures
+
+* Misc Date/Time erros when using ODBC mode.