ar-sybase-jdbc-adapter 0.2.0 → 0.2.2

data/README.rdoc

@@ -1,15 +1,16 @@
 = ar-sybase-jdbc-adapter
 
-ar-sybase-jdbc-adapter enhances activerecord-jdbc-adapter (Rails 3) to support "limit" and "offset" for Sybase ASE DB.
+ar-sybase-jdbc-adapter enhances activerecord-jdbc-adapter (Rails 3) to support <tt>.limit</tt> and <tt>offset</tt> for Sybase ASE DB.
 
-**This project is a proof of concept that Sybase ASE can work nicely with Rails**
-Once the project reaches "close to production" functionality I will try to merge it with activerecord-jdbc-adapter
+At the moment Sybase ASE version 15 or grater is required. If you need it work for ASE version 12, please open an Issue[https://github.com/arkadiyk/ar-sybase-jdbc-adapter/issues]
 
+<em>This project is a proof of concept that Sybase ASE can work nicely with Rails</em>. Once the project reaches "close to production" functionality I will try to merge it with activerecord-jdbc-adapter
+
+If you have any issues with the adapter please add an Issue[https://github.com/arkadiyk/ar-sybase-jdbc-adapter/issues]  or fork the project and send a pull request.
 
 == Usage
 1. Install
-
-    gem install ar-sybase-jdbc-adapter
+  gem install ar-sybase-jdbc-adapter
 
 2. Configuration
 To use this gem, set the "dialect" configuration parameter to "sybase_jtds".
@@ -24,22 +25,19 @@ Example:
       driver: net.sourceforge.jtds.jdbc.Driver
       url: jdbc:jtds:sybase://host:port/db_name
 
+== Implementation notes
+If <tt>.limit</tt> with no <tt>.offset</tt> or <tt>.count</tt> methods is used, the adapter simply adds "TOP" keyword to SQL and sends it to the Sybase server:
+  User.limit(10)
+produces:
+  SELECT TOP 10 users.* FROM users
 
-== Offset in Sybase ASE
-
-Sybase is an awful DB in term of support for "offset". I found 2 ways to do it for generic queries:
-
-=== 1. Use TempTables:
-
-    select top <limit + offset> * into #tt from (<original query with NO order by>) t ORDER BY <original order> ASC
-    select top <limit> * from #tt into #tt_sorted ORDER BY <original order> DESC
-    select * from #tt_sorted ORDER BY <original order>
-
-There are 2 major drawbacks here. 
-1. If the offset is a large number, the space taken by the temptable can fill up the tempdb. 
-2. The original query should be parsed to strip out "ORDER BY"
+The adapter has to rely on Java code to implement <tt>.offset</tt> or when <tt>.count</tt> is used together with <tt>.offset</tt> or <tt>.limit</tt>. In this case adapter will generate SQL like it was MySQL query:
+  User.limit(10).offset(20)
+produces
+  SELECT  users.* FROM users LIMIT 10 OFFSET 21
+This can be confusing if you are looking at the log file.
 
-=== 2. Use a scrollable cursor:
+Java layer parses the SQL and executes it as multistep scrollable cursor query:
 
     declare crsr  insensitive scroll cursor for
         select * from <original query>
@@ -52,40 +50,15 @@ There are 2 major drawbacks here.
     close crsr
     deallocate crsr
 
-The problems here are: 
-1. Scrollable cursor works for Sybase ASE starting from version 15. 
-2. Cursors are not very efficient in Sybase ASE, and very inefficient in Sybase IQ.
-
-I am not a Sybase expert, so *Please let me know if you are aware of more efficient ways to do limit and offset.*
-
-== Limit and Count in Sybase ASE
-
-There is another interesting issue with Sybase DB I have just discovered. To implement "limit" I add "TOP <limit>" to the
-query and it works fine. To check how many records this query returns the obvios thing is to run something like
-
-    select count(*) from (select top 10  * from table_name) t      -- DOES NOT WORK!
-
-But it does not work! The result of this query will be total number of rows in the table. So the only solution will be to
-fall back to `cursor` and get `@@rowcount` to get the number of rows.
 
-    declare crsr  insensitive scroll cursor for
-        select * from <original query>
-    go
-    open crsr
-
-    set cursor rows <limit> for crsr
-    fetch absolute <offset> from crsr
-
-    select @@rowcount
-
-    close crsr
-    deallocate crsr
+Unfortunately this approach is not very efficient for very large OFFSET values. Also scrollable cursor works for Sybase ASE starting from version 15.
 
+I am not a Sybase expert, so <em>Please let me know if you are aware of more efficient ways to do limit and offset.</em>
 
 
 == Known issues
 
-I am aware of a very strange issue where the driver does not work when the very first query uses "limit()".
+I am aware of a very strange issue where the adapter does not work when the very first query uses "limit()".
 
 e.g.
     $ rails c
@@ -93,7 +66,7 @@ e.g.
     irb(main):001:0> Client.limit(10).to_sql
     => "SELECT clients.* FROM clients LIMIT 10"
 
-Otherwise, the driver works fine by adding the "TOP" keyword to your SQL query:
+Otherwise, the adapter works fine by adding the "TOP" keyword to your SQL query:
 
 e.g.
     $ rails c

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: ar-sybase-jdbc-adapter
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-    - 0
-    - 2
-    - 0
-  version: 0.2.0
+  prerelease: 
+  version: 0.2.2
 platform: ruby
 authors: 
   - arkadiy kraportov
@@ -14,45 +10,38 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-17 00:00:00 +09:00
+date: 2011-06-15 00:00:00 +09:00
 default_executable: 
 dependencies: 
   - !ruby/object:Gem::Dependency 
     name: bundler
     version_requirements: &id001 !ruby/object:Gem::Requirement 
+      none: false
       requirements: 
         - - ~>
           - !ruby/object:Gem::Version 
-            segments: 
-              - 1
-              - 0
-              - 0
-            version: 1.0.0
+            version: 1.0.15
     requirement: *id001
     prerelease: false
     type: :development
   - !ruby/object:Gem::Dependency 
     name: jeweler
     version_requirements: &id002 !ruby/object:Gem::Requirement 
+      none: false
       requirements: 
         - - ~>
           - !ruby/object:Gem::Version 
-            segments: 
-              - 1
-              - 5
-              - 1
-            version: 1.5.1
+            version: 1.6.2
     requirement: *id002
     prerelease: false
     type: :development
   - !ruby/object:Gem::Dependency 
     name: rcov
     version_requirements: &id003 !ruby/object:Gem::Requirement 
+      none: false
       requirements: 
         - - ">="
           - !ruby/object:Gem::Version 
-            segments: 
-              - 0
             version: "0"
     requirement: *id003
     prerelease: false
@@ -60,11 +49,10 @@ dependencies:
   - !ruby/object:Gem::Dependency 
     name: minitest
     version_requirements: &id004 !ruby/object:Gem::Requirement 
+      none: false
       requirements: 
         - - ">="
           - !ruby/object:Gem::Version 
-            segments: 
-              - 0
             version: "0"
     requirement: *id004
     prerelease: false
@@ -72,27 +60,21 @@ dependencies:
   - !ruby/object:Gem::Dependency 
     name: arel
     version_requirements: &id005 !ruby/object:Gem::Requirement 
+      none: false
       requirements: 
-        - - "="
+        - - ~>
           - !ruby/object:Gem::Version 
-            segments: 
-              - 2
-              - 0
-              - 7
-            version: 2.0.7
+            version: 2.0.10
     requirement: *id005
     prerelease: false
     type: :development
   - !ruby/object:Gem::Dependency 
     name: activerecord-jdbc-adapter
     version_requirements: &id006 !ruby/object:Gem::Requirement 
+      none: false
       requirements: 
         - - "="
           - !ruby/object:Gem::Version 
-            segments: 
-              - 1
-              - 1
-              - 1
             version: 1.1.1
     requirement: *id006
     prerelease: false
@@ -100,27 +82,21 @@ dependencies:
   - !ruby/object:Gem::Dependency 
     name: activerecord
     version_requirements: &id007 !ruby/object:Gem::Requirement 
+      none: false
       requirements: 
-        - - ">="
+        - - ~>
           - !ruby/object:Gem::Version 
-            segments: 
-              - 3
-              - 0
-              - 3
-            version: 3.0.3
+            version: 3.0.7
     requirement: *id007
     prerelease: false
     type: :development
   - !ruby/object:Gem::Dependency 
     name: activerecord-jdbc-adapter
     version_requirements: &id008 !ruby/object:Gem::Requirement 
+      none: false
       requirements: 
-        - - ">="
+        - - ~>
           - !ruby/object:Gem::Version 
-            segments: 
-              - 1
-              - 1
-              - 1
             version: 1.1.1
     requirement: *id008
     prerelease: false
@@ -128,13 +104,10 @@ dependencies:
   - !ruby/object:Gem::Dependency 
     name: arel
     version_requirements: &id009 !ruby/object:Gem::Requirement 
+      none: false
       requirements: 
-        - - ">="
+        - - ~>
           - !ruby/object:Gem::Version 
-            segments: 
-              - 2
-              - 0
-              - 7
             version: 2.0.7
     requirement: *id009
     prerelease: false
@@ -142,11 +115,10 @@ dependencies:
   - !ruby/object:Gem::Dependency 
     name: jdbc-jtds
     version_requirements: &id010 !ruby/object:Gem::Requirement 
+      none: false
       requirements: 
         - - ">="
           - !ruby/object:Gem::Version 
-            segments: 
-              - 0
             version: "0"
     requirement: *id010
     prerelease: false
@@ -154,14 +126,11 @@ dependencies:
   - !ruby/object:Gem::Dependency 
     name: minitest
     version_requirements: &id011 !ruby/object:Gem::Requirement 
+      none: false
       requirements: 
-        - - ">="
+        - - ~>
           - !ruby/object:Gem::Version 
-            segments: 
-              - 2
-              - 0
-              - 0
-            version: 2.0.0
+            version: 2.2.2
     requirement: *id011
     prerelease: false
     type: :development
@@ -192,28 +161,26 @@ rdoc_options: []
 require_paths: 
   - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 2
         segments: 
           - 0
         version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-          - 0
         version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.5.1
 signing_key: 
 specification_version: 3
 summary: Adds support for limit and offset for Rails 3 and Sybase JDBC driver
-test_files: 
-  - test/helper.rb
-  - test/support/fake_record.rb
-  - test/test_connection.rb
-  - test/test_visitor.rb
+test_files: []
+

data/test/helper.rb

@@ -1,31 +0,0 @@
-require 'rubygems'
-require 'bundler'
-
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-
-
-require 'minitest/autorun'
-require 'fileutils'
-require 'arel'
-
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-
-require 'ar-sybase-jdbc-adapter'
-require 'support/fake_record'
-
-
-Arel::Table.engine = Arel::Sql::Engine.new(FakeRecord::Base.new)
-
-class Object
-  def must_be_like other
-    gsub(/\s+/, ' ').strip.must_equal other.gsub(/\s+/, ' ').strip
-  end
-end

data/test/support/fake_record.rb

@@ -1,91 +0,0 @@
-module FakeRecord
-  class Column < Struct.new(:name, :type)
-  end
-
-  class Connection
-    attr_reader :tables
-
-    def initialize
-      @tables = %w{ users photos developers }
-      @columns = {
-        'users' => [
-          Column.new('id', :integer),
-          Column.new('name', :string),
-          Column.new('bool', :boolean),
-          Column.new('created_at', :date),
-        ]
-      }
-      @primary_keys = {
-        'users' => 'id'
-      }
-    end
-
-    def primary_key name
-      @primary_keys[name.to_s]
-    end
-
-    def table_exists? name
-      @tables.include? name.to_s
-    end
-
-    def columns name, message = nil
-      @columns[name.to_s]
-    end
-
-    def quote_table_name name
-      "\"#{name.to_s}\""
-    end
-
-    def quote_column_name name
-      "\"#{name.to_s}\""
-    end
-
-    def quote thing, column = nil
-      if column && column.type == :integer
-        return 'NULL' if thing.nil?
-        return thing.to_i
-      end
-
-      case thing
-      when true
-        "'t'"
-      when false
-        "'f'"
-      when nil
-        'NULL'
-      when Numeric
-        thing
-      else
-        "'#{thing}'"
-      end
-    end
-  end
-
-  class ConnectionPool
-    class Spec < Struct.new(:config)
-    end
-
-    attr_reader :spec, :connection
-
-    def initialize
-      @spec = Spec.new(:adapter => 'america')
-      @connection = Connection.new
-    end
-
-    def with_connection
-      yield connection
-    end
-  end
-
-  class Base
-    attr_accessor :connection_pool
-
-    def initialize
-      @connection_pool = ConnectionPool.new
-    end
-
-    def connection
-      connection_pool.connection
-    end
-  end
-end

data/test/test_connection.rb

@@ -1,42 +0,0 @@
-require 'arjdbc'
-require 'helper'
-
-#module ActiveRecord
-#  module ConnectionAdapters
-#    class JdbcAdapter < AbstractAdapter
-#      def initialize
-#      end
-#    end
-#  end
-#end
-
-module ConnectionTests
-  class MockConnection
-    def adapter=(adapt)
-    end
-    def jndi_connection?
-      false
-    end
-  end
-
-  describe 'the sybase jtds connection' do
-    before do
-      @config = {
-        :driver =>  'net.sourceforge.jtds.Driver',
-        :url => "jdbc:jtds:sybase://test:1234/database",
-        :dialect => 'sybase_jtds'
-      }
-      @adapter = ActiveRecord::ConnectionAdapters::JdbcAdapter.new MockConnection.new, nil, @config
-    end
-
-    it "instantiate correct adapter when using 'sybase_jtds' dialect" do
-      @adapter.must_be_kind_of(::ArJdbc::SybaseJtds)
-    end
-
-    it "should configure arel2 visitors for SybaseJtds" do
-      ::Arel::Visitors::VISITORS.must_include('sybase_jtds')
-      visitor = ::Arel::Visitors::VISITORS['sybase_jtds']
-      visitor.must_equal(::Arel::Visitors::SybaseJtds)
-    end
-  end
-end

data/test/test_visitor.rb

@@ -1,60 +0,0 @@
-require 'helper'
-require 'arel/visitors/sybase_jtds'
-
-module Arel
-  module Visitors
-    describe 'the sybase jtds visitor' do
-      before do
-        @visitor = SybaseJtds.new Table.engine
-      end
-
-
-      describe Nodes::SelectStatement do
-        it "should not have 'LIMIT' keyword" do
-          stmt = Nodes::SelectStatement.new
-          stmt.cores.first.projections << 'first_field'
-          stmt.limit = 10
-          sql = @visitor.accept stmt
-          sql.wont_match /LIMIT 10/
-        end
-
-        describe 'limit with no offset and no "DISTINCT"' do
-          it 'adds a TOP keyword after "SELECT"' do
-            stmt = Nodes::SelectStatement.new
-            stmt.cores.first.projections << 'first_field'
-            stmt.limit = 10
-            sql = @visitor.accept stmt
-            sql.must_be_like %{ SELECT TOP 10 'first_field' }
-          end
-        end
-
-        describe 'limit with no offset and "DISTINCT"' do
-          it 'adds a TOP keyword after "DISTINCT"' do
-            stmt = Nodes::SelectStatement.new
-            stmt.cores.first.projections << Nodes::SqlLiteral.new('DISTINCT id')
-            stmt.limit = 10
-            sql = @visitor.accept stmt
-            sql.must_be_like %{ SELECT DISTINCT TOP 10 id }
-          end
-        end
-
-#
-#        describe 'only offset' do
-#          it 'creates a select from subquery with rownum condition' do
-#            stmt = Nodes::SelectStatement.new
-#            stmt.offset = Nodes::Offset.new(10)
-#            sql = @visitor.accept stmt
-#            sql.must_be_like %{
-#              SELECT * FROM (
-#                SELECT raw_sql_.*, rownum raw_rnum_
-#                FROM (SELECT ) raw_sql_
-#              )
-#              WHERE raw_rnum_ > 10
-#            }
-#          end
-#        end
-
-      end
-    end
-  end
-end