ruby-oci8 2.2.3 → 2.2.12

data/docs/number-type-mapping.md

@@ -0,0 +1,79 @@
+# @title Number Type Mapping between Oracle and Ruby
+
+Number Type Mapping between Oracle and Ruby
+===========================================
+
+Default mapping
+---------------
+
+Oracle numbers in select statements are fetched as followings by default:
+
+| Oracle Data Type | Ruby Class |
+|---|---|
+| NUMBER(prec) or NUMBER(prec, 0) | Integer |
+| NUMBER(prec, scale) where prec < 15 and scale != 0 | Float |
+| NUMBER(prec, scale) where prec >= 15 and scale != 0 | BigDecimal |
+| FLOAT or FLOAT(prec) | Float |
+| NUMBER without precision and scale | BigDecimal |
+| number type returned by functions or calculated number | BigDecimal |
+| BINARY_FLOAT | Float |
+| BINARY_DOUBLE | Float |
+
+When the data type is within Integer or Float class, it is fetched
+as Integer or Float. Otherwise, BigDecimal.
+
+Note that the mapping is determined by the column definition in
+select statements, not by the actual value fetched.
+For example the column in `select count(*) from table_name` is
+fetched as BigDecimal because it is returned from `count` function.
+
+The mapping is customizable by `OCI8::BindType::Mapping`.
+The default values of Oracle number data type mapping are:
+
+    # NUMBER or FLOAT data type, used for the first six rows in the above table
+    OCI8::BindType::Mapping[:number] = OCI8::BindType::Number
+    # BINARY_FLOAT data type, used for the seventh row in the above table
+    OCI8::BindType::Mapping[:binary_float] = OCI8::BindType::BinaryDouble
+    # BINARY_DOUBLE data type, used for the eighth row in the above table
+    OCI8::BindType::Mapping[:binary_double] = OCI8::BindType::BinaryDouble
+
+`OCI8::BindType::Number` checks precision and scale to determine
+ruby class. The first four rows in the above table are hard-coded.
+The fifth and sixth rows are, however, customizable by
+`OCI8::BindType::Mapping[:number_no_prec_setting]` and
+`OCI8::BindType::Mapping[:number_unknown_prec]` respectively.
+
+The default values are:
+
+    OCI8::BindType::Mapping[:number_no_prec_setting] = OCI8::BindType::BigDecimal
+    OCI8::BindType::Mapping[:number_unknown_prec] = OCI8::BindType::BigDecimal
+
+The mapping may be changed as follows in future.
+
+| Oracle Data Type | Ruby Class |
+|---|---|
+| NUMBER(prec) or NUMBER(prec, 0) | Integer |
+| other NUMBER  | OraNumber |
+| BINARY_FLOAT | Float |
+| BINARY_DOUBLE | Float |
+
+Customize mapping
+-----------------
+
+Add the following code to fetch all number or float columns as {OraNumber}.
+
+    OCI8::BindType::Mapping[:number] = OCI8::BindType::OraNumber
+
+Otherwise, add the following code to customize the fifth and sixth rows only
+in the above table.
+
+    OCI8::BindType::Mapping[:number_no_prec_setting] = OCI8::BindType::OraNumber
+    OCI8::BindType::Mapping[:number_unknown_prec] = OCI8::BindType::OraNumber
+
+If you want to fetch numbers as Integer or Float by its actual value, use
+the following code:
+
+    # Fetch numbers as Integer when their fractional part is zero.
+    # Otherwise, Float. For example when a column contains 10 and
+    # 10.1, they are fetched as Integer and Float respectively.
+    OCI8::BindType::Mapping[:number] = OCI8::BindType::BasicNumberType

data/docs/platform-specific-issues.md

@@ -1,10 +1,12 @@
 # @title Platform Specific Issues
 
+Platform Specific Issues
+========================
+
 Linux
-=====
+-----
 
-Ubuntu 11.10 (Oneiric Ocelot)
------------------------------
+### Ubuntu 11.10 (Oneiric Ocelot)
 
 If the following error occurs even though libc6-dev is installed,
 
@@ -15,8 +17,7 @@ You need to use ruby-oci8 2.1.0 or upper. Otherwise, run the following command a
 
     $ sudo ln -s /usr/include/linux/ /usr/include/sys
 
-General Linux
--------------
+### General Linux
 
 Use the same bit-width of libraries with ruby. For example, x86\_64
 instant client for x86\_64 ruby and 32-bit instant client for 32-bit
@@ -32,21 +33,18 @@ To check which type of ruby do you use:
 Note: "`" is a back quote.
 
 Mac OS X
-========
+--------
 
-OS X 10.7+
-----------
+### OS X 10.7+
 
 Use the latest 64-bit instant client. The older 64-bit (10.2.0.4) instant client [doesn't work](https://forums.oracle.com/forums/thread.jspa?threadID=2187558). The older 32-bit instant client will work but only with 32-bit ruby or jruby (using JDBC).
 
-Intel Mac (64-bit)
-------------------
+### Intel Mac (64-bit)
 
 See [How to setup Ruby and Oracle Instant Client on Snow Leopard](http://blog.rayapps.com/2009/09/06/how-to-setup-ruby-and-oracle-instant-client-on-snow-leopard/).
 Note that setting the environment variable RC\_ARCHS=x86\_64 instead of ARCHFLAGS="-arch x86\_64" will work fine also.
 
-Intel Mac (32-bit)
-------------------
+### Intel Mac (32-bit)
 
 See [How to setup Ruby and Oracle Instant Client on Snow Leopard](http://blog.rayapps.com/2009/09/06/how-to-setup-ruby-and-oracle-instant-client-on-snow-leopard/). Note that you need to replace x86\_64 with i386 in the blog.
 
@@ -57,13 +55,12 @@ use one of the following workarounds.
 * use [ruby-odbc](http://www.ch-werner.de/rubyodbc/) and a third party ODBC driver ([Actual Technologies](http://www.actualtechnologies.com) or [OpenLink Software](http://uda.openlinksw.com/)).
 * use JRuby and Oracle JDBC driver.
 
-PowerPC Mac
------------
+### PowerPC Mac
 
 See [How to setup Ruby and Oracle Instant Client on Snow Leopard](http://blog.rayapps.com/2009/09/06/how-to-setup-ruby-and-oracle-instant-client-on-snow-leopard/). Note that you need to replace x86\_64 with ppc in the blog.
 
 Solaris
-=======
+-------
 
 You need a same compiler which is used to make ruby itself.
 For example, if the ruby is compiled by gcc, you need gcc. If it is compiled by Oracle Solaris Studio
@@ -83,15 +80,10 @@ as follows:
     to:   CONFIG["LDFLAGS"] = "-L. "
 
 FreeBSD
-=======
-
-There are two ways.
+-------
 
-* use ruby and instant client on linux emulator
-* use oracle8-client port
-
-linux emulator
---------------
+Oracle8-client port isn't available because it is too old.
+You need to use linux emulator.
 
 I have not run ruby-oci8 on linux emulator, but I guess it will
 run as follows. If it works, please tell me.
@@ -129,33 +121,8 @@ On freebsd:
     cd /compat/linux/usr/local
     tar xvfz ruby-1.8.x-linux.tar.gz
 
-oracle8-client port
--------------------
-
-I don't recommend this because of the following two reasons.
-
-* The oracle8-client port is made from Oracle 8.1.7.1 static library for Linux. Oracle have not supported the connectivity between 8.1.7.1 and Oracle 10g.
-* It is very unstable. When it fails to connect to an Oracle server, it is down by segmentation fault on FreeBSD 7.0 not only when using ruby-oci8, but also by a very simple test code written by C.
-
-If you try to use oracle8-client port, compile and install as follows.
-
-* install oracle8-client
-
-    cd /usr/ports/databases/oracle8-client
-    make
-    make install
-
-* set an environment variable ORACLE\_HOME
-
-    export ORACLE_HOME=/usr/local/oracle8-client
-
-The rest steps are described at {file:docs/install-full-client.md}.
-
-note: You have no need to set LD\_LIBRARY\_PATH because 
-Oracle libraries in oracle8-client port are static ones.
-
 HP-UX
-=====
+-----
 
 You need a ruby which is linked with ''libpthread'' and ''libcl''.
 
@@ -174,7 +141,7 @@ and `make install`.
 The rest steps are described at {file:docs/install-full-client.md}.
 
 Windows
-=======
+-------
 
 On some machines using a slow disk, you may get the following error.
 

data/docs/report-installation-issue.md

@@ -1,5 +1,8 @@
 # @title Report Installation Issues
 
+Report Installation Issues
+==========================
+
 Look at {file:docs/platform-specific-issues.md} and [the issues page on github][github] to check whether your issue is fixed or not.
 
 If it is a new one, post the following information to [github][].

data/docs/timeout-parameters.md

@@ -30,6 +30,9 @@ The next two parameters `send_timeout` and `recv_timeout` are available on Oracl
 or upper. Use these parameters to prevent a ruby process from being blocked by poor quality network.
 Otherwise, the ruby process may be blocked until TCP keepalive time (2 hours).
 
+See {file:docs/hanging-after-inactivity.md Hanging After a Long Period of Inactivity}
+for TCP keepalive time.
+
 tcp_connect_timeout
 -------------------
 

data/ext/oci8/apiwrap.c.tmpl

@@ -4,7 +4,6 @@
 %>
 #define API_WRAP_C 1
 #include "apiwrap.h"
-#define BLOCKING_FUNCTION_EPILOGUE(svcctx) do { (svcctx)->executing_thread = Qnil; } while (0)
 
 <%
 prev_name = ''
@@ -59,11 +58,9 @@ static void *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'
-%>    BLOCKING_FUNCTION_EPILOGUE(data->svcctx);
-    return (void*)(VALUE)data->rv;
+%>    return (void*)(VALUE)data->rv;
 <% else
-%>    BLOCKING_FUNCTION_EPILOGUE(data->svcctx);
-    return NULL;
+%>    return NULL;
 <% end %>
 }
 #else

data/ext/oci8/apiwrap.rb

@@ -35,7 +35,11 @@ class FuncDef
     ver_major = (ver / 100)
     ver_minor = (ver / 10) % 10
     ver_update = ver % 10
-    @version = ((ver_major << 24) | (ver_minor << 20) | (ver_update << 12))
+    @version = if ver_major >= 18
+                 ((ver_major << 24) | (ver_minor << 16) | (ver_update << 12))
+               else
+                 ((ver_major << 24) | (ver_minor << 20) | (ver_update << 12))
+               end
     case @version
     when 0x08000000; @version_num = 'ORAVER_8_0'
     when 0x08100000; @version_num = 'ORAVER_8_1'
@@ -44,6 +48,7 @@ class FuncDef
     when 0x0a100000; @version_num = 'ORAVER_10_1'
     when 0x0a200000; @version_num = 'ORAVER_10_2'
     when 0x0b100000; @version_num = 'ORAVER_11_1'
+    when 0x12000000; @version_num = 'ORAVER_18'
     end
     @version_str = "#{ver_major}.#{ver_minor}.#{ver_update}"
     @ret = val[:ret] || 'sword'

data/ext/oci8/apiwrap.yml

@@ -83,6 +83,17 @@ OCIBindByPos:
             - ub4 *curelep
             - ub4 mode
 
+# round trip: 0
+OCIBindDynamic:
+  :version: 800
+  :args:
+            - OCIBind *bindp
+            - OCIError *errhp
+            - void  *ictxp
+            - OCICallbackInBind icbfp
+            - void  *octxp
+            - OCICallbackOutBind ocbfp
+
 # round trip: 0
 OCIBindObject:
   :version: 800
@@ -180,6 +191,15 @@ OCIDefineByPos:
             - ub2 *rcodep
             - ub4 mode
 
+# round trip: 0
+OCIDefineDynamic:
+  :version: 800
+  :args:
+            - OCIDefine *defnp
+            - OCIError *errhp
+            - dvoid *octxp
+            - OCICallbackDefine ocbfp
+
 # round trip: 0
 OCIDefineObject:
   :version: 800
@@ -321,13 +341,6 @@ OCILobLocatorIsInit:
             - CONST OCILobLocator *locp
             - boolean *is_initialized
 
-# round trip: 1
-OCILogoff:
-  :version: 800
-  :args:
-            - OCISvcCtx *svchp
-            - OCIError *errhp
-
 # round trip: 0
 OCINumberAbs:
   :version: 800
@@ -1149,21 +1162,6 @@ OCIIntervalSetYearMonth:
             - sb4 mnth
             - OCIInterval *result
 
-# round trip: 1
-OCILogon2_nb:
-  :version: 900
-  :args:
-            - OCIEnv *envhp
-            - OCIError *errhp
-            - OCISvcCtx **svchp
-            - CONST text *username
-            - ub4 uname_len
-            - CONST text *password
-            - ub4 passwd_len
-            - CONST text *dbname
-            - ub4 dbname_len
-            - ub4 mode
-
 # round trip: 0 (not docmented. I guess.)
 OCIRowidToChar:
   :version: 900
@@ -1308,3 +1306,17 @@ OCIPing_nb:
             - OCISvcCtx *svchp
             - OCIError *errhp
             - ub4 mode
+
+#
+# Oracle 18.1
+#
+OCIServerRelease2:
+  :version: 1800
+  :args:
+            - dvoid *hndlp
+            - OCIError *errhp
+            - OraText *bufp
+            - ub4 bufsz
+            - ub1 hndltype
+            - ub4 *version
+            - ub4 mode

data/ext/oci8/attr.c

@@ -15,8 +15,9 @@ typedef struct {
     OCIRowid *ridp;
 } rowid_arg_t;
 
-static VALUE get_rowid_attr(rowid_arg_t *arg)
+static VALUE get_rowid_attr(VALUE varg)
 {
+    rowid_arg_t *arg = (rowid_arg_t *)varg;
     oci8_base_t *base = arg->base;
     ub4 attrtype = arg->attrtype;
     char buf[MAX_ROWID_LEN];
@@ -36,8 +37,9 @@ static VALUE get_rowid_attr(rowid_arg_t *arg)
     return rb_external_str_new_with_enc(buf, buflen, rb_usascii_encoding());
 }
 
-static VALUE rowid_ensure(rowid_arg_t *arg)
+static VALUE rowid_ensure(VALUE varg)
 {
+    rowid_arg_t *arg = (rowid_arg_t *)varg;
     if (arg->ridp != NULL) {
         OCIDescriptorFree(arg->ridp, OCI_DTYPE_ROWID);
     }