sequel 3.21.0 → 3.31.0

data/lib/sequel/adapters/jdbc.rb

@@ -32,47 +32,89 @@ module Sequel
     DATABASE_SETUP = {:postgresql=>proc do |db|
         Sequel.ts_require 'adapters/jdbc/postgresql'
         db.extend(Sequel::JDBC::Postgres::DatabaseMethods)
+        db.dataset_class = Sequel::JDBC::Postgres::Dataset
         JDBC.load_gem('postgres')
         org.postgresql.Driver
       end,
       :mysql=>proc do |db|
         Sequel.ts_require 'adapters/jdbc/mysql'
         db.extend(Sequel::JDBC::MySQL::DatabaseMethods)
+        db.dataset_class = Sequel::JDBC::MySQL::Dataset
         JDBC.load_gem('mysql')
         com.mysql.jdbc.Driver
       end,
       :sqlite=>proc do |db|
         Sequel.ts_require 'adapters/jdbc/sqlite'
         db.extend(Sequel::JDBC::SQLite::DatabaseMethods)
+        db.dataset_class = Sequel::JDBC::SQLite::Dataset
         JDBC.load_gem('sqlite3')
         org.sqlite.JDBC
       end,
       :oracle=>proc do |db|
         Sequel.ts_require 'adapters/jdbc/oracle'
         db.extend(Sequel::JDBC::Oracle::DatabaseMethods)
+        db.dataset_class = Sequel::JDBC::Oracle::Dataset
         Java::oracle.jdbc.driver.OracleDriver
       end,
       :sqlserver=>proc do |db|
-        Sequel.ts_require 'adapters/jdbc/mssql'
-        db.extend(Sequel::JDBC::MSSQL::DatabaseMethods)
+        Sequel.ts_require 'adapters/jdbc/sqlserver'
+        db.extend(Sequel::JDBC::SQLServer::DatabaseMethods)
+        db.dataset_class = Sequel::JDBC::SQLServer::Dataset
+        db.send(:set_mssql_unicode_strings)
         com.microsoft.sqlserver.jdbc.SQLServerDriver
       end,
       :jtds=>proc do |db|
-        Sequel.ts_require 'adapters/jdbc/mssql'
-        db.extend(Sequel::JDBC::MSSQL::DatabaseMethods)
+        Sequel.ts_require 'adapters/jdbc/jtds'
+        db.extend(Sequel::JDBC::JTDS::DatabaseMethods)
+        db.dataset_class = Sequel::JDBC::JTDS::Dataset
+        db.send(:set_mssql_unicode_strings)
         JDBC.load_gem('jtds')
         Java::net.sourceforge.jtds.jdbc.Driver
       end,
       :h2=>proc do |db|
         Sequel.ts_require 'adapters/jdbc/h2'
         db.extend(Sequel::JDBC::H2::DatabaseMethods)
+        db.dataset_class = Sequel::JDBC::H2::Dataset
         JDBC.load_gem('h2')
         org.h2.Driver
       end,
+      :hsqldb=>proc do |db|
+        Sequel.ts_require 'adapters/jdbc/hsqldb'
+        db.extend(Sequel::JDBC::HSQLDB::DatabaseMethods)
+        db.dataset_class = Sequel::JDBC::HSQLDB::Dataset
+        # Current gem is 1.8.1.3, but Sequel supports 2.2.5
+        org.hsqldb.jdbcDriver
+      end,
+      :derby=>proc do |db|
+        Sequel.ts_require 'adapters/jdbc/derby'
+        db.extend(Sequel::JDBC::Derby::DatabaseMethods)
+        db.dataset_class = Sequel::JDBC::Derby::Dataset
+        JDBC.load_gem('derby')
+        org.apache.derby.jdbc.EmbeddedDriver
+      end,
       :as400=>proc do |db|
         Sequel.ts_require 'adapters/jdbc/as400'
         db.extend(Sequel::JDBC::AS400::DatabaseMethods)
+        db.dataset_class = Sequel::JDBC::AS400::Dataset
         com.ibm.as400.access.AS400JDBCDriver
+      end,
+      :"informix-sqli"=>proc do |db|
+        Sequel.ts_require 'adapters/jdbc/informix'
+        db.extend(Sequel::JDBC::Informix::DatabaseMethods)
+        db.dataset_class = Sequel::JDBC::Informix::Dataset
+        com.informix.jdbc.IfxDriver
+      end,
+      :db2=>proc do |db|
+        Sequel.ts_require 'adapters/jdbc/db2'
+        db.extend(Sequel::JDBC::DB2::DatabaseMethods)
+        db.dataset_class = Sequel::JDBC::DB2::Dataset
+        com.ibm.db2.jcc.DB2Driver
+      end,
+      :firebirdsql=>proc do |db|
+        Sequel.ts_require 'adapters/jdbc/firebird'
+        db.extend(Sequel::JDBC::Firebird::DatabaseMethods)
+        db.dataset_class = Sequel::JDBC::Firebird::Dataset
+        org.firebirdsql.jdbc.FBDriver
       end
     }
     
@@ -101,7 +143,7 @@ module Sequel
       # True by default, can be set to false to roughly double performance when
       # fetching rows.
       attr_accessor :convert_types
-      
+
       # Call the DATABASE_SETUP proc directly after initialization,
       # so the object always uses sub adapter specific code.  Also,
       # raise an error immediately if the connection doesn't have a
@@ -158,6 +200,7 @@ module Sequel
           args = [uri(opts)]
           args.concat([opts[:user], opts[:password]]) if opts[:user] && opts[:password]
           begin
+            JavaSQL::DriverManager.setLoginTimeout(opts[:login_timeout]) if opts[:login_timeout]
             JavaSQL::DriverManager.getConnection(*args)
           rescue => e
             raise e unless driver
@@ -180,11 +223,6 @@ module Sequel
         setup_connection(conn)
       end
       
-      # Return instances of JDBC::Dataset with the given opts.
-      def dataset(opts = nil)
-        JDBC::Dataset.new(self, opts)
-      end
-      
       # Execute the given SQL.  If a block is given, if should be a SELECT
       # statement or something else that returns rows.
       def execute(sql, opts={}, &block)
@@ -246,12 +284,14 @@ module Sequel
         indexes
       end 
 
+      # Whether or not JNDI is being used for this connection.
+      def jndi?
+        !!(uri =~ JNDI_URI_REGEXP)
+      end
+      
       # All tables in this database
       def tables(opts={})
-        ts = []
-        m = output_identifier_meth
-        metadata(:getTables, nil, nil, nil, ['TABLE'].to_java(:string)){|h| ts << m.call(h[:table_name])}
-        ts
+        get_tables('TABLE', opts)
       end
       
       # The uri for this connection.  You can specify the uri
@@ -264,11 +304,11 @@ module Sequel
         ur =~ /^\Ajdbc:/ ? ur : "jdbc:#{ur}"
       end
 
-      # Whether or not JNDI is being used for this connection.
-      def jndi?
-        !!(uri =~ JNDI_URI_REGEXP)
+      # All views in this database
+      def views(opts={})
+        get_tables('VIEW', opts)
       end
-      
+
       private
          
       # Close given adapter connections
@@ -276,6 +316,12 @@ module Sequel
         c.close
       end
       
+      # Raise a disconnect error if the SQL state of the cause of the exception indicates so.
+      def disconnect_error?(exception, opts)
+        cause = exception.respond_to?(:cause) ? exception.cause : exception
+        super || (cause.respond_to?(:getSQLState) && cause.getSQLState =~ /^08/)
+      end
+
       # Execute the prepared statement.  If the provided name is a
       # dataset, use that as the prepared statement, otherwise use
       # it as a key to look it up in the prepared_statements hash.
@@ -325,6 +371,12 @@ module Sequel
         end
       end
 
+      # Gets the connection from JNDI.
+      def get_connection_from_jndi
+        jndi_name = JNDI_URI_REGEXP.match(uri)[1]
+        JavaxNaming::InitialContext.new.lookup(jndi_name).connection
+      end
+            
       # Gets the JDBC connection uri from the JNDI resource.
       def get_uri_from_jndi
         conn = get_connection_from_jndi
@@ -333,12 +385,14 @@ module Sequel
         conn.close if conn
       end
       
-      # Gets the connection from JNDI.
-      def get_connection_from_jndi
-        jndi_name = JNDI_URI_REGEXP.match(uri)[1]
-        JavaxNaming::InitialContext.new.lookup(jndi_name).connection
+      # Backbone of the tables and views support.
+      def get_tables(type, opts)
+        ts = []
+        m = output_identifier_meth
+        metadata(:getTables, nil, nil, nil, [type].to_java(:string)){|h| ts << m.call(h[:table_name])}
+        ts
       end
-            
+
       # Support Date objects used in bound variables
       def java_sql_date(date)
         java.sql.Date.new(Time.local(date.year, date.month, date.day).to_i * 1000)
@@ -383,12 +437,6 @@ module Sequel
         end
       end
 
-      # Treat SQLExceptions with a "Connection Error" SQLState as disconnects
-      def raise_error(exception, opts={})
-        cause = exception.respond_to?(:cause) ? exception.cause : exception
-        super(exception, {:disconnect => cause.respond_to?(:getSQLState) && cause.getSQLState =~ /^08/}.merge(opts))
-      end
-
       # Java being java, you need to specify the type of each argument
       # for the prepared statement, and bind it individually.  This
       # guesses which JDBC method to use, and hopefully JRuby will convert
@@ -405,8 +453,8 @@ module Sequel
           cps.setDouble(i, arg)
         when TrueClass, FalseClass
           cps.setBoolean(i, arg)
-        when nil
-          cps.setNull(i, JavaSQL::Types::NULL)
+        when NilClass
+          cps.setString(i, nil)
         when DateTime
           cps.setTimestamp(i, java_sql_datetime(arg))
         when Date
@@ -435,8 +483,8 @@ module Sequel
       
       # Parse the table schema for the given table.
       def schema_parse_table(table, opts={})
-        m = output_identifier_meth
-        im = input_identifier_meth
+        m = output_identifier_meth(opts[:dataset])
+        im = input_identifier_meth(opts[:dataset])
         ds = dataset
         schema, table = schema_and_table(table)
         schema ||= opts[:schema]
@@ -444,9 +492,11 @@ module Sequel
         table = im.call(table)
         pks, ts = [], []
         metadata(:getPrimaryKeys, nil, schema, table) do |h|
+          next if schema_parse_table_skip?(h, schema)
           pks << h[:column_name]
         end
         metadata(:getColumns, nil, schema, table, nil) do |h|
+          next if schema_parse_table_skip?(h, schema)
           s = {:type=>schema_column_type(h[:type_name]), :db_type=>h[:type_name], :default=>(h[:column_def] == '' ? nil : h[:column_def]), :allow_null=>(h[:nullable] != 0), :primary_key=>pks.include?(h[:column_name]), :column_size=>h[:column_size], :scale=>h[:decimal_digits]}
           if s[:db_type] =~ DECIMAL_TYPE_RE && s[:scale] == 0
             s[:type] = :integer
@@ -456,6 +506,12 @@ module Sequel
         ts
       end
       
+      # Whether schema_parse_table should skip the given row when
+      # parsing the schema.
+      def schema_parse_table_skip?(h, schema)
+        h[:table_schem] == 'INFORMATION_SCHEMA'
+      end
+
       # Yield a new statement object, and ensure that it is closed before returning.
       def statement(conn)
         stmt = conn.createStatement
@@ -476,6 +532,8 @@ module Sequel
     
     class Dataset < Sequel::Dataset
       include StoredProcedures
+
+      Database::DatasetClass = self
       
       # Use JDBC PreparedStatements instead of emulated ones.  Statements
       # created using #prepare are cached at the connection level to allow
@@ -489,17 +547,17 @@ module Sequel
         # Execute the prepared SQL using the stored type and
         # arguments derived from the hash passed to call.
         def execute(sql, opts={}, &block)
-          super(self, {:arguments=>bind_arguments, :type=>sql_query_type}.merge(opts), &block)
+          super(self, {:arguments=>bind_arguments}.merge(opts), &block)
         end
         
         # Same as execute, explicit due to intricacies of alias and super.
         def execute_dui(sql, opts={}, &block)
-          super(self, {:arguments=>bind_arguments, :type=>sql_query_type}.merge(opts), &block)
+          super(self, {:arguments=>bind_arguments}.merge(opts), &block)
         end
         
         # Same as execute, explicit due to intricacies of alias and super.
         def execute_insert(sql, opts={}, &block)
-          super(self, {:arguments=>bind_arguments, :type=>sql_query_type}.merge(opts), &block)
+          super(self, {:arguments=>bind_arguments, :type=>:insert}.merge(opts), &block)
         end
       end
       
@@ -512,17 +570,17 @@ module Sequel
         
         # Execute the database stored procedure with the stored arguments.
         def execute(sql, opts={}, &block)
-          super(@sproc_name, {:args=>@sproc_args, :sproc=>true, :type=>sql_query_type}.merge(opts), &block)
+          super(@sproc_name, {:args=>@sproc_args, :sproc=>true}.merge(opts), &block)
         end
         
         # Same as execute, explicit due to intricacies of alias and super.
         def execute_dui(sql, opts={}, &block)
-          super(@sproc_name, {:args=>@sproc_args, :sproc=>true, :type=>sql_query_type}.merge(opts), &block)
+          super(@sproc_name, {:args=>@sproc_args, :sproc=>true}.merge(opts), &block)
         end
         
         # Same as execute, explicit due to intricacies of alias and super.
         def execute_insert(sql, opts={}, &block)
-          super(@sproc_name, {:args=>@sproc_args, :sproc=>true, :type=>sql_query_type}.merge(opts), &block)
+          super(@sproc_name, {:args=>@sproc_args, :sproc=>true, :type=>:insert}.merge(opts), &block)
         end
       end
       
@@ -530,13 +588,7 @@ module Sequel
       # Uses the database's setting by default, can be set to false to roughly
       # double performance when fetching rows.
       attr_accessor :convert_types
-      
-      # Use the convert_types default setting from the database
-      def initialize(db, opts={})
-        @convert_types = db.convert_types
-        super
-      end
-      
+
       # Correctly return rows from the database and return them as hashes.
       def fetch_rows(sql, &block)
         execute(sql){|result| process_result_set(result, &block)}
@@ -556,26 +608,77 @@ module Sequel
       end
       
       private
-      
-      # Convert the type.  Used for converting Java types to ruby types.
-      def convert_type(v)
+
+      # Cache Java class constants to speed up lookups
+      JAVA_SQL_TIMESTAMP    = Java::JavaSQL::Timestamp
+      JAVA_SQL_TIME         = Java::JavaSQL::Time
+      JAVA_SQL_DATE         = Java::JavaSQL::Date
+      JAVA_SQL_BLOB         = Java::JavaSQL::Blob
+      JAVA_SQL_CLOB         = Java::JavaSQL::Clob
+      JAVA_BUFFERED_READER  = Java::JavaIo::BufferedReader
+      JAVA_BIG_DECIMAL      = Java::JavaMath::BigDecimal
+      JAVA_BYTE_ARRAY       = Java::byte[]
+
+      # Handle type conversions for common Java types.
+      class TYPE_TRANSLATOR
+        LF = "\n".freeze
+        def time(v) Sequel.string_to_time(v.to_string) end
+        def date(v) Date.civil(v.getYear + 1900, v.getMonth + 1, v.getDate) end
+        def decimal(v) BigDecimal.new(v.to_string) end
+        def byte_array(v) Sequel::SQL::Blob.new(String.from_java_bytes(v)) end
+        def blob(v) Sequel::SQL::Blob.new(String.from_java_bytes(v.getBytes(1, v.length))) end
+        def clob(v) Sequel::SQL::Blob.new(v.getSubString(1, v.length)) end
+        def buffered_reader(v)
+          lines = ""
+          c = false
+          while(line = v.read_line) do
+            lines << LF if c
+            lines << line
+            c ||= true
+          end
+          lines
+        end
+      end
+      TYPE_TRANSLATOR_INSTANCE = tt = TYPE_TRANSLATOR.new
+
+      # Cache type translator methods so that duplicate Method
+      # objects are not created.
+      DECIMAL_METHOD = tt.method(:decimal)
+      TIME_METHOD = tt.method(:time)
+      DATE_METHOD = tt.method(:date)
+      BUFFERED_READER_METHOD = tt.method(:buffered_reader)
+      BYTE_ARRAY_METHOD = tt.method(:byte_array)
+      BLOB_METHOD = tt.method(:blob)
+      CLOB_METHOD = tt.method(:clob)
+
+      # Convert the given Java timestamp to an instance of Sequel.datetime_class.
+      def convert_type_timestamp(v)
+        db.to_application_timestamp([v.getYear + 1900, v.getMonth + 1, v.getDate, v.getHours, v.getMinutes, v.getSeconds, v.getNanos])
+      end
+
+      # Return a callable object that will convert any value of <tt>v</tt>'s
+      # class to a ruby object.  If no callable object can handle <tt>v</tt>'s
+      # class, return false so that the negative lookup is cached.
+      def convert_type_proc(v)
         case v
-        when Java::JavaSQL::Timestamp, Java::JavaSQL::Time
-          Sequel.database_to_application_timestamp(v.to_string)
-        when Java::JavaSQL::Date
-          Sequel.string_to_date(v.to_string)
-        when Java::JavaIo::BufferedReader
-          lines = []
-          while(line = v.read_line) do lines << line end
-          lines.join("\n")
-        when Java::JavaMath::BigDecimal
-          BigDecimal.new(v.to_string)
-        when Java::byte[]
-          Sequel::SQL::Blob.new(String.from_java_bytes(v))
-        when Java::JavaSQL::Blob
-          convert_type(v.getBytes(1, v.length))
+        when JAVA_BIG_DECIMAL
+          DECIMAL_METHOD
+        when JAVA_SQL_TIMESTAMP
+          method(:convert_type_timestamp)
+        when JAVA_SQL_TIME
+          TIME_METHOD
+        when JAVA_SQL_DATE
+          DATE_METHOD
+        when JAVA_BUFFERED_READER
+          BUFFERED_READER_METHOD
+        when JAVA_BYTE_ARRAY
+          BYTE_ARRAY_METHOD
+        when JAVA_SQL_BLOB
+          BLOB_METHOD
+        when JAVA_SQL_CLOB
+          CLOB_METHOD
         else
-          v
+          false
         end
       end
       
@@ -586,32 +689,82 @@ module Sequel
       
       # Split out from fetch rows to allow processing of JDBC result sets
       # that don't come from issuing an SQL string.
-      def process_result_set(result)
+      def process_result_set(result, &block)
         # get column names
         meta = result.getMetaData
         cols = []
         i = 0
         meta.getColumnCount.times{cols << [output_identifier(meta.getColumnLabel(i+=1)), i]}
-        @columns = cols.map{|c| c.at(0)}
-        blk = result_set_object_getter
-        # get rows
+        columns = cols.map{|c| c.at(0)}
+        if opts[:offset] && offset_returns_row_number_column?
+          rn = row_number_column
+          columns.delete(rn)
+        end
+        @columns = columns
+        ct = @convert_types
+        if (ct.nil? ? db.convert_types : ct)
+          cols.each{|c| c << nil}
+          process_result_set_convert(cols, result, rn, &block)
+        else
+          process_result_set_no_convert(cols, result, rn, &block)
+        end
+      ensure
+        result.close
+      end
+
+      # Use conversion procs to convert data retrieved
+      # from the database.  This has been optimized, the algorithm it uses
+      # is roughly, for each column value in each row:
+      # * check if the value is truthy (not false/nil)
+      # * if not truthy, return object
+      # * otherwise, see if a conversion method exists for
+      #   the column.  All columns start with a nil conversion proc,
+      #   since unlike other adapters, Sequel doesn't get the type of
+      #   the column when parsing the column metadata.
+      # * if a conversion proc is not false/nil, call it with the object
+      #   and return the result.
+      # * if a conversion proc has already been looked up and doesn't
+      #   exist (false value), return object.  
+      # * if a conversion proc hasn't been looked up yet (nil value),
+      #   call convert_type_proc to get the conversion method.  Cache
+      #   the result of as the column's conversion proc to speed up
+      #   later processing.  If the conversion proc exists, call it
+      #   and return the result, otherwise, return the object.
+      def process_result_set_convert(cols, result, rn)
         while result.next
           row = {}
-          cols.each do |n, i|
-            row[n] = blk.call(result, n, i)
+          cols.each do |n, i, p|
+            v = result.getObject(i)
+            row[n] = if v
+              if p
+                p.call(v)
+              elsif p.nil?
+                cols[i-1][2] = p = convert_type_proc(v)
+                if p
+                  p.call(v)
+                else
+                  v
+                end
+              else
+                v
+              end
+            else
+              v
+            end
           end
+          row.delete(rn) if rn
           yield row
         end
       end
 
-      # Proc that takes the ResultSet and an integer field number and returns
-      # the object for that field.  Respects the @convert_types setting to
-      # convert Java types to ruby types.
-      def result_set_object_getter
-        if @convert_types
-          lambda {|result, n, i| convert_type(result.getObject(i))}
-        else
-          lambda {|result, n, i| result.getObject(i)}
+      # Yield rows without calling any conversion procs.  This
+      # may yield Java values and not ruby values.
+      def process_result_set_no_convert(cols, result, rn)
+        while result.next
+          row = {}
+          cols.each{|n, i| row[n] = result.getObject(i)}
+          row.delete(rn) if rn
+          yield row
         end
       end
     end