ruby-oci8-master 2.0.7

data/lib/oci8.rb.in

@@ -0,0 +1,94 @@
+
+#   --*- ruby -*--
+# This is based on yoshidam's oracle.rb.
+#
+# sample one liner:
+#  ruby -r oci8 -e 'OCI8.new("scott", "tiger", nil).exec("select * from emp") do |r| puts r.join(","); end'
+#  # select all data from emp and print them as CVS format.
+
+if RUBY_PLATFORM =~ /cygwin/
+  # Cygwin manages environment variables by itself.
+  # They don't synchroize with Win32's ones.
+  # This set some Oracle's environment variables to win32's enviroment.
+  require 'Win32API'
+  win32setenv = Win32API.new('Kernel32.dll', 'SetEnvironmentVariableA', 'PP', 'I')
+  ['NLS_LANG', 'ORA_NLS10', 'ORA_NLS32', 'ORA_NLS33', 'ORACLE_BASE', 'ORACLE_HOME', 'ORACLE_SID', 'TNS_ADMIN', 'LOCAL'].each do |name|
+    val = ENV[name]
+    win32setenv.call(name, val && val.dup)
+  end
+end
+
+so_basename = 'oci8lib_'
+if defined? RUBY_ENGINE and RUBY_ENGINE != 'ruby'
+  so_basename += RUBY_ENGINE
+end
+
+# The suffix number indicates the ruby API version.
+#  18  - ruby 1.8.x
+#  191 - ruby 1.9.1 and 1.9.2
+#  19x - ruby 1.9.x future version which will break the API compatibility
+case RUBY_VERSION
+when /^1\.9/
+  so_basename += '191'
+when /^1\.8/
+  so_basename += '18'
+else
+  raise 'unsupported ruby version: ' + RUBY_VERSION
+end
+require so_basename
+
+if OCI8::VERSION != '@@OCI8_MODULE_VERSION@@'
+  require 'rbconfig'
+  so_name = so_basename + "." + Config::CONFIG['DLEXT']
+  raise "VERSION MISMATCH! #{so_name} version is #{OCI8::VERSION}, but oci8.rb version is @@OCI8_MODULE_VERSION@@."
+end
+
+require 'oci8/encoding-init.rb'
+require 'oci8/oracle_version.rb'
+
+class OCI8
+  ORAVER_8_0  = OCI8::OracleVersion.new(8, 0)
+  ORAVER_8_1  = OCI8::OracleVersion.new(8, 1)
+  ORAVER_9_0  = OCI8::OracleVersion.new(9, 0)
+  ORAVER_9_2  = OCI8::OracleVersion.new(9, 2)
+  ORAVER_10_1 = OCI8::OracleVersion.new(10, 1)
+  ORAVER_10_2 = OCI8::OracleVersion.new(10, 2)
+  ORAVER_11_1 = OCI8::OracleVersion.new(11, 1)
+
+  @@oracle_client_version = OCI8::OracleVersion.new(self.oracle_client_vernum)
+
+  # :call-seq:
+  #   OCI8.oracle_client_version -> oraver
+  #
+  # Returns an OCI8::OracleVersion of the Oracle client version.
+  #
+  # If this library is configured without '--with-runtime-check',
+  # and compiled for Oracle 10.1 or lower, the major and minor
+  # numbers are determined at compile-time. The rests are zeros.
+  #
+  # If this library is configured with '--with-runtime-check'
+  # and the runtime Oracle library is Oracle 10.1 or lower, the
+  # major and minor numbers are determined at run-time. The
+  # rests are zeros.
+  #
+  # Otherwise, it is the version retrieved from an OCI function
+  # OCIClientVersion().
+  def self.oracle_client_version
+    @@oracle_client_version
+  end
+
+  # defined for backward compatibility.
+  CLIENT_VERSION = @@oracle_client_version.major.to_s +
+    @@oracle_client_version.minor.to_s +
+    @@oracle_client_version.update.to_s
+end
+
+require 'oci8/ocihandle.rb'
+require 'oci8/datetime.rb'
+require 'oci8/oci8.rb'
+require 'oci8/bindtype.rb'
+require 'oci8/metadata.rb'
+require 'oci8/compat.rb'
+require 'oci8/object.rb'
+require 'oci8/connection_pool.rb'
+require 'oci8/properties.rb'

data/lib/oci8/.document

@@ -0,0 +1,8 @@
+datetime.rb
+object.rb
+metadata.rb
+oracle_version.rb
+oci8.rb
+ocihandle.rb
+connection_pool.rb
+properties.rb

data/lib/oci8/bindtype.rb

@@ -0,0 +1,349 @@
+#--
+# bindtype.rb -- OCI8::BindType
+#
+# Copyright (C) 2009-2011 KUBO Takehiro <kubo@jiubao.org>
+#++
+
+class OCI8
+  module BindType
+    Mapping = {}
+
+    class Base
+      def self.create(con, val, param, max_array_size)
+        self.new(con, val, param, max_array_size)
+      end
+    end
+
+    # get/set Date
+    class Date < OCI8::BindType::OraDate
+      def set(val)
+        super(val && ::OraDate.new(val.year, val.mon, val.mday))
+      end
+      def get()
+        (val = super()) && val.to_date
+      end
+    end
+
+    class BigDecimal < OCI8::BindType::OraNumber
+      @@bigdecimal_is_required = false
+      def get()
+        unless @@bigdecimal_is_required
+          require 'bigdecimal'
+          @@bigdecimal_is_required = true
+        end
+        (val = super()) && val.to_d
+      end
+    end
+
+    class Rational < OCI8::BindType::OraNumber
+      @@rational_is_required = false
+      def get()
+        unless @@rational_is_required
+          require 'rational'
+          @@rational_is_required = true
+        end
+        (val = super()) && val.to_r
+      end
+    end
+
+    class BasicNumberType < OCI8::BindType::OraNumber
+      def get()
+        (val = super()) && (val.has_decimal_part? ? val.to_f : val.to_i)
+      end
+    end
+
+    # get/set Number (for OCI8::SQLT_NUM)
+    class Number
+      def self.create(con, val, param, max_array_size)
+        if param.is_a? OCI8::Metadata::Base
+          precision = param.precision
+          scale = param.scale
+        end
+        if scale == -127
+          if precision == 0
+            # NUMBER declared without its scale and precision. (Oracle 9.2.0.3 or above)
+            klass = OCI8::BindType::Mapping[:number_no_prec_setting]
+          else
+            # FLOAT or FLOAT(p)
+            klass = OCI8::BindType::Float
+          end
+        elsif scale == 0
+          if precision == 0
+            # NUMBER whose scale and precision is unknown
+            # or
+            # NUMBER declared without its scale and precision. (Oracle 9.2.0.2 or below)
+            klass = OCI8::BindType::Mapping[:number_unknown_prec]
+          else
+            # NUMBER(p, 0)
+            klass = OCI8::BindType::Integer
+          end
+        else
+          # NUMBER(p, s)
+          if precision < 15 # the precision of double.
+            klass = OCI8::BindType::Float
+          else
+            # use BigDecimal instead
+            klass = OCI8::BindType::BigDecimal
+          end
+        end
+        klass.new(con, val, nil, max_array_size)
+      end
+    end
+
+    class String
+      # 1333 <= ceil(4000 / 3). 4000 is max size of char. 3 is NLS ratio of UTF-8.
+      @@minimum_bind_length = 1333
+
+      def self.minimum_bind_length
+        @@minimum_bind_length
+      end
+
+      def self.minimum_bind_length=(val)
+        @@minimum_bind_length = val
+      end
+
+      def self.create(con, val, param, max_array_size)
+        case param
+        when Hash
+          param[:length_semantics] = OCI8::properties[:length_semantics] unless param.has_key? :length_semantics
+          unless param[:length]
+            if val.respond_to? :to_str
+              val = val.to_str
+              if param[:length_semantics] == :char
+                # character semantics
+                param[:length] = val.size
+              else
+                # byte semantics
+                if OCI8.respond_to? :encoding and OCI8.encoding != val.encoding
+                  # If the string encoding is different with NLS_LANG character set,
+                  # convert it to get the length.
+                  val = val.encode(OCI8.encoding)
+                end
+                if val.respond_to? :bytesize
+                  # ruby 1.8.7 or upper
+                  param[:length] = val.bytesize
+                else
+                  # ruby 1.8.6 or lower
+                  param[:length] = val.size
+                end
+              end
+            else
+              param[:length] = @@minimum_bind_length
+            end
+          end
+          # use the default value when :nchar is not set explicitly.
+          param[:nchar] = OCI8.properties[:bind_string_as_nchar] unless param.has_key?(:nchar)
+        when OCI8::Metadata::Base
+          case param.data_type
+          when :char, :varchar2
+            length_semantics = OCI8.properties[:length_semantics]
+            if length_semantics == :char
+              length = param.char_size
+            else
+              length = param.data_size * OCI8.nls_ratio
+            end
+            param = {
+              :length => length,
+              :length_semantics => length_semantics,
+              :nchar => (param.charset_form == :nchar),
+            }
+          when :raw
+            # HEX needs twice space.
+            param = {:length => param.data_size * 2}
+          else
+            param = {:length => @@minimum_bind_length}
+          end
+        end
+        self.new(con, val, param, max_array_size)
+      end
+    end
+
+    class RAW
+      def self.create(con, val, param, max_array_size)
+        case param
+        when Hash
+          unless param[:length]
+            if val.respond_to? :to_str
+              val = val.to_str
+              if val.respond_to? :bytesize
+                param[:length] = val.bytesize
+              else
+                param[:length] = val.size
+              end
+            else
+              param[:length] = 400
+            end
+          end
+        when OCI8::Metadata::Base
+          param = {:length => param.data_size}
+        end
+        self.new(con, val, param, max_array_size)
+      end
+    end
+
+    class Long < OCI8::BindType::String
+      def self.create(con, val, param, max_array_size)
+        param = {:length => con.long_read_len, :char_semantics => true}
+        super(con, val, param, max_array_size)
+      end
+    end
+
+    class LongRaw < OCI8::BindType::RAW
+      def self.create(con, val, param, max_array_size)
+        param = {:length => con.long_read_len, :char_semantics => false}
+        self.new(con, val, param, max_array_size)
+      end
+    end
+
+    class CLOB
+      def self.create(con, val, param, max_array_size)
+        if param.is_a? OCI8::Metadata::Base and param.charset_form == :nchar
+          OCI8::BindType::NCLOB.new(con, val, nil, max_array_size)
+        else
+          OCI8::BindType::CLOB.new(con, val, nil, max_array_size)
+        end
+      end
+    end
+  end # BindType
+end
+
+# bind or explicitly define
+OCI8::BindType::Mapping[String]       = OCI8::BindType::String
+OCI8::BindType::Mapping[OraNumber]    = OCI8::BindType::OraNumber
+OCI8::BindType::Mapping['BigDecimal'] = OCI8::BindType::BigDecimal
+OCI8::BindType::Mapping['Rational']   = OCI8::BindType::Rational
+OCI8::BindType::Mapping[Fixnum]       = OCI8::BindType::Integer
+OCI8::BindType::Mapping[Float]        = OCI8::BindType::Float
+OCI8::BindType::Mapping[Integer]      = OCI8::BindType::Integer
+OCI8::BindType::Mapping[Bignum]       = OCI8::BindType::Integer
+OCI8::BindType::Mapping[OraDate]      = OCI8::BindType::OraDate
+OCI8::BindType::Mapping[Time]         = OCI8::BindType::Time
+OCI8::BindType::Mapping[Date]         = OCI8::BindType::Date
+OCI8::BindType::Mapping[DateTime]     = OCI8::BindType::DateTime
+OCI8::BindType::Mapping[OCI8::CLOB]   = OCI8::BindType::CLOB
+OCI8::BindType::Mapping[OCI8::NCLOB]  = OCI8::BindType::NCLOB
+OCI8::BindType::Mapping[OCI8::BLOB]   = OCI8::BindType::BLOB
+OCI8::BindType::Mapping[OCI8::BFILE]  = OCI8::BindType::BFILE
+OCI8::BindType::Mapping[OCI8::Cursor] = OCI8::BindType::Cursor
+
+# implicitly define
+
+# datatype        type     size prec scale
+# -------------------------------------------------
+# CHAR(1)       SQLT_AFC      1    0    0
+# CHAR(10)      SQLT_AFC     10    0    0
+OCI8::BindType::Mapping[:char] = OCI8::BindType::String
+
+# datatype        type     size prec scale
+# -------------------------------------------------
+# VARCHAR(1)    SQLT_CHR      1    0    0
+# VARCHAR(10)   SQLT_CHR     10    0    0
+# VARCHAR2(1)   SQLT_CHR      1    0    0
+# VARCHAR2(10)  SQLT_CHR     10    0    0
+OCI8::BindType::Mapping[:varchar2] = OCI8::BindType::String
+
+# datatype        type     size prec scale
+# -------------------------------------------------
+# RAW(1)        SQLT_BIN      1    0    0
+# RAW(10)       SQLT_BIN     10    0    0
+OCI8::BindType::Mapping[:raw] = OCI8::BindType::RAW
+
+# datatype        type     size prec scale
+# -------------------------------------------------
+# LONG          SQLT_LNG      0    0    0
+OCI8::BindType::Mapping[:long] = OCI8::BindType::Long
+
+# datatype        type     size prec scale
+# -------------------------------------------------
+# LONG RAW      SQLT_LBI      0    0    0
+OCI8::BindType::Mapping[:long_raw] = OCI8::BindType::LongRaw
+
+# datatype        type     size prec scale
+# -------------------------------------------------
+# CLOB          SQLT_CLOB  4000    0    0
+OCI8::BindType::Mapping[:clob] = OCI8::BindType::CLOB
+OCI8::BindType::Mapping[:nclob] = OCI8::BindType::NCLOB
+
+# datatype        type     size prec scale
+# -------------------------------------------------
+# BLOB          SQLT_BLOB  4000    0    0
+OCI8::BindType::Mapping[:blob] = OCI8::BindType::BLOB
+
+# datatype        type     size prec scale
+# -------------------------------------------------
+# BFILE         SQLT_BFILE 4000    0    0
+OCI8::BindType::Mapping[:bfile] = OCI8::BindType::BFILE
+
+# datatype        type     size prec scale
+# -------------------------------------------------
+# DATE          SQLT_DAT      7    0    0
+OCI8::BindType::Mapping[:date] = OCI8::BindType::Time
+
+OCI8::BindType::Mapping[:timestamp] = OCI8::BindType::Time
+OCI8::BindType::Mapping[:timestamp_tz] = OCI8::BindType::Time
+OCI8::BindType::Mapping[:timestamp_ltz] = OCI8::BindType::Time
+OCI8::BindType::Mapping[:interval_ym] = OCI8::BindType::IntervalYM
+OCI8::BindType::Mapping[:interval_ds] = OCI8::BindType::IntervalDS
+
+# datatype        type     size prec scale
+# -------------------------------------------------
+# ROWID         SQLT_RDD      4    0    0
+OCI8::BindType::Mapping[:rowid] = OCI8::BindType::String
+
+# datatype           type     size prec scale
+# -----------------------------------------------------
+# FLOAT            SQLT_NUM     22  126 -127
+# FLOAT(1)         SQLT_NUM     22    1 -127
+# FLOAT(126)       SQLT_NUM     22  126 -127
+# DOUBLE PRECISION SQLT_NUM     22  126 -127
+# REAL             SQLT_NUM     22   63 -127
+# NUMBER           SQLT_NUM     22    0    0
+# NUMBER(1)        SQLT_NUM     22    1    0
+# NUMBER(38)       SQLT_NUM     22   38    0
+# NUMBER(1, 0)     SQLT_NUM     22    1    0
+# NUMBER(38, 0)    SQLT_NUM     22   38    0
+# NUMERIC          SQLT_NUM     22   38    0
+# INT              SQLT_NUM     22   38    0
+# INTEGER          SQLT_NUM     22   38    0
+# SMALLINT         SQLT_NUM     22   38    0
+OCI8::BindType::Mapping[:number] = OCI8::BindType::Number
+
+# mapping for calculated number values.
+#
+# for example:
+#   select col1 * 1.1 from tab1;
+#
+# For Oracle 9.2.0.2 or below, this is also used for NUMBER
+# datatypes that have no explicit setting of their precision
+# and scale.
+#
+# The default mapping is Float for ruby-oci8 1.0, OraNumber for 2.0.0 ~ 2.0.2,
+# BigDecimal for 2.0.3 ~.
+OCI8::BindType::Mapping[:number_unknown_prec] = OCI8::BindType::BigDecimal
+
+# mapping for number without precision and scale.
+#
+# for example:
+#   create table tab1 (col1 number);
+#   select col1 from tab1;
+#
+# note: This is available only on Oracle 9.2.0.3 or above.
+# see:  Oracle 9.2.0.x Patch Set Notes.
+#
+# The default mapping is Float for ruby-oci8 1.0, OraNumber for 2.0.0 ~ 2.0.2,
+# BigDecimal for 2.0.3 ~.
+OCI8::BindType::Mapping[:number_no_prec_setting] = OCI8::BindType::BigDecimal
+
+if defined? OCI8::BindType::BinaryDouble
+  OCI8::BindType::Mapping[:binary_float] = OCI8::BindType::BinaryDouble
+  OCI8::BindType::Mapping[:binary_double] = OCI8::BindType::BinaryDouble
+else
+  OCI8::BindType::Mapping[:binary_float] = OCI8::BindType::Float
+  OCI8::BindType::Mapping[:binary_double] = OCI8::BindType::Float
+end
+
+# Cursor
+OCI8::BindType::Mapping[:cursor] = OCI8::BindType::Cursor
+
+# XMLType (This mapping will be changed before release.)
+OCI8::BindType::Mapping[:xmltype] = OCI8::BindType::Long