ruby-oci8 2.2.6.1 → 2.2.7

data/lib/oci8/cursor.rb

@@ -25,7 +25,11 @@ class OCI8
       @names = nil
       @con = conn
       @max_array_size = nil
+      @fetch_array_size = nil
+      @rowbuf_size = 0
+      @rowbuf_index = 0
       __initialize(conn, sql) # Initialize the internal C structure.
+      self.prefetch_rows = conn.instance_variable_get(:@prefetch_rows)
     end
 
     # explicitly indicate the date type of fetched value. run this
@@ -38,7 +42,7 @@ class OCI8
     #   cursor.define(2, Time)       # fetch the second column as Time.
     #   cursor.exec()
     def define(pos, type, length = nil)
-      bindobj = make_bind_object(:type => type, :length => length)
+      bindobj = make_bind_object({:type => type, :length => length}, @fetch_array_size || 1)
       __define(pos, bindobj)
       if old = @define_handles[pos - 1]
         old.send(:free)
@@ -126,6 +130,8 @@ class OCI8
       when :select_stmt
         __execute(0)
         define_columns() if @column_metadata.size == 0
+        @rowbuf_size = 0
+        @rowbuf_index = 0
         @column_metadata.size
       else
         __execute(1)
@@ -384,6 +390,7 @@ class OCI8
     # @param [Integer] rows The number of rows to be prefetched
     def prefetch_rows=(rows)
       attr_set_ub4(11, rows) # OCI_ATTR_PREFETCH_ROWS(11)
+      @prefetch_rows = rows
     end
 
     if OCI8::oracle_client_version >= ORAVER_12_1
@@ -468,7 +475,7 @@ class OCI8
 
     private
 
-    def make_bind_object(param)
+    def make_bind_object(param, fetch_array_size = nil)
       case param
       when Hash
         key = param[:type]
@@ -510,22 +517,37 @@ class OCI8
         OCI8::BindType::Mapping[key] = bindclass if bindclass
       end
       raise "unsupported datatype: #{key}" if bindclass.nil?
-      bindclass.create(@con, val, param, max_array_size)
+      bindclass.create(@con, val, param, fetch_array_size || max_array_size)
     end
 
+    @@use_array_fetch = false
+
     def define_columns
       # http://docs.oracle.com/cd/E11882_01/appdev.112/e10646/ociaahan.htm#sthref5494
       num_cols = attr_get_ub4(18) # OCI_ATTR_PARAM_COUNT(18)
-      1.upto(num_cols) do |i|
-        parm = __paramGet(i)
-        define_one_column(i, parm) unless @define_handles[i - 1]
-        @column_metadata[i - 1] = parm
+      @column_metadata = 1.upto(num_cols).collect do |i|
+        __paramGet(i)
+      end
+      if @define_handles.size == 0
+        use_array_fetch = @@use_array_fetch
+        @column_metadata.each do |md|
+          case md.data_type
+          when :clob, :blob, :bfile
+            # Rows prefetching doesn't work for CLOB, BLOB and BFILE.
+            # Use array fetching to get more than one row in a network round trip.
+            use_array_fetch = true
+          end
+        end
+        @fetch_array_size = @prefetch_rows if use_array_fetch
+      end
+      @column_metadata.each_with_index do |md, i|
+        define_one_column(i + 1, md) unless @define_handles[i]
       end
       num_cols
     end
 
     def define_one_column(pos, param)
-      bindobj = make_bind_object(param)
+      bindobj = make_bind_object(param, @fetch_array_size || 1)
       __define(pos, bindobj)
       @define_handles[pos - 1] = bindobj
     end
@@ -540,22 +562,33 @@ class OCI8
       end
     end
 
+    def fetch_row_internal
+      if @rowbuf_size && @rowbuf_size == @rowbuf_index
+        @rowbuf_size = __fetch(@con, @fetch_array_size || 1)
+        @rowbuf_index = 0
+      end
+      @rowbuf_size
+    end
+
     def fetch_one_row_as_array
-      if __fetch(@con)
-        @define_handles.collect do |handle|
-          handle.send(:get_data)
+      if fetch_row_internal
+        ret = @define_handles.collect do |handle|
+          handle.send(:get_data, @rowbuf_index)
         end
+        @rowbuf_index += 1
+        ret
       else
         nil
       end
     end
 
     def fetch_one_row_as_hash
-      if __fetch(@con)
+      if fetch_row_internal
         ret = {}
         get_col_names.each_with_index do |name, idx|
-          ret[name] = @define_handles[idx].send(:get_data)
+          ret[name] = @define_handles[idx].send(:get_data, @rowbuf_index)
         end
+        @rowbuf_index += 1
         ret
       else
         nil

data/lib/oci8/oci8.rb

@@ -169,7 +169,6 @@ class OCI8
   # @private
   def parse_internal(sql)
     cursor = OCI8::Cursor.new(self, sql)
-    cursor.prefetch_rows = @prefetch_rows if @prefetch_rows
     cursor
   end
 
@@ -305,6 +304,7 @@ class OCI8
   # @return [Array] an array of first row.
   def select_one(sql, *bindvars)
     cursor = self.parse(sql)
+    cursor.prefetch_rows = 1
     begin
       cursor.exec(*bindvars)
       row = cursor.fetch

data/lib/oci8/version.rb

@@ -1,3 +1,3 @@
 class OCI8
-  VERSION = "2.2.6.1"
+  VERSION = "2.2.7"
 end

data/ruby-oci8.gemspec

@@ -34,7 +34,6 @@ spec = Gem::Specification.new do |s|
   s.description = <<EOS
 ruby-oci8 is a ruby interface for Oracle using OCI8 API. It is available with Oracle 10g or later including Oracle Instant Client.
 EOS
-  s.has_rdoc = 'yard'
   s.authors = ['Kubo Takehiro']
   s.platform = gem_platform
   s.license = 'BSD-2-Clause'
@@ -79,7 +78,7 @@ EOS
     end
     files << 'lib/oci8.rb'
   end
-  s.require_paths = ['lib', 'ext/oci8']
+  s.require_paths = ['lib']
   s.files = files
   s.test_files = 'test/test_all.rb'
   s.extra_rdoc_files = ['README.md']

data/test/README.md

@@ -0,0 +1,40 @@
+Before running unit test:
+
+1. Connect to Oracle as sys
+   ```shell
+   $ sqlplus sys/<password_of_sys> as sysdba
+   SQL>
+   ```
+2. Create user ruby
+   ```sql
+   SQL> CREATE USER ruby IDENTIFIED BY oci8;
+   ```
+   or
+   ```sql
+   SQL> CREATE USER ruby IDENTIFIED BY oci8
+      2 DEFAULT TABLESPACE users TEMPORARY TABLESPACE temp;
+   ```
+3. Grant the privilege to connect and execute.
+   ```sql
+    SQL> GRANT connect, resource, create view, create synonym TO ruby;
+    SQL> GRANT execute ON dbms_lock TO ruby;
+    ```
+4. Connect as ruby user.
+   ```shell
+   $ sqlplus ruby/oci8
+   SQL>
+   ```
+5. Create object types
+   ```sql
+   SQL> @test/setup_test_object.sql
+   ```
+6. change $dbname in test/config.rb.
+
+Then run the following command:
+```shell
+$ make check
+```
+or
+```
+$ nmake check   (If your compiler is MS Visual C++.)
+````

data/test/config.rb

@@ -134,7 +134,7 @@ class Minitest::Test
 
   def get_oci8_connection()
     OCI8.new($dbuser, $dbpass, $dbname)
-      rescue OCIError
+  rescue OCIError
     raise if $!.code != 12516 && $!.code != 12520
     # sleep a few second and try again if
     # the error code is ORA-12516 or ORA-12520.

data/test/test_oci8.rb

@@ -25,53 +25,142 @@ EOS
     drop_table('test_rename_table')
   end
 
-  # USE_DYNAMIC_FETCH doesn't work well...
-  # This test is disabled.
-  def _test_long_type
-    drop_table('test_table')
-    @conn.exec('CREATE TABLE test_table (id number(38), lng long)')
-    test_data1 = 'a' * 70000
-    test_data2 = 'b' * 3000
-    test_data3 = nil
-    test_data4 = 'c' * 70000
-    @conn.exec('insert into test_table values (:1, :2)', 1, test_data1)
-    @conn.exec('insert into test_table values (:1, :2)', 2, [test_data2, :long])
-    @conn.exec('insert into test_table values (:1, :2)', 3, [nil, :long])
-    @conn.exec('insert into test_table values (:1, :2)', 4, [test_data4, :long])
-
-    [8000, 65535, 65536, 80000].each do |read_len|
-      @conn.long_read_len = read_len
-      cursor = @conn.parse('SELECT lng from test_table order by id')
-      cursor.exec
-      assert_equal(test_data1, cursor.fetch[0])
-      assert_equal(test_data2, cursor.fetch[0])
-      assert_equal(test_data3, cursor.fetch[0])
-      assert_equal(test_data4, cursor.fetch[0])
-      cursor.close
+  # Set `OCI8::BindType::Base.initial_chunk_size = 5` to
+  # use the following test data.
+  LONG_TEST_DATA = [
+    # initial chunk size: 5 (total buffer size: 5)
+    'a' * 4, 'b' * 5, 'c' * 6, 'd' * 5, 'e' * 4,
+    # second chunk size: 10 (total buffer size: 15)
+    'f' * 14, 'g' * 15, 'h' * 16, 'i' * 15, 'j' * 14,
+    # third chunk size: 20 (total buffer size: 35)
+    'k' * 34, 'l' * 35, 'm' * 36, 'n' * 35, 'o' * 34,
+    # use data around initial chunk size again
+    'p' * 4, 'q' * 5, 'r' * 6, 's' * 5, 't' * 4,
+    # special data
+    '', nil,
+  ]
+
+  def test_long_type
+    clob_bind_type = OCI8::BindType::Mapping[:clob]
+    blob_bind_type = OCI8::BindType::Mapping[:blob]
+    initial_cunk_size = OCI8::BindType::Base.initial_chunk_size
+    begin
+      OCI8::BindType::Base.initial_chunk_size = 5
+      @conn.prefetch_rows = LONG_TEST_DATA.size / 3
+      drop_table('test_table')
+      ascii_enc = Encoding.find('US-ASCII')
+      0.upto(1) do |i|
+        if i == 0
+          @conn.exec("CREATE TABLE test_table (id number(38), long_column long, clob_column clob)")
+          cursor = @conn.parse('insert into test_table values (:1, :2, :3)')
+          cursor.bind_param(1, nil, Integer)
+          cursor.bind_param(2, nil, :long)
+          cursor.bind_param(3, nil, :clob)
+          lob = OCI8::CLOB.new(@conn, '')
+          enc = Encoding.default_internal || OCI8.encoding
+        else
+          @conn.exec("CREATE TABLE test_table (id number(38), long_raw_column long raw, blob_column blob)")
+          cursor = @conn.parse('insert into test_table values (:1, :2, :3)')
+          cursor.bind_param(1, nil, Integer)
+          cursor.bind_param(2, nil, :long_raw)
+          cursor.bind_param(3, nil, :blob)
+          lob = OCI8::BLOB.new(@conn, '')
+          enc = Encoding.find('ASCII-8BIT')
+        end
+
+        LONG_TEST_DATA.each_with_index do |data, index|
+          cursor[1] = index
+          cursor[2] = data
+          if data.nil?
+            cursor[3] = nil
+          else
+            lob.rewind
+            lob.write(data)
+            lob.size = data.size
+            cursor[3] = lob
+          end
+          cursor.exec
+        end
+        cursor.close
+
+        cursor = @conn.parse('SELECT * from test_table order by id')
+        cursor.exec
+        LONG_TEST_DATA.each_with_index do |data, index|
+          row = cursor.fetch
+          assert_equal(index, row[0])
+          if data.nil?
+            assert_nil(row[1])
+            assert_nil(row[2])
+          elsif data.empty?
+            # '' is inserted to the long or long raw column as null.
+            assert_nil(row[1])
+            # '' is inserted to the clob or blob column as an empty clob.
+            # It is fetched as '' when the data is read using a LOB locator.
+            assert_equal(data, clob_data = row[2].read)
+            assert_equal(ascii_enc, clob_data.encoding)
+          else
+            assert_equal(data, row[1])
+            assert_equal(data, clob_data = row[2].read)
+            assert_equal(enc, row[1].encoding)
+            assert_equal(enc, clob_data.encoding)
+          end
+        end
+        assert_nil(cursor.fetch)
+        cursor.close
+
+        begin
+          OCI8::BindType::Mapping[:clob] = OCI8::BindType::Long
+          OCI8::BindType::Mapping[:blob] = OCI8::BindType::LongRaw
+          cursor = @conn.parse('SELECT * from test_table order by id')
+          cursor.exec
+          LONG_TEST_DATA.each_with_index do |data, index|
+            row = cursor.fetch
+            assert_equal(index, row[0])
+            if data.nil?
+              assert_nil(row[1])
+              assert_nil(row[2])
+            elsif data.empty?
+              # '' is inserted to the long or long raw column as null.
+              assert_nil(row[1])
+              # '' is inserted to the clob or blob column as an empty clob.
+              # However it is fetched as nil.
+              assert_nil(row[2])
+            else
+              assert_equal(data, row[1])
+              assert_equal(data, row[2])
+              assert_equal(enc, row[1].encoding)
+              assert_equal(enc, row[2].encoding)
+            end
+          end
+          assert_nil(cursor.fetch)
+          cursor.close
+        ensure
+          OCI8::BindType::Mapping[:clob] = clob_bind_type
+          OCI8::BindType::Mapping[:blob] = blob_bind_type
+        end
+        drop_table('test_table')
+      end
+    ensure
+      OCI8::BindType::Base.initial_chunk_size = initial_cunk_size
     end
     drop_table('test_table')
   end
 
-  def test_long_type
-    @conn.long_read_len = 80000
-    drop_table('test_table')
-    @conn.exec('CREATE TABLE test_table (id number(38), lng long)')
-    test_data1 = 'a' * 70000
-    test_data2 = 'b' * 3000
-    test_data4 = 'c' * 70000
-    @conn.exec('insert into test_table values (:1, :2)', 1, test_data1)
-    @conn.exec('insert into test_table values (:1, :2)', 2, [test_data2, :long])
-    @conn.exec('insert into test_table values (:1, :2)', 3, [nil, :long])
-    @conn.exec('insert into test_table values (:1, :2)', 4, [test_data4, :long])
-
-    cursor = @conn.parse('SELECT lng from test_table order by id')
-    cursor.exec
-    assert_equal(test_data1, cursor.fetch[0])
-    assert_equal(test_data2, cursor.fetch[0])
-    assert_nil(cursor.fetch[0])
-    assert_equal(test_data4, cursor.fetch[0])
-    cursor.close
-    drop_table('test_table')
+  def test_bind_long_data
+    initial_cunk_size = OCI8::BindType::Base.initial_chunk_size
+    begin
+      OCI8::BindType::Base.initial_chunk_size = 5
+      cursor = @conn.parse("begin :1 := '<' || :2 || '>'; end;")
+      cursor.bind_param(1, nil, :long)
+      cursor.bind_param(2, nil, :long)
+      (LONG_TEST_DATA + ['z' * 4000]).each do |data|
+        cursor[2] = data
+        cursor.exec
+        assert_equal("<#{data}>", cursor[1])
+      end
+    ensure
+      OCI8::BindType::Base.initial_chunk_size = initial_cunk_size
+    end
   end
 
   def test_select
@@ -450,6 +539,7 @@ EOS
     assert_nil(@conn.last_error)
     @conn.last_error = 'dummy'
     cursor = @conn.parse('select col1, max(col2) from (select 1 as col1, null as col2 from dual) group by col1')
+    cursor.prefetch_rows = 1
     assert_nil(@conn.last_error)
 
     # When an OCI function returns OCI_SUCCESS_WITH_INFO, OCI8#last_error is set.
@@ -510,4 +600,25 @@ EOS
           end
     assert_equal(ver, @conn.oracle_server_version.to_s)
   end
+
+  def test_array_fetch
+    drop_table('test_table')
+    @conn.exec("CREATE TABLE test_table (id number, val clob)")
+    cursor = @conn.parse("INSERT INTO test_table VALUES (:1, :2)")
+    1.upto(10) do |i|
+      cursor.exec(i, ('a'.ord + i).chr * i)
+    end
+    cursor.close
+    cursor = @conn.parse("select * from test_table where id <= :1 order by id")
+    cursor.prefetch_rows = 4
+    [1, 6, 2, 7, 3, 8, 4, 9, 5, 10].each do |i|
+      cursor.exec(i)
+      1.upto(i) do |j|
+        row = cursor.fetch
+        assert_equal(j, row[0])
+        assert_equal(('a'.ord + j).chr * j, row[1].read)
+      end
+      assert_nil(cursor.fetch)
+    end
+  end
 end # TestOCI8

metadata

@@ -5,9 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 2
   - 2
-  - 6
-  - 1
-  version: 2.2.6.1
+  - 7
+  version: 2.2.7
 platform: ruby
 authors: 
 - Kubo Takehiro
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2018-09-16 00:00:00 +09:00
+date: 2019-01-06 00:00:00 +09:00
 default_executable: 
 dependencies: []
 
@@ -112,7 +111,7 @@ files:
 - lib/oci8/properties.rb
 - lib/oci8/version.rb
 - lib/ruby-oci8.rb
-- test/README
+- test/README.md
 - test/config.rb
 - test/setup_test_object.sql
 - test/setup_test_package.sql
@@ -152,7 +151,6 @@ rdoc_options: []
 
 require_paths: 
 - lib
-- ext/oci8
 required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: