tiny_tds 0.4.3 → 0.4.4

data/.gitignore

@@ -0,0 +1,17 @@
+Makefile
+*.dSYM
+*.o
+*.bundle
+*.so
+*.a
+*.rbc
+mkmf.log
+pkg/
+tmp
+vendor
+lib/tiny_tds/tiny_tds.rb
+.rvmrc
+Gemfile.lock
+misc
+*.gem
+ports

data/CHANGELOG

@@ -1,4 +1,9 @@
 
+* 0.4.4 *
+
+* New :host/:port connection options. Removes need for freetds.conf file.
+
+
 * 0.4.3 *
 
 * New Client#active? method to check for good connection. Always use this abstract method.

data/Gemfile

@@ -0,0 +1,18 @@
+
+source :rubygems
+
+group :development do
+  gem 'rake', '>= 0.8.7'
+  gem 'mini_portile', '0.2.1'
+  gem 'rake-compiler', '0.7.7'
+end
+
+group :test do
+  gem 'mini_shoulda'
+  gem 'activesupport', '2.3.5'
+  gem 'bench_press', '0.3.1'
+  platforms :mri_18 do
+    gem 'ruby-prof', '0.9.1'
+    gem 'ruby-debug', '0.10.3'
+  end
+end

data/NOTES

@@ -0,0 +1,14 @@
+
+TODO
+
+  * Update Readme when 0.83.dev becomes a release.
+  
+  * Client & Connection
+    - Make a #ping method that does the "SELECT 1" when not closed.
+    - Interrupt handler to cancel a bad SELECT * or long SQL. Maybe use dbsetinterrupt
+    - Integrate rb_thread_blocking_region where we can in your extension for proper threading in 1.9.2
+    
+  * Result Set
+    - See if we can make a binary string of [timestamp] type.
+
+

data/README.rdoc

@@ -14,8 +14,9 @@ The API is simple and consists of these classes:
 
 == New & Noteworthy
 
-* Works with FreeTDS 0.83.dev
+* Works with FreeTDS 0.91
 * Tested on Windows using MiniPortile & RailsInstaller.
+* New :host/:port connection options. Removes need for freetds.conf file.
 
 
 == Install
@@ -30,7 +31,7 @@ Although we search for FreeTDS's libraries and headers, you may have to specify
 
 == FreeTDS Compatibility
 
-TinyTDS is developed for FreeTDS 0.82 & 0.83.dev. It is tested with SQL Server 2000, 2005, 2008 and Azure using TDS Version 8.0. We utilize FreeTDS's db-lib client library. We compile against sybdb.h, undefine MSDBLIB and define SYBDBLIB which means that internally we conform to sybase API to db-lib. TinyTDS will work for both Sybase & Miscrosoft SQL Server. You do NOT need to compile FreeTDS with the "--enable-msdblib" option for our client to work properly. However, please make sure to compile FreeTDS with libiconv support for encodings to work at their best. Run "tsql -C" in your console and check for "iconv library: yes".
+TinyTDS is developed for FreeTDS 0.82 & 0.91. It is tested with SQL Server 2000, 2005, 2008 and Azure using TDS Version 8.0. We utilize FreeTDS's db-lib client library. We compile against sybdb.h, undefine MSDBLIB and define SYBDBLIB which means that internally we conform to sybase API to db-lib. TinyTDS will work for both Sybase & Miscrosoft SQL Server. You do NOT need to compile FreeTDS with the "--enable-msdblib" option for our client to work properly. However, please make sure to compile FreeTDS with libiconv support for encodings to work at their best. Run "tsql -C" in your console and check for "iconv library: yes".
 
 
 
@@ -51,13 +52,15 @@ Below is a list of the data types we plan to support using future versions of Fr
 
 Connect to a database.
 
-  client = TinyTds::Client.new(:username => 'sa', :password => 'secret', :dataserver => 'mytds_box')
+  client = TinyTds::Client.new(:username => 'sa', :password => 'secret', :host => 'mydb.host.net')
 
 Creating a new client takes a hash of options. For valid iconv encoding options, see the output of "iconv -l". Only a few have been tested and highly recommended to leave blank for the UTF-8 default.
 
 * :username - The database server user.
 * :password - The user password.
 * :dataserver - The name for your server as defined in freetds.conf.
+* :host - Used if :dataserver blank. Removes need for freetds.conf file.
+* :port - Defaults to 1433. Only used if :host is used.
 * :database - The default database to use.
 * :appname - Short string seen in SQL Servers process/activity window.
 * :tds_version - TDS version. Defaults to 80, not recommended to change.
@@ -222,7 +225,7 @@ By default row caching is turned on because the SQL Server adapter for ActiveRec
 
 == Using TinyTDS With Rails & The ActiveRecord SQL Server adapter.
 
-As of version 2.3.11 & 3.0.3 of the adapter, you can specify a :dblib mode in database.yml and use TinyTDS as the low level connection mode. Make sure to add a :dataserver option to that matches the name in your freetds.conf file. The SQL Server adapter can be found using the link below. Also included is a direct link to the wiki article covering common questions when using TinyTDS as the low level connection mode for the adapter.
+As of version 2.3.11 & 3.0.3 of the adapter, you can specify a :dblib mode in database.yml and use TinyTDS as the low level connection mode. The SQL Server adapter can be found using the link below. Also included is a direct link to the wiki article covering common questions when using TinyTDS as the low level connection mode for the adapter.
 
 http://github.com/rails-sqlserver/activerecord-sqlserver-adapter/wiki/Using-TinyTds
 
@@ -230,7 +233,7 @@ http://github.com/rails-sqlserver/activerecord-sqlserver-adapter/wiki/Using-Tiny
 
 == Using TinyTDS with Azure
 
-TinyTDS is fully tested with the Azure platform. You must set the :azure => true connection option when connecting. This is needed to specify the default in the login packet since Azure has no notion of "USE [database]". You must use the latest FreeTDS 0.83.dev and it must be compiled with OpenSSL.
+TinyTDS is fully tested with the Azure platform. You must set the :azure => true connection option when connecting. This is needed to specify the default database name in the login packet since Azure has no notion of "USE [database]". You must use the latest FreeTDS 0.91. FreeTDS must be compiled with OpenSSL too.
 
 
 
@@ -239,6 +242,8 @@ TinyTDS is fully tested with the Azure platform. You must set the :azure => true
 We use bundler for development. Simply run "bundle install" then "rake" to build the gem and run the unit tests. The tests assume you have created a database named "tinytdstest" accessible by a database owner named "tinytds". Before running the test rake task, you may need to define a pair of environment variables that help the client connect to your specific FreeTDS database server name and which schema (2000, 2005, 2008 or azure) to use. For example:
 
   $ rake TINYTDS_UNIT_DATASERVER=mydbserver TINYTDS_SCHEMA=sqlserver_2008
+    or
+  $ rake TINYTDS_UNIT_HOST=mydb.host.net TINYTDS_SCHEMA=sqlserver_azure
 
 If you are compiling locally using MiniPortile (the default dev setup) and you do not have a user based freetds.conf file with your dataservers, you may have to configure the locally compiled freetds.conf file. You can find it at the ports/<platform>/freetds/<version>/etc/freetds.conf path locally to your repo. In this situation you may have to set the FREETDS environment variable too this full path.
 

data/Rakefile

@@ -0,0 +1,57 @@
+# encoding: UTF-8
+require 'rake'
+require "rake/clean"
+require 'rbconfig'
+require 'rake/testtask'
+require 'rake/extensiontask'
+require "rubygems/package_task"
+
+Dir["tasks/*.rake"].sort.each { |f| load f }
+
+def test_libs
+  ['lib','test']
+end
+
+def test_files
+  Dir.glob("test/**/*_test.rb").sort
+end
+
+def gemspec
+  @clean_gemspec ||= eval(File.read(File.expand_path('../tiny_tds.gemspec', __FILE__)))
+end
+
+Rake::TestTask.new do |t|
+  t.libs = test_libs
+  t.test_files = test_files
+  t.verbose = true
+end
+
+Gem::PackageTask.new(gemspec) do |pkg|
+  pkg.need_tar = false
+  pkg.need_zip = false
+end
+
+task :compile => ["ports:freetds"] unless ENV['TINYTDS_SKIP_PORTS']
+
+Rake::ExtensionTask.new('tiny_tds', gemspec) do |ext|
+  ext.lib_dir = 'lib/tiny_tds'
+  ext.config_options << "--enable-iconv" unless ENV['TINYTDS_SKIP_PORTS']
+  # Automatically add build options to avoid need of manual input.
+  if RUBY_PLATFORM =~ /mswin|mingw/ then
+    # Define target for extension (supporting fat binaries).
+    RUBY_VERSION =~ /(\d+\.\d+)/
+    ext.lib_dir = "lib/tiny_tds/#{$1}"
+  else
+    ext.cross_compile = true
+    ext.cross_platform = ['i386-mingw32']
+    ext.cross_config_options << "--disable-lookup"
+    ext.cross_config_options << "--with-iconv-dir=#{$recipes[:libiconv].path}"
+    ext.cross_config_options << "--with-freetds-dir=#{$recipes[:freetds].path}"
+  end
+end
+
+task :build => [:clean, :compile]
+
+task :default => [:build, :test]
+
+

data/ext/tiny_tds/extconf.rb

@@ -70,9 +70,14 @@ def have_freetds?
   find_freetds_libraries_path && find_freetds_include_path
 end
 
-unless have_freetds?
-  abort "-----\nCan not find FreeTDS's db-lib or include directory.\n-----"
+if enable_config("lookup", true)
+  unless have_freetds?
+    abort "-----\nCan not find FreeTDS's db-lib or include directory.\n-----"
+  end
+else
+  unless have_freetds_libraries?(*FREETDS_LIBRARIES) && have_freetds_headers?(*FREETDS_HEADERS)
+    abort "-----\nCan not find FreeTDS's db-lib or include directory.\n-----"
+  end
 end
 
 create_makefile('tiny_tds/tiny_tds')
-

data/lib/tiny_tds.rb

@@ -3,16 +3,17 @@ require 'date'
 require 'bigdecimal'
 require 'rational' unless RUBY_VERSION >= '1.9.2'
 
+require 'tiny_tds/version'
 require 'tiny_tds/error'
 require 'tiny_tds/client'
 require 'tiny_tds/result'
 
-require 'tiny_tds/tiny_tds'
+# support multiple ruby version (fat binaries under windows)
+begin
+  RUBY_VERSION =~ /(\d+.\d+)/
+  require "tiny_tds/#{$1}/tiny_tds"
+rescue LoadError
+  require 'tiny_tds/tiny_tds'
+end
 
 
-# = TinyTds
-#
-# Tiny Ruby Wrapper For FreeTDS Using DB-Library
-module TinyTds
-  VERSION = '0.4.3'
-end

data/lib/tiny_tds/client.rb

@@ -47,13 +47,20 @@ module TinyTds
 
 
     def initialize(opts={})
-      raise ArgumentError, 'missing :username option' if opts[:username].nil? || opts[:username].empty?
+      raise ArgumentError, 'missing :username option' if opts[:username].to_s.empty?
+      raise ArgumentError, 'missing :host option if no :dataserver given' if opts[:dataserver].to_s.empty? && opts[:host].to_s.empty?
       @query_options = @@default_query_options.dup
       opts[:appname] ||= 'TinyTds'
       opts[:tds_version] = TDS_VERSIONS_SETTERS[opts[:tds_version].to_s] || TDS_VERSIONS_SETTERS['80']
       opts[:login_timeout] ||= 60
       opts[:timeout] ||= 5
       opts[:encoding] = (opts[:encoding].nil? || opts[:encoding].downcase == 'utf8') ? 'UTF-8' : opts[:encoding].upcase
+      opts[:port] ||= 1433
+      ENV['TDSPORT'] = opts[:port].to_s
+      if opts[:dataserver].to_s.empty?
+        opts[:dataserver] = ''
+        ENV['TDSHOST'] = opts[:host].to_s
+      end
       connect(opts)
     end
     

data/lib/tiny_tds/version.rb

@@ -0,0 +1,3 @@
+module TinyTds
+  VERSION = '0.4.4'
+end

data/tasks/ports.rake

@@ -0,0 +1,59 @@
+require "mini_portile"
+require "rake/extensioncompiler"
+
+namespace :ports do
+
+  ICONV_VERSION = "1.13.1"
+  FREETDS_VERSION = ENV['TINYTDS_FREETDS_082'] ? "0.82" : "0.91"
+  FREETDS_VERSION_INFO = {
+    "0.82" => {:files => "http://ibiblio.org/pub/Linux/ALPHA/freetds/stable/freetds-stable.tgz"},
+    "0.91" => {:files => "http://www.ibiblio.org/pub/Linux/ALPHA/freetds/current/freetds-current.tgz"} }
+
+  ORIGINAL_HOST = RbConfig::CONFIG["arch"]
+
+  directory "ports"
+
+  $recipes = {}
+  $recipes[:libiconv] = MiniPortile.new "libiconv", ICONV_VERSION
+  $recipes[:libiconv].files << "http://ftp.gnu.org/pub/gnu/libiconv/libiconv-#{ICONV_VERSION}.tar.gz"
+
+  $recipes[:freetds] = MiniPortile.new "freetds", FREETDS_VERSION
+  $recipes[:freetds].files << FREETDS_VERSION_INFO[FREETDS_VERSION][:files]
+
+  desc "Compile libiconv support library"
+  task :libiconv => ["ports"] do
+    recipe = $recipes[:libiconv]
+    checkpoint = "ports/.#{recipe.name}.#{recipe.version}.#{recipe.host}.timestamp"
+    unless File.exist?(checkpoint)
+      recipe.cook
+      touch checkpoint
+    end
+    recipe.activate
+  end
+
+  desc "Compile freetds library"
+  task :freetds => ["ports", :libiconv] do
+    recipe = $recipes[:freetds]
+    checkpoint = "ports/.#{recipe.name}.#{recipe.version}.#{recipe.host}.timestamp"
+    unless File.exist?(checkpoint)
+      recipe.configure_options << "--disable-odbc"
+      recipe.configure_options << "--with-tdsver=7.1"
+      # HACK: Only do this when cross compiling (util MiniPortile#activate gets the job done)
+      unless recipe.host == ORIGINAL_HOST
+        recipe.configure_options << "--with-libiconv-prefix=#{$recipes[:libiconv].path}"
+      end
+      recipe.cook
+      touch checkpoint
+    end
+    recipe.activate
+  end
+
+end
+
+task :cross do
+  host = ENV.fetch("HOST", Rake::ExtensionCompiler.mingw_host)
+  $recipes.each do |_, recipe|
+    recipe.host = host
+  end
+end
+

data/test/benchmark/query.rb

@@ -0,0 +1,77 @@
+$:.unshift File.expand_path('../../../lib',__FILE__)
+require 'rubygems'
+require 'bench_press'
+require 'tiny_tds'
+require 'odbc'
+require 'odbc_utf8'
+
+extend BenchPress
+
+author 'Ken Collins'
+summary 'Query everything.'
+
+reps 1_000
+
+@odbc = ODBC.connect ENV['TINYTDS_UNIT_DATASERVER'], 'tinytds', ''
+@odbc.use_time = true
+
+@odbc_utf8 = ODBC_UTF8.connect ENV['TINYTDS_UNIT_DATASERVER'], 'tinytds', ''
+@odbc_utf8.use_time = true
+
+@tinytds = TinyTds::Client.new(
+  :dataserver    => ENV['TINYTDS_UNIT_DATASERVER'],
+  :username      => 'tinytds',
+  :password      => '',
+  :database      => 'tinytdstest',
+  :appname       => 'TinyTds Dev',
+  :login_timeout => 5,
+  :timeout       => 5 )
+
+@query_all = "SELECT * FROM [datatypes]"
+
+
+measure "ODBC (ascii-8bit)" do
+  h = @odbc.run(@query_all)
+  h.fetch_all
+  h.drop
+end
+
+# measure "ODBC (utf8)" do
+#   h = @odbc_utf8.run(@query_all)
+#   h.fetch_all
+#   h.drop
+# end
+
+measure "TinyTDS (row caching)" do
+  @tinytds.execute(@query_all).each
+end
+
+measure "TinyTDS (no caching)" do
+  @tinytds.execute(@query_all).each(:cache_rows => false)
+end
+
+
+
+=begin
+
+Author: Ken Collins  
+Date: January 22, 2011  
+Summary: Query everything.  
+
+System Information
+------------------
+    Operating System:    Mac OS X 10.6.6 (10J567)
+    CPU:                 Intel Core 2 Duo 1.6 GHz
+    Processor Count:     2
+    Memory:              4 GB
+    ruby 1.8.7 (2010-04-19 patchlevel 253) [i686-darwin10.4.3], MBARI 0x6770, Ruby Enterprise Edition 2010.02
+
+"TinyTDS (row caching)" is up to 79% faster over 1,000 repetitions
+------------------------------------------------------------------
+
+    TinyTDS (row caching)    4.90862512588501 secs    Fastest
+    TinyTDS (no caching)     4.91626906394958 secs    0% Slower
+    ODBC (ascii-8bit)        23.959536075592  secs    79% Slower
+
+=end
+

data/test/benchmark/query_odbc.rb

@@ -0,0 +1,106 @@
+require 'rubygems'
+require 'bench_press'
+begin gem 'odbc', '0.99992' ; rescue Gem::LoadError ; end
+require 'odbc'
+
+extend BenchPress
+
+author 'Ken Collins'
+summary 'Benchmarking ODBC Querys'
+
+reps 1_000
+
+@client = ODBC.connect ENV['TINYTDS_UNIT_DATASERVER'], 'tinytds', ''
+@client.use_time = true
+
+@query_nothing  = "SELECT NULL AS [null]"
+@query_ints     = "SELECT [int], [bigint], [smallint], [tinyint] FROM [datatypes]"
+@query_binaries = "SELECT [binary_50], [image], [varbinary_50] FROM [datatypes]"
+@query_bits     = "SELECT [bit] FROM [datatypes]"
+@query_chars    = "SELECT [char_10], [nchar_10], [ntext], [nvarchar_50], [text], [varchar_50] FROM [datatypes]"
+@query_dates    = "SELECT [datetime], [smalldatetime] FROM [datatypes]"
+@query_decimals = "SELECT [decimal_9_2], [decimal_16_4], [numeric_18_0], [numeric_36_2] FROM [datatypes]"
+@query_floats   = "SELECT [float], [real] FROM [datatypes]"
+@query_moneys   = "SELECT [money], [smallmoney] FROM [datatypes]"
+@query_guids    = "SELECT [uniqueidentifier] FROM [datatypes]"
+@query_all      = "SELECT * FROM [datatypes]"
+
+def select_all(query)
+  h = @client.run(query)
+  h.fetch_all
+  h.drop
+end
+
+
+measure "Nothing" do
+  select_all @query_nothing
+end
+
+measure "Integers" do
+  select_all @query_ints
+end
+
+measure "Binaries" do
+  select_all @query_binaries
+end
+
+measure "Bits" do
+  select_all @query_bits
+end
+
+measure "Chars" do
+  select_all @query_chars
+end
+
+measure "Dates" do
+  select_all @query_dates
+end
+
+measure "Decimals" do
+  select_all @query_decimals
+end
+
+measure "Floats" do
+  select_all @query_floats
+end
+
+measure "Moneys" do
+  select_all @query_moneys
+end
+
+measure "Guids" do
+  select_all @query_guids
+end
+
+measure "All" do
+  select_all @query_all
+end
+
+
+=begin
+
+System Information
+------------------
+    Operating System:    Mac OS X 10.6.4 (10F569)
+    CPU:                 Intel Core 2 Duo 2.4 GHz
+    Processor Count:     2
+    Memory:              4 GB
+    ruby 1.8.7 (2010-08-16 patchlevel 302) [i686-darwin10.4.0]
+
+"Nothing" is up to 98% faster over 1,000 repetitions
+----------------------------------------------------
+
+    Nothing     0.297961950302124 secs    Fastest
+    Bits        0.377611875534058 secs    21% Slower
+    Guids       0.381000995635986 secs    21% Slower
+    Moneys      0.405518054962158 secs    26% Slower
+    Floats      0.409428119659424 secs    27% Slower
+    Integers    0.448167085647583 secs    33% Slower
+    Decimals    0.471596956253052 secs    36% Slower
+    Dates       0.52501106262207  secs    43% Slower
+    Binaries    3.66349482536316  secs    91% Slower
+    Chars       6.82928085327148  secs    95% Slower
+    All         28.4982612133026  secs    98% Slower
+
+=end
+