ruby-oci8 2.1.4 → 2.1.5

data/ext/oci8/oraconf.rb

@@ -394,6 +394,7 @@ EOS
       nls_data_basename = ['oraociei11', 'oraociicus11', 'oraociei10', 'oraociicus10']
       @@ld_envs = %w[PATH]
       so_ext = 'dll'
+      check_proc = make_proc_to_check_cpu(is_32bit ? :i386 : :x86_64)
     when /i.86-linux/
       check_proc = make_proc_to_check_cpu(:i386)
     when /ia64-linux/
@@ -847,7 +848,7 @@ EOS
       unless File.exist?("#{@oracle_home}/OCI/INCLUDE/OCI.H")
         raise "'#{@oracle_home}/OCI/INCLUDE/OCI.H' does not exists. Please install 'Oracle Call Interface'."
       end
-      if RUBY_PLATFORM =~ /cygwin/
+      if RUBY_PLATFORM =~ /cygwin|mingw32/
         " \"-I#{@oracle_home}/OCI/INCLUDE\" -D_int64=\"long long\""
       else
         " \"-I#{@oracle_home}/OCI/INCLUDE\""
@@ -971,7 +972,7 @@ EOS
         raise 'failed'
       end
       @cflags = " \"-I#{inc_dir}\""
-      @cflags += " -D_int64=\"long long\"" if RUBY_PLATFORM =~ /cygwin/
+      @cflags += " -D_int64=\"long long\"" if RUBY_PLATFORM =~ /cygwin|mingw32/
       @libs = get_libs("#{ic_dir}/sdk/lib")
       ld_path = nil
     else

data/lib/oci8.rb.in

@@ -82,7 +82,7 @@ require so_basename
 
 if OCI8::VERSION != '@@OCI8_MODULE_VERSION@@'
   require 'rbconfig'
-  so_name = so_basename + "." + Config::CONFIG['DLEXT']
+  so_name = so_basename + "." + RbConfig::CONFIG['DLEXT']
   raise "VERSION MISMATCH! #{so_name} version is #{OCI8::VERSION}, but oci8.rb version is @@OCI8_MODULE_VERSION@@."
 end
 

data/lib/oci8/metadata.rb

@@ -1,6 +1,6 @@
 # oci8.rb -- implements OCI8::Metadata.
 #
-# Copyright (C) 2006-2010 KUBO Takehiro <kubo@jiubao.org>
+# Copyright (C) 2006-2013 Kubo Takehiro <kubo@jiubao.org>
 #
 # See {'Describing Schema Metadata' in Oracle Call Interface Programmer's Guide}
 # [http://download-west.oracle.com/docs/cd/B19306_01/appdev.102/b14250/oci06des.htm]
@@ -14,33 +14,33 @@ class OCI8
   # OCI8::Metadata::Base's subclass.
   #
   # List of methods which return OCI8::Metadata::Base.
-  # * OCI8#describe_any(object_name)
-  # * OCI8#describe_table(table_name, table_only = false)
-  # * OCI8#describe_view(view_name)
-  # * OCI8#describe_procedure(procedure_name)
-  # * OCI8#describe_function(function_name)
-  # * OCI8#describe_package(package_name)
-  # * OCI8#describe_type(type_name)
-  # * OCI8#describe_synonym(synonym_name, check_public_also = true)
-  # * OCI8#describe_sequence(sequence_name)
-  # * OCI8#describe_schema(schema_name)
-  # * OCI8#describe_database(database_name)
-  # * OCI8::Metadata::Type#map_method
-  # * OCI8::Metadata::Type#order_method
-  # * OCI8::Metadata::Type#collection_element
+  # * {OCI8#describe_any OCI8#describe_any(object_name)}
+  # * {OCI8#describe_table OCI8#describe_table(table_name, table_only = false)}
+  # * {OCI8#describe_view OCI8#describe_view(view_name)}
+  # * {OCI8#describe_procedure OCI8#describe_procedure(procedure_name)}
+  # * {OCI8#describe_function OCI8#describe_function(function_name)}
+  # * {OCI8#describe_package OCI8#describe_package(package_name)}
+  # * {OCI8#describe_type OCI8#describe_type(type_name)}
+  # * {OCI8#describe_synonym OCI8#describe_synonym(synonym_name, check_public_also = true)}
+  # * {OCI8#describe_sequence OCI8#describe_sequence(sequence_name)}
+  # * {OCI8#describe_schema OCI8#describe_schema(schema_name)}
+  # * {OCI8#describe_database OCI8#describe_database(database_name)}
+  # * {OCI8::Metadata::Type#map_method OCI8::Metadata::Type#map_method}
+  # * {OCI8::Metadata::Type#order_method OCI8::Metadata::Type#order_method}
+  # * {OCI8::Metadata::Type#collection_element OCI8::Metadata::Type#collection_element}
   #
   # List of methods which return an array of OCI8::Metadata::Base.
-  # * OCI8::Cursor#column_metadata
-  # * OCI8::Metadata::Database#schemas
-  # * OCI8::Metadata::Schema#all_objects
-  # * OCI8::Metadata::Schema#objects
-  # * OCI8::Metadata::Table#columns
-  # * OCI8::Metadata::Package#subprograms
-  # * OCI8::Metadata::Procedure#arguments
-  # * OCI8::Metadata::Function#arguments
-  # * OCI8::Metadata::Type#type_attrs
-  # * OCI8::Metadata::Type#type_methods
-  # * OCI8::Metadata::TypeMethod#arguments
+  # * {OCI8::Cursor#column_metadata OCI8::Cursor#column_metadata}
+  # * {OCI8::Metadata::Database#schemas OCI8::Metadata::Database#schemas}
+  # * {OCI8::Metadata::Schema#all_objects OCI8::Metadata::Schema#all_objects}
+  # * {OCI8::Metadata::Schema#objects OCI8::Metadata::Schema#objects}
+  # * {OCI8::Metadata::Table#columns OCI8::Metadata::Table#columns}
+  # * {OCI8::Metadata::Package#subprograms OCI8::Metadata::Package#subprograms}
+  # * {OCI8::Metadata::Subprogram#arguments OCI8::Metadata::Procedure#arguments}
+  # * {OCI8::Metadata::Subprogram#arguments OCI8::Metadata::Function#arguments}
+  # * {OCI8::Metadata::Type#type_attrs OCI8::Metadata::Type#type_attrs}
+  # * {OCI8::Metadata::Type#type_methods OCI8::Metadata::Type#type_methods}
+  # * {OCI8::Metadata::TypeMethod#arguments OCI8::Metadata::TypeMethod#arguments}
   #
   # Example:
   #   conn = OCI8.new('username/passord')
@@ -54,34 +54,31 @@ class OCI8
       # Table 6-1 Attributes Belonging to All Parameters
 
       # Returns the number of parameters.
-      def num_params # :nodoc:
+      def num_params
         attr_get_ub2(OCI_ATTR_NUM_PARAMS)
       end
       private :num_params
 
-      # Returns the object ID, which is the same as the value of the
-      # OBJECT_ID column from ALL_OBJECTS. It returns +nil+
-      # if the database object doesn't have ID.
+      # Returns the object ID which corresponds to the data dictionary
+      # view column ALL_OBJECTS.OBJECT_ID.
       #
       # @return [Integer or nil]
       def obj_id
-        attr_get_ub4(OCI_ATTR_OBJ_ID)
+        attr_get_ub4(OCI_ATTR_OBJ_ID, false)
       end
 
-      # Retruns the object name such as table name, view name,
-      # procedure name, and so on.
+      # Returns the object name which corresponds to the data dictionary view column ALL_OBJECTS.OBJECT_NAME.
       #
-      # @return [String]
+      # @return [String or nil] object name
       def obj_name
-        attr_get_string(OCI_ATTR_OBJ_NAME)
+        attr_get_string(OCI_ATTR_OBJ_NAME, false)
       end
 
-      # Retruns the schema name. It returns +nil+
-      # if the database object is not defined just under a schema.
+      # Returns the schema name which corresponds to the data dictionary view column ALL_OBJECTS.OWNER.
       #
-      # @return [String]
+      # @return [String or nil] schema name
       def obj_schema
-        attr_get_string(OCI_ATTR_OBJ_SCHEMA)
+        attr_get_string(OCI_ATTR_OBJ_SCHEMA, false)
       end
 
       # The timestamp of the object
@@ -92,7 +89,8 @@ class OCI8
       #  attr_get_oradate(OCI_ATTR_TIMESTAMP)
       #end
 
-      def inspect # :nodoc:
+      # @private
+      def inspect
         "#<#{self.class.name}:(#{obj_id}) #{obj_schema}.#{obj_name}>"
       end
       private
@@ -103,8 +101,9 @@ class OCI8
       alias __word attr_get_sb4
       def __anydata(idx); raise NotImplementedError; end
 
-      # SQLT values to name
-      DATA_TYPE_MAP = {} # :nodoc:
+      # Mapping from SQLT values to names
+      # @private
+      DATA_TYPE_MAP = {}
 
       # SQLT_CHR
       DATA_TYPE_MAP[1] = [:varchar2,
@@ -346,7 +345,7 @@ class OCI8
     # into other metadata classes.
     #
     # An instance of this class is returned by:
-    # * OCI8::Metadata::Schema#all_objects
+    # * {OCI8::Metadata::Schema#all_objects OCI8::Metadata::Schema#all_objects}
     class Unknown < Base
       register_ptype OCI_PTYPE_UNK
     end
@@ -354,14 +353,10 @@ class OCI8
     # Information about tables
     #
     # An instance of this class is returned by:
-    # * OCI8#describe_any(name)
-    # * OCI8#describe_table(name)
-    # * OCI8::Metadata::Schema#all_objects
-    # * OCI8::Metadata::Schema#objects
-    #
-    # See also:
-    # * OCI8::Metadata::Base#obj_name
-    # * OCI8::Metadata::Base#obj_schema
+    # * {OCI8#describe_any OCI8#describe_any(name)}
+    # * {OCI8#describe_table OCI8#describe_table(name)}
+    # * {OCI8::Metadata::Schema#all_objects OCI8::Metadata::Schema#all_objects}
+    # * {OCI8::Metadata::Schema#objects OCI8::Metadata::Schema#objects}
     class Table < Base
       register_ptype OCI_PTYPE_TABLE
 
@@ -464,15 +459,11 @@ class OCI8
     # Information about views
     #
     # An instance of this class is returned by:
-    # * OCI8#describe_any(name)
-    # * OCI8#describe_table(name, false)
-    # * OCI8#describe_view(name)
-    # * OCI8::Metadata::Schema#all_objects
-    # * OCI8::Metadata::Schema#objects
-    #
-    # See also:
-    # * OCI8::Metadata::Base#obj_name
-    # * OCI8::Metadata::Base#obj_schema
+    # * {OCI8#describe_any OCI8#describe_any(name)}
+    # * {OCI8#describe_table OCI8#describe_table(name, false)}
+    # * {OCI8#describe_view OCI8#describe_view(name)}
+    # * {OCI8::Metadata::Schema#all_objects OCI8::Metadata::Schema#all_objects}
+    # * {OCI8::Metadata::Schema#objects OCI8::Metadata::Schema#objects}
     class View < Base
       register_ptype OCI_PTYPE_VIEW
 
@@ -525,8 +516,8 @@ class OCI8
     # with a set of parameters. A subprogram can be either a procedure
     # or a function.
     #
-    # This is the abstract base class of OCI8::Metadata::Procedure and
-    # OCI8::Metadata::Function.
+    # This is the abstract base class of {OCI8::Metadata::Procedure OCI8::Metadata::Procedure} and
+    # {OCI8::Metadata::Function OCI8::Metadata::Function}.
     class Subprogram < Base
       ## Table 6-4 Attribute Belonging to Procedures or Functions
 
@@ -565,9 +556,9 @@ class OCI8
       alias name obj_name # :nodoc: for backward compatibility
 
       # Returns +nil+ for a standalone stored subprogram,
-      # positive integer for a
-      # {overloaded packaged subprogram}[http://download.oracle.com/docs/cd/B28359_01/appdev.111/b28370/subprograms.htm#i12352].
-      # , otherwise zero.
+      # positive integer for an
+      # {overloaded packaged subprogram}[http://download.oracle.com/docs/cd/B28359_01/appdev.111/b28370/subprograms.htm#i12352],
+      # otherwise zero.
       #
       # @return [Integer or nil]
       def overload_id
@@ -589,7 +580,8 @@ class OCI8
         @is_standalone
       end
 
-      def inspect # :nodoc:
+      # @private
+      def inspect
         "#<#{self.class.name}: #{name}>"
       end
     end
@@ -1230,7 +1222,7 @@ class OCI8
       end
 
       def inspect # :nodoc:
-        "#<#{self.class.name}:(#{obj_id}) #{obj_schema}.#{obj_name}>"
+        "#<#{self.class.name}:(#{obj_id}) #{obj_schema}.#{obj_name} FOR #{translated_name}>"
       end
     end
 

data/lib/oci8/object.rb

@@ -394,7 +394,6 @@ EOS
       @instance_methods = {}
       metadata.type_methods.each_with_index do |type_method, i|
         next if type_method.is_constructor? or type_method.is_destructor?
-        args = type_method.arguments
 
         result_type = nil
         if type_method.has_result?

data/lib/oci8/oci8.rb

@@ -1,6 +1,6 @@
 # oci8.rb -- OCI8
 #
-# Copyright (C) 2002-2012 KUBO Takehiro <kubo@jiubao.org>
+# Copyright (C) 2002-2013 Kubo Takehiro <kubo@jiubao.org>
 #
 # Original Copyright is:
 #   Oracle module for Ruby
@@ -123,48 +123,38 @@ class OCI8
     stmt_cache_size = OCI8.properties[:statement_cache_size]
     stmt_cache_size = nil if stmt_cache_size == 0
 
-    if mode.nil? and cred.nil?
-      # logon by the OCI function OCILogon2().
-      logon2_mode = 0
-      if dbname.is_a? OCI8::ConnectionPool
-        @pool = dbname # to prevent GC from freeing the connection pool.
-        dbname = dbname.send(:pool_name)
-        logon2_mode |= 0x0200 # OCI_LOGON2_CPOOL
-      end
-      if stmt_cache_size
-        # enable statement caching
-        logon2_mode |= 0x0004 # OCI_LOGON2_STMTCACHE
-      end
-
-      logon2(username, password, dbname, logon2_mode)
+    attach_mode = 0
+    if dbname.is_a? OCI8::ConnectionPool
+      @pool = dbname # to prevent GC from freeing the connection pool.
+      dbname = dbname.send(:pool_name)
+      attach_mode |= 0x0200 # OCI_CPOOL and OCI_LOGON2_CPOOL
+    end
+    if stmt_cache_size
+      # enable statement caching
+      attach_mode |= 0x0004 # OCI_STMT_CACHE and OCI_LOGON2_STMTCACHE
+    end
 
-      if stmt_cache_size
-        # set statement cache size
-        attr_set_ub4(176, stmt_cache_size) # 176: OCI_ATTR_STMTCACHESIZE
-      end
-    else
+    if true
       # logon by the OCI function OCISessionBegin().
-      attach_mode = 0
-      if dbname.is_a? OCI8::ConnectionPool
-        @pool = dbname # to prevent GC from freeing the connection pool.
-        dbname = dbname.send(:pool_name)
-        attach_mode |= 0x0200 # OCI_CPOOL
-      end
-      if stmt_cache_size
-        # enable statement caching
-        attach_mode |= 0x0004 # OCI_STMT_CACHE
-      end
-
       allocate_handles()
       @session_handle.send(:attr_set_string, OCI_ATTR_USERNAME, username) if username
       @session_handle.send(:attr_set_string, OCI_ATTR_PASSWORD, password) if password
+      if @@oracle_client_version >= ORAVER_11_1
+        # 'rubyoci8' is displayed in V$SESSION_CONNECT_INFO.CLIENT_DRIVER
+        # if both the client and the server are Oracle 11g or upper.
+        # 424: OCI_ATTR_DRIVER_NAME
+        @session_handle.send(:attr_set_string, 424, 'rubyoci8')
+      end
       server_attach(dbname, attach_mode)
       session_begin(cred ? cred : OCI_CRED_RDBMS, mode ? mode : OCI_DEFAULT)
+    else
+      # logon by the OCI function OCILogon2().
+      logon2(username, password, dbname, attach_mode)
+    end
 
-      if stmt_cache_size
-        # set statement cache size
-        attr_set_ub4(176, stmt_cache_size) # 176: OCI_ATTR_STMTCACHESIZE
-      end
+    if stmt_cache_size
+      # set statement cache size
+      attr_set_ub4(176, stmt_cache_size) # 176: OCI_ATTR_STMTCACHESIZE
     end
 
     @prefetch_rows = nil
@@ -339,6 +329,16 @@ class OCI8
     end
   end
 
+  # Sets the prefetch rows size. The default value is one.
+  # When a select statement is executed, the OCI library allocate
+  # prefetch buffer to reduce the number of network round trips by
+  # retrieving specified number of rows in one round trip.
+  #
+  # Note: Active record adaptors set 100 by default.
+  def prefetch_rows=(num)
+    @prefetch_rows = num
+  end
+
   # @private
   def inspect
     "#<OCI8:#{username}>"

data/lib/oci8/oracle_version.rb

@@ -1,6 +1,6 @@
 # oracle_version.rb implements OCI8::OracleVersion.
 #
-# Copyright (C) 2009 KUBO Takehiro <kubo@jiubao.org>
+# Copyright (C) 2009-2013 Kubo Takehiro <kubo@jiubao.org>
 
 #
 class OCI8
@@ -21,9 +21,9 @@ class OCI8
     attr_reader :minor
     # The third part of the Oracle version.
     attr_reader :update
-    # The fifth part of the Oracle version.
-    attr_reader :patch
     # The fourth part of the Oracle version.
+    attr_reader :patch
+    # The fifth part of the Oracle version.
     attr_reader :port_update
 
     # Creates an OCI8::OracleVersion object.
@@ -80,6 +80,7 @@ class OCI8
       @update = update || 0
       @patch = patch || 0
       @port_update = port_update || 0
+      @vernum = (@major << 24) | (@minor << 20) | (@update << 12) | (@patch << 8) | @port_update
     end
 
     # Compares +self+ and +other+.
@@ -89,15 +90,7 @@ class OCI8
     #
     # @return [-1, 0, +1]
     def <=>(other)
-      cmp = @major <=> other.major
-      return cmp if cmp != 0
-      cmp = @minor <=> other.minor
-      return cmp if cmp != 0
-      cmp = @update <=> other.update
-      return cmp if cmp != 0
-      cmp = @patch <=> other.patch
-      return cmp if cmp != 0
-      @port_update <=> other.port_update
+      @vernum <=> other.to_i
     end
 
     # Returns an integer number contains 5-digit Oracle version.
@@ -113,7 +106,7 @@ class OCI8
     #
     # @return [Integer]
     def to_i
-      (@major << 24) | (@minor << 20) | (@update << 12) | (@patch << 8) | @port_update
+      @vernum
     end
 
     # Returns a dotted version string of the Oracle version.
@@ -139,7 +132,7 @@ class OCI8
     #
     # @return [Integer]
     def hash
-      to_i
+      @vernum
     end
 
     # @private

data/ruby-oci8.gemspec

@@ -8,15 +8,8 @@
 #
 require 'fileutils'
 
-build_args = if (defined? Gem::Command and Gem::Command.respond_to? :build_args)
-               Gem::Command.build_args
-             else
-               # for old rubygems
-               ARGV.include?("--") ? ARGV[(ARGV.index("--") + 1)...ARGV.size] : []
-             end
-
-if build_args.size > 0
-  gem_platform = build_args[0]
+if ARGV.include?("--") and ARGV[(ARGV.index("--") + 1)] == 'current'
+  gem_platform = 'current'
 else
   gem_platform = Gem::Platform::RUBY
 end
@@ -29,10 +22,10 @@ spec = Gem::Specification.new do |s|
   s.homepage = 'http://ruby-oci8.rubyforge.org'
   s.rubyforge_project = 'ruby-oci8'
   s.description = <<EOS
-ruby-oci8 is a ruby interface for Oracle using OCI8 API. It is available with Oracle8, Oracle8i, Oracle9i, Oracle10g and Oracle Instant Client.
+ruby-oci8 is a ruby interface for Oracle using OCI8 API. It is available with Oracle8i, Oracle9i, Oracle10g, Oracle11g and Oracle Instant Client.
 EOS
   s.has_rdoc = 'yard'
-  s.authors = ['KUBO Takehiro']
+  s.authors = ['Kubo Takehiro']
   s.platform = gem_platform
   s.license = '2-clause BSD-style license'
   files = File.read('dist-files').split("\n")
@@ -41,23 +34,35 @@ EOS
     s.required_ruby_version = '>= 1.8.0'
   else
     so_files = Dir.glob('ext/oci8/oci8lib_*.so')
-    has_1_8 = so_files.include? 'ext/oci8/oci8lib_18.so'
-    has_1_9_1 = so_files.include? 'ext/oci8/oci8lib_191.so'
-    if has_1_8 and has_1_9_1
-      puts 'Binary gem for ruby 1.8 and 1.9.1'
-      s.required_ruby_version = '>= 1.8.0'
-    elsif has_1_8 and !has_1_9_1
-      puts 'Binary gem for ruby 1.8'
-      s.required_ruby_version = '~> 1.8.0'
-    elsif !has_1_8 and has_1_9_1
-      puts 'Binary gem for ruby 1.9.1'
-      s.required_ruby_version = '~> 1.9.1'
-    else
+    so_vers = so_files.collect do |file|
+      $1 if /ext\/oci8\/oci8lib_(\S+).so/ =~ file
+    end.sort
+
+    # add map files to analyze a core (minidump) file.
+    so_vers.each do |ver|
+      map_file = 'ext/oci8/oci8lib_#{ver}.map'
+      so_files << map_file if File.exists? map_file
+    end
+
+    # least version in so_vers
+    so_vermin = so_vers.collect do |ver|
+      "#$1.#$2.#{$3||'0'}" if /^(?:rbx)?(\d)(\d)(\d)?/ =~ ver
+    end.sort.first
+
+    case so_vers.length
+    when 0
       raise "No compiled binary are found. Run make in advance."
+    when 1
+      puts "Binary gem for ruby #{so_vers.first}"
+      if so_vers[0] < '2.0.0'
+        s.required_ruby_version = "~> #{so_vermin}"
+      else
+        s.required_ruby_version = "= #{so_vermin}"
+      end
+    else
+      puts "Binary gem for ruby #{so_vers.join(', ')}"
+      s.required_ruby_version = ">= #{so_vermin}"
     end
-    # add map files to analyze a core (minidump) file.
-    so_files << 'ext/oci8/oci8lib_18.map' if has_1_8 and File.exists? 'ext/oci8/oci8lib_18.map'
-    so_files << 'ext/oci8/oci8lib_191.map' if has_1_9_1 and File.exists? 'ext/oci8/oci8lib_191.map'
 
     FileUtils.copy so_files, 'lib', :preserve => true
     files.reject! do |fname|