ruby-oci8 2.0.6 → 2.1.0

data/NEWS

@@ -1,3 +1,114 @@
+2.1.0:
+
+*** Ruby-oci8 2.1.0 doesn't support Oracle 8 (8.0) and Oracle 8i (8.1) anymore. ***
+
+* New Features
+
+  - OCI connection pooling
+
+    See: http://docs.oracle.com/cd/E11882_01/appdev.112/e10646/oci09adv.htm#sthref1479
+    and http://docs.oracle.com/cd/E11882_01/java.112/e16548/ociconpl.htm#JJDBC28789
+
+    Example:
+
+      # Create a connection pool.
+      # username and password are required to establish an implicit primary session.
+      cpool = OCI8::ConnectionPool.new(1, 5, 2, username, password, database)
+
+      # Get a session from the pool.
+      # Pass the connection pool to the third argument.
+      conn1 = OCI8.new(username, password, cpool)
+
+      # Get another session.
+      conn2 = OCI8.new(username, password, cpool)
+
+  - Daylight saving time aware if TZ is set.
+
+    You should set the environment variable TZ if your applications run
+    in a time zone with daylight saving time transitions.
+    Otherwise, Oracle session time zone is set with current constant
+    offset from GMT.
+    (reported by Yasuo Honda)
+
+  - connect as sysasm (Oracle 11g only)
+
+      OCI8.new('username/password as sysasm')
+    or
+      OCI8.new('username', 'password', nil, :SYSASM)
+
+  - Oracle number is converted to ruby float exactly same as ruby does.
+
+    From ruby 1.9.2, a float value converted from Oracle number 15.7 by
+    the Oracle function OCINumberToReal() makes a string representation
+    15.700000000000001 by Float#to_s. (See: http://redmine.ruby-lang.org/issues/4656)
+    To avoid this issue, any Oracle number is converted to a float as
+    ruby's String#to_f does.
+
+    The behavior is customizable by OCI8.properties[:float_conversion_type].
+
+      OCI8.properties[:float_conversion_type] = :oracle # => Use OCINumberToReal()
+      OCI8.properties[:float_conversion_type] = :ruby # => Use String#to_f
+
+    The default value is :ruby.
+
+  - OCI_SUCCESS_WITH_INFO handling is changed.
+
+    Ruby-oci8 2.0 treats OCI_SUCCESS_WITH_INFO in OCI layer as an error
+    and raise an exception OCISuccessWithInfo such as "ORA-24347: Warning of
+    a NULL column in an aggregate function" and "ORA-28002: the password will
+    expire within xx days."
+
+    From 2.1.0, it is treated as a warning and the exception is set
+    to OCI8#last_error.
+
+  - OCI8#last_error
+
+    The last error or warning associated with the session is set to
+    OCI8#last_error. The usecase is to detect OCI_SUCCESS_WITH_INFO.
+    It is reset by OCI8#exec and OCI8#parse.
+
+  - Experimental support of character length semantics
+
+    This is enabled when :char is set to OCI8.properties[:length_semantics].
+
+  - OCI8.client_charset_name and OCI8#database_charset_name is added.
+
+    They return Oracle charset name such as WE8ISO8859P15.
+
+* Specification changes
+
+  - The parent class OCINoData was changed from OCIException to OCIError.
+
+* Fixed Issues
+
+  - Fix a bug that an array is always bound as null.
+    This bug was introduced in ruby-oci8 2.0.5.
+    (reported by Leoš Bitto)
+
+  - Avoid a gcc internal compiler error when using ruby1.9.2-p290 on
+    ubuntu 11.10 (64bit). (reported by Bob Saveland.)
+
+  - Fix compilation problems on Solaris.
+    (Reported by Sanjiv Patel.)
+
+  - Fix compilation problems on Linux.
+    (Reported by Edgars Beigarts.)
+
+  - Connections are released by GC without explicit logoff.
+
+  - Set ruby encoding CP950 for oracle characterset ZHT16MSWIN950 and
+    CP951 for ZHT16HKSCS and ZHT16HKSCS31 when the ruby is 1.9.3.
+
+  - Clear an executuing thread information in a connection when a SQL
+    executions is canceled by Thread#kill or Timeout::timeout.
+    (reported by Aaron Qian)
+
+  - Fix some test cases for object type and TZ issues.
+    (reported by Yasuo Honda)
+
+  - Use Gem::Command.build_args to get arguments after '--'.
+    (reported by jbirdjavi)
+
 2.0.6:
 
 * Fixed issues

data/README

@@ -1,86 +1,5 @@
-= How to make
+Ruby-oci8 is a ruby interface for Oracle using OCI8 API. 
+The latest version (2.1.x) works with Oracle9i or later.
+Use ruby-oci8 2.0.6 or earlier for Oracle 8.
 
-* <tt>ruby</tt> and <tt>make</tt> (or nmake on MSVC) commands in the environment variable <tt>PATH</tt>?
-* <tt>ruby</tt> is 1.8.0 or later? (Use ruby-oci8 0.1.x for ruby 1.6.x.)
-
-== For OCI installed by Oracle Universal Installer
-make sure the environment variable ORACLE_HOME (or registry on Windows)
-is set correctly. run the the following commands.
-
-  make (or nmake on MSVC)
-
-== For OCI installed by Oracle Instant Installer
-
-linux:
-  ruby setup.rb config -- --with-instant-client
-  make
-
-others:
-  ruby setup.rb config -- --with-instant-client=/path/to/instantclient10_1
-  make (or nmake on MSVC)
-
-= On compilation failure
-
-Please report the following information to kubo@jiubao.org.
-
-* last 100 lines of 'ext/oci8/mkmf.log'.
-* the results of the following commands:
-    ruby -r rbconfig -e "p Config::CONFIG['host']"
-    ruby -r rbconfig -e "p Config::CONFIG['CC']"
-    ruby -r rbconfig -e "p Config::CONFIG['CFLAGS']"
-    ruby -r rbconfig -e "p Config::CONFIG['LDSHARED']"
-    ruby -r rbconfig -e "p Config::CONFIG['LDFLAGS']"
-    ruby -r rbconfig -e "p Config::CONFIG['LIBS']"
-    ruby -r rbconfig -e "p Config::CONFIG['GNU_LD']"
-* if you use gcc:
-    gcc --print-prog-name=ld
-    gcc --print-prog-name=as
-* on platforms which can use both 32bit/64bit binaries:
-    file $ORACLE_HOME/bin/oracle
-    file `which ruby`
-    echo $LD_LIBRARY_PATH
-
-= How to run unit test
-
-before runing unit test, 
-1. connect to Oracle as system:
-
-    $ sqlplus system/<password_of_system>
-
-2. create user ruby:
-
-    SQL> CREATE USER ruby IDENTIFIED BY oci8;
-
-   or
-
-    SQL> CREATE USER ruby IDENTIFIED BY oci8
-       2 DEFAULT TABLESPACE users TEMPORARY TABLESPACE temp;
-
-3. grant the privilege to connect and execute.
-
-    SQL> GRANT connect, resource TO ruby;
-
-4. If the Oracle version is 8i or later:
-
-    SQL> CREATE TABLE ruby.test_clob (filename VARCHAR2(40), content CLOB);
-
-5. connect to Oracle as sys
-
-    $ sqlplus 'sys/<password_of_sys> as sysdba'
-
-6. grant the privilege for the unittest of blocking-mode.
-
-    SQL> GRANT EXECUTE ON dbms_lock TO ruby;
-
-7. change test/config.rb as you like
-
-Then you can run:
-  $ make check
-or
-  $ nmake check   (If your compiler is MS Visual C++.)
-
-= TODO
-
-* more proper handling of OCI_SUCCESS_WITH_INFO.
-* more proper handling of NUMBER without its scale values.
-* support Timestamp.
+See: http://ruby-oci8.rubyforge.org

data/VERSION

@@ -1 +1 @@
-2.0.6
+2.1.0

data/dist-files

@@ -21,12 +21,14 @@ ext/oci8/apiwrap.rb
 ext/oci8/apiwrap.yml
 ext/oci8/attr.c
 ext/oci8/bind.c
+ext/oci8/connection_pool.c
 ext/oci8/encoding.c
 ext/oci8/env.c
 ext/oci8/error.c
 ext/oci8/extconf.rb
 ext/oci8/lob.c
 ext/oci8/metadata.c
+ext/oci8/object.c
 ext/oci8/oci8.c
 ext/oci8/oci8.h
 ext/oci8/oci8lib.c
@@ -39,21 +41,23 @@ ext/oci8/oranumber_util.c
 ext/oci8/oranumber_util.h
 ext/oci8/post-config.rb
 ext/oci8/stmt.c
-ext/oci8/object.c
+ext/oci8/thread_util.c
+ext/oci8/thread_util.h
 ext/oci8/win32.c
-ext/oci8/xmldb.c
 lib/.document
 lib/oci8.rb.in
 lib/dbd/OCI8.rb
 lib/oci8/.document
 lib/oci8/bindtype.rb
 lib/oci8/compat.rb
+lib/oci8/connection_pool.rb
 lib/oci8/datetime.rb
 lib/oci8/encoding-init.rb
 lib/oci8/encoding.yml
 lib/oci8/metadata.rb
 lib/oci8/object.rb
 lib/oci8/oci8.rb
+lib/oci8/ocihandle.rb
 lib/oci8/oracle_version.rb
 lib/oci8/properties.rb
 test/README
@@ -62,14 +66,17 @@ test/test_all.rb
 test/test_appinfo.rb
 test/test_array_dml.rb
 test/test_bind_raw.rb
+test/test_bind_string.rb
 test/test_bind_time.rb
 test/test_break.rb
 test/test_clob.rb
+test/test_connection_pool.rb
 test/test_connstr.rb
 test/test_encoding.rb
 test/test_datetime.rb
 test/test_dbi.rb
 test/test_dbi_clob.rb
+test/test_error.rb
 test/test_metadata.rb
 test/test_oci8.rb
 test/test_oracle_version.rb

data/ext/oci8/.document

@@ -15,3 +15,4 @@ ocinumber.c
 ocidatetime.c
 oradate.c
 object.c
+connection_pool.c

data/ext/oci8/apiwrap.c.tmpl

@@ -4,6 +4,12 @@
 %>
 #define API_WRAP_C 1
 #include "apiwrap.h"
+#ifdef HAVE_RB_THREAD_BLOCKING_REGION
+#define BLOCKING_FUNCTION_EPILOGUE(svcctx) do { (svcctx)->executing_thread = Qnil; } while (0)
+#else
+#define BLOCKING_FUNCTION_EPILOGUE(svcctx) do { } while (0)
+#endif
+
 <%
 prev_name = ''
 funcs.each do |f|
@@ -33,6 +39,7 @@ funcs.each do |f|
  * <%=f.name%>_nb
  */
 typedef struct {
+    oci8_svcctx_t *svcctx;
 <%
    f.ret != 'void'
 %>    <%= f.ret %> rv;
@@ -56,9 +63,11 @@ static VALUE oci8_<%=f.name%>_cb(void *user_data)
 %>    data->rv = <%=f.name%>(<%= f.args.collect do |a| 'data->' + a.name; end.join(', ') %>);
 <% end %>
 <% if f.ret == 'sword'
-%>    return (VALUE)data->rv;
+%>    BLOCKING_FUNCTION_EPILOGUE(data->svcctx);
+    return (VALUE)data->rv;
 <% else
-%>    return (VALUE)0;
+%>    BLOCKING_FUNCTION_EPILOGUE(data->svcctx);
+    return (VALUE)0;
 <% end %>
 }
 #else
@@ -69,6 +78,7 @@ static VALUE oci8_<%=f.name%>_cb(void *user_data)
 {
     if (have_<%=f.name%>_nb) {
         oci8_<%=f.name%>_data_t data;
+        data.svcctx = svcctx;
 <% f.args.each do |a|
 %>        data.<%=a.name%> = <%=a.name%>;
 <% end

data/ext/oci8/apiwrap.yml

@@ -220,14 +220,6 @@ OCIDescriptorFree:
             - dvoid *descp
             - ub4 type
 
-OCIEnvInit:
-  :version: 800
-  :args:
-            - OCIEnv **envp
-            - ub4 mode
-            - size_t xtramem_sz
-            - dvoid **usrmempp
-
 OCIErrorGet:
   :version: 800
   :args:
@@ -254,16 +246,6 @@ OCIHandleFree:
             - dvoid *hndlp
             - ub4 type
 
-# round trip: 0
-OCIInitialize:
-  :version: 800
-  :args:
-            - ub4 mode
-            - dvoid *ctxp
-            - dvoid *(*malocfp)(dvoid *ctxp, size_t size)
-            - dvoid *(*ralocfp)(dvoid *ctxp, dvoid *memptr, size_t newsize)
-            - void   (*mfreefp)(dvoid *ctxp, dvoid *memptr)
-
 # round trip: 0
 OCILobAssign:
   :version: 800
@@ -391,7 +373,7 @@ OCILobWrite_nb:
             - ub1 csfrm
 
 # round trip: 1
-OCILogoff_nb:
+OCILogoff:
   :version: 800
   :args:
             - OCISvcCtx *svchp
@@ -835,7 +817,7 @@ OCIRawSize:
             - CONST OCIRaw *raw
 
 # round trip: 1
-OCISessionEnd_nb:
+OCISessionEnd:
   :version: 800
   :args:
             - OCISvcCtx *svchp
@@ -854,7 +836,7 @@ OCIServerAttach_nb:
             - ub4 mode
 
 # round trip: 1
-OCIServerDetach_nb:
+OCIServerDetach:
   :version: 800
   :args:
             - OCIServer *srvhp
@@ -962,6 +944,14 @@ OCITransCommit_nb:
             - OCIError *errhp
             - ub4 flags
 
+# round trip: 1
+OCITransRollback:
+  :version: 800
+  :args:
+            - OCISvcCtx *svchp
+            - OCIError *errhp
+            - ub4 flags
+
 # round trip: 1
 OCITransRollback_nb:
   :version: 800
@@ -1179,6 +1169,32 @@ OCIReset:
 # Oracle 9.0
 #
 
+OCIConnectionPoolCreate:
+  :version: 900
+  :args:
+            - OCIEnv *envhp
+            - OCIError *errhp
+            - OCICPool *poolhp
+            - OraText **poolName
+            - sb4 *poolNameLen
+            - const OraText *dblink
+            - sb4 dblinkLen
+            - ub4 connMin
+            - ub4 connMax
+            - ub4 connIncr
+            - const OraText *poolUserName
+            - sb4 poolUserLen
+            - const OraText *poolPassword
+            - sb4 poolPassLen
+            - ub4 mode
+
+OCIConnectionPoolDestroy:
+  :version: 900
+  :args:
+            - OCICPool *poolhp
+            - OCIError *errhp
+            - ub4 mode
+
 # round trip: 0 (not docmented. I guess.)
 OCIDateTimeConstruct:
   :version: 900

data/ext/oci8/attr.c

@@ -2,54 +2,43 @@
 /*
  * attr.c
  *
- * $Author: kubo $
- * $Date: 2009-05-17 19:08:39 +0900 (Sun, 17 May 2009) $
- *
  * Copyright (C) 2002-2007 KUBO Takehiro <kubo@jiubao.org>
  */
 #include "oci8.h"
 
-VALUE oci8_get_sb1_attr(oci8_base_t *base, ub4 attrtype)
+VALUE oci8_get_sb1_attr(oci8_base_t *base, ub4 attrtype, OCIStmt *stmtp)
 {
     sb1 val;
-    sword rv;
 
-    rv = OCIAttrGet(base->hp.ptr, base->type, &val, NULL, attrtype, oci8_errhp);
-    if (rv != OCI_SUCCESS)
-        oci8_raise(oci8_errhp, rv, NULL);
+    chker3(OCIAttrGet(base->hp.ptr, base->type, &val, NULL, attrtype, oci8_errhp),
+           base, stmtp);
     return INT2FIX(val);
 }
 
-VALUE oci8_get_ub2_attr(oci8_base_t *base, ub4 attrtype)
+VALUE oci8_get_ub2_attr(oci8_base_t *base, ub4 attrtype, OCIStmt *stmtp)
 {
     ub2 val;
-    sword rv;
 
-    rv = OCIAttrGet(base->hp.ptr, base->type, &val, NULL, attrtype, oci8_errhp);
-    if (rv != OCI_SUCCESS)
-        oci8_raise(oci8_errhp, rv, NULL);
+    chker3(OCIAttrGet(base->hp.ptr, base->type, &val, NULL, attrtype, oci8_errhp),
+           base, stmtp);
     return INT2FIX(val);
 }
 
-VALUE oci8_get_sb2_attr(oci8_base_t *base, ub4 attrtype)
+VALUE oci8_get_sb2_attr(oci8_base_t *base, ub4 attrtype, OCIStmt *stmtp)
 {
     sb2 val;
-    sword rv;
 
-    rv = OCIAttrGet(base->hp.ptr, base->type, &val, NULL, attrtype, oci8_errhp);
-    if (rv != OCI_SUCCESS)
-        oci8_raise(oci8_errhp, rv, NULL);
+    chker3(OCIAttrGet(base->hp.ptr, base->type, &val, NULL, attrtype, oci8_errhp),
+           base, stmtp);
     return INT2FIX(val);
 }
 
-VALUE oci8_get_ub4_attr(oci8_base_t *base, ub4 attrtype)
+VALUE oci8_get_ub4_attr(oci8_base_t *base, ub4 attrtype, OCIStmt *stmtp)
 {
     ub4 val;
-    sword rv;
 
-    rv = OCIAttrGet(base->hp.ptr, base->type, &val, NULL, attrtype, oci8_errhp);
-    if (rv != OCI_SUCCESS)
-        oci8_raise(oci8_errhp, rv, NULL);
+    chker3(OCIAttrGet(base->hp.ptr, base->type, &val, NULL, attrtype, oci8_errhp),
+           base, stmtp);
 #if SIZEOF_LONG > 4
     return LONG2FIX(val);
 #else
@@ -57,15 +46,13 @@ VALUE oci8_get_ub4_attr(oci8_base_t *base, ub4 attrtype)
 #endif
 }
 
-VALUE oci8_get_string_attr(oci8_base_t *base, ub4 attrtype)
+VALUE oci8_get_string_attr(oci8_base_t *base, ub4 attrtype, OCIStmt *stmtp)
 {
     text *val;
     ub4 size;
-    sword rv;
 
-    rv = OCIAttrGet(base->hp.ptr, base->type, &val, &size, attrtype, oci8_errhp);
-    if (rv != OCI_SUCCESS)
-        oci8_raise(oci8_errhp, rv, NULL);
+    chker3(OCIAttrGet(base->hp.ptr, base->type, &val, &size, attrtype, oci8_errhp),
+           base, stmtp);
     return rb_external_str_new_with_enc(TO_CHARPTR(val), size, oci8_encoding);
 }
 
@@ -73,6 +60,7 @@ VALUE oci8_get_string_attr(oci8_base_t *base, ub4 attrtype)
 
 typedef struct {
     oci8_base_t *base;
+    OCIStmt *stmtp;
     ub4 attrtype;
     OCIRowid *ridp;
 } rowid_arg_t;
@@ -89,52 +77,12 @@ static VALUE get_rowid_attr(rowid_arg_t *arg)
     rv = OCIDescriptorAlloc(oci8_envhp, (dvoid*)&arg->ridp, OCI_DTYPE_ROWID, 0, NULL);
     if (rv != OCI_SUCCESS)
         oci8_env_raise(oci8_envhp, rv);
-    rv = OCIAttrGet(base->hp.ptr, base->type, arg->ridp, 0, attrtype, oci8_errhp);
-    if (rv != OCI_SUCCESS) {
-        oci8_raise(oci8_errhp, rv, NULL);
-    }
+    chker3(OCIAttrGet(base->hp.ptr, base->type, arg->ridp, 0, attrtype, oci8_errhp),
+           base, arg->stmtp);
     /* convert the rowid descriptor to a string. */
-    if (have_OCIRowidToChar) {
-        /* If OCIRowidToChar is available, use it. */
-        buflen = MAX_ROWID_LEN;
-        rv = OCIRowidToChar(arg->ridp, TO_ORATEXT(buf), &buflen, oci8_errhp);
-        if (rv != OCI_SUCCESS) {
-            oci8_raise(oci8_errhp, rv, NULL);
-        }
-    } else {
-        /* If OCIRowidToChar is not available, convert it on
-         * Oracle Server.
-         */
-        oci8_base_t *svc;
-        oci8_exec_sql_var_t define_var;
-        oci8_exec_sql_var_t bind_var;
-
-        /* search a connection from the handle */
-        svc = base;
-        while (svc->type != OCI_HTYPE_SVCCTX) {
-            svc = svc->parent;
-            if (svc == NULL) {
-                rb_raise(rb_eRuntimeError, "No connection is found!!");
-            }
-        }
-        /* :strval */
-        define_var.valuep = buf;
-        define_var.value_sz = sizeof(buf);
-        define_var.dty = SQLT_CHR;
-        define_var.indp = NULL;
-        define_var.alenp = &buflen;
-        /* :rowid */
-        bind_var.valuep = &arg->ridp;
-        bind_var.value_sz = sizeof(void *);
-        bind_var.dty = SQLT_RDD;
-        bind_var.indp = NULL;
-        bind_var.alenp = NULL;
-        /* convert the rowid descriptor to a string value by querying Oracle server. */
-        oci8_exec_sql((oci8_svcctx_t*)svc, "SELECT :rid FROM dual", 1, &define_var, 1, &bind_var, 1);
-        if (buflen == 0) {
-            return Qnil;
-        }
-    }
+    buflen = MAX_ROWID_LEN;
+    chker3(OCIRowidToChar(arg->ridp, TO_ORATEXT(buf), &buflen, oci8_errhp),
+           base, arg->stmtp);
     return rb_external_str_new_with_enc(buf, buflen, rb_usascii_encoding());
 }
 
@@ -146,10 +94,11 @@ static VALUE rowid_ensure(rowid_arg_t *arg)
     return Qnil;
 }
 
-VALUE oci8_get_rowid_attr(oci8_base_t *base, ub4 attrtype)
+VALUE oci8_get_rowid_attr(oci8_base_t *base, ub4 attrtype, OCIStmt *stmtp)
 {
     rowid_arg_t arg;
     arg.base = base;
+    arg.stmtp = stmtp;
     arg.attrtype = attrtype;
     arg.ridp = NULL;
     return rb_ensure(get_rowid_attr, (VALUE)&arg, rowid_ensure, (VALUE)&arg);