ruby-oci8 2.2.0.2 → 2.2.12

data/docs/bind-array-to-in_cond.md

@@ -0,0 +1,38 @@
+# @title Bind an Array to IN-condition
+
+Bind an Array to IN-condition
+=============================
+
+Binding an arbitrary-length array to IN-condition is not simple.
+You need to create an SQL statement containing a comma-separated
+list whose length is same with the input data.
+
+Example:
+
+    ids = [ ... ] # an arbitrary-length array containing user IDs.
+    
+    place_holder_string = Array.new(ids.length) {|index| ":id_#{index}"}.join(', ')
+    # place_holder_string is:
+    #   ":id_0" if ids.length == 1
+    #   ":id_0, :id_1" if ids.length == 2
+    #     ...
+    cursor = conn.parse("select * from users where id in (#{place_holder_string})")
+    ids.each_with_index do |id, index|
+      cursor.bind_param("id#{index}", id) # bind each element
+    end
+    cursor.exec()
+
+However this is awkward. So {OCI8.in_cond} was added in ruby-oci8 2.2.2.
+The above code is rewritten as follows:
+
+    ids = [ ... ] # an arbitrary-length array containing user IDs.
+    
+    in_cond = OCI8::in_cond(:id, ids)
+    cursor = conn.exec("select * from users where id in (#{in_cond.names})", *in_cond.values)
+
+or
+
+    ids = [ ... ] # an arbitrary-length array containing user IDs.
+    
+    in_cond = OCI8::in_cond(:id, ids, Integer) # set the data type explicitly
+    cursor = conn.exec("select * from users where id in (#{in_cond.names})", *in_cond.values)

data/docs/conflicts-local-connections-and-processes.md

@@ -0,0 +1,98 @@
+# @title Conflicts between Local Connections and Child Process Handling on Unix
+
+Conflicts between Local Connections and Child Process Handling on Unix
+======================================================================
+
+Background
+----------
+
+When a local (not-TCP) Oracle connection is established on Unix,
+Oracle client library changes signal handlers in the process to reap
+all dead child processes. However it conflicts with child process
+handling in ruby.
+
+Problem 1: It trashes child process handling of Open3::popen.
+----------
+
+    require 'oci8'
+    require 'open3'
+    
+    Open3::popen3('true') do |i, o, e, w|
+      p w.value
+    end
+    
+    conn = OCI8.new(username, password)
+    puts "establish a local connection"
+    
+    Open3::popen3('true') do |i, o, e, w|
+      p w.value
+    end
+
+The above code outputs the following result:
+
+    #<Process::Status: pid 19236 exit 0>
+    establish a local connection
+    nil
+
+`w.value` after a local connection doesn't work because Oracle reaps
+the child process on the process termination before ruby detects it.
+
+Problem 2: It creates defunct processes after disconnection if signal handlers are reset.
+----------
+
+The `system` function overwrites signal handlers.
+It fixes the problem 1 as follows.
+
+    require 'oci8'
+    require 'open3'
+    
+    Open3::popen3('true') do |i, o, e, w|
+      p w.value
+    end
+    
+    conn = OCI8.new(username, password) # Signal handlers are changed here.
+    puts "establish a local connection"
+    system('true') # Signal handlers are reset here.
+    
+    Open3::popen3('true') do |i, o, e, w|
+      p w.value
+    end
+
+The above code outputs the following result:
+
+    #<Process::Status: pid 19652 exit 0>
+    establish a local connection
+    #<Process::Status: pid 19656 exit 0>
+
+`w.value` after a local connection works.
+
+However it makes another problem.
+
+    require 'oci8'
+    
+    conn = OCI8.new(username, password) # Signal handlers are changed here.
+    # An Oracle server process is created here.
+    puts "establish a local connection"
+    system('true') # Signal handlers are reset here.
+    
+    conn.logoff # The Oracle server process exits and become defunct.
+    
+    # ... do other stuffs...
+
+If a program repeatedly creates a local connection and disconnects it,
+the number of defunct processes increases gradually.
+
+Solution: BEQUEATH_DETACH=YES
+----------
+
+By setting [BEQUEATH_DETACH=YES][] in `sqlnet.ora`, Oracle client library
+doesn't change signal handlers. The above two problems are fixed.
+
+Oracle client library reads `sqlnet.ora` in the following locations:
+
+* `$TNS_ADMIN/sqlnet.ora` if the environment variable `TNS_ADMIN`
+  is set and `$TNS_ADMIN/sqlnet.ora` exists.
+  Otherwise, `$ORACLE_HOME/network/admin/sqlnet.ora`.
+* `$HOME/.sqlnet.ora`
+
+[BEQUEATH_DETACH=YES]: https://docs.oracle.com/database/121/NETRF/sqlnet.htm#NETRF183

data/docs/hanging-after-inactivity.md

@@ -0,0 +1,63 @@
+# @title Hanging After a Long Period of Inactivity
+
+Hanging After a Long Period of Inactivity
+=========================================
+
+When a database connection hangs after a long period of inactivity,
+this document may help you.
+
+When a firewall or a NAT proxy resides between Oracle database server
+and client, it sometimes drops inactive connections as dead ones. If a
+client connects to an Oracle server and tries to use the connection
+after a long sleep (> 1 hour), the client may hang in an effort to use the
+dropped connection. This issue will be solved by setting TCP keepalive
+packets whose keepalive time parameter is smaller than the inactive
+connection timeout.
+
+TCP keepalive is enabled by [(ENABLE=broken)][] in a connect
+descriptor. If you use easy connect naming such as `//hostname/service_name`,
+ruby-oci8 sets the parameter on behalf of you when the `tcp_keepalive`
+property is set. (This is available since ruby-oci8 2.2.4.)
+
+    OCI8.properties[:tcp_keepalive] = true
+    conn = OCI8.new(username, password, '//hostname/service_name')
+
+This is equivalent to the following:
+
+    connect_descriptor = "(DESCRIPTION=(ENABLE=broken)(ADDRESS=(PROTOCOL=tcp)(HOST=hostname)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=service_name)))"
+    conn = OCI8.new(username, password, connect_descriptor)
+
+The default TCP keepalive time is two hours, which may be larger
+than the inactive connection timeout. The default
+value in the system is configurable via [procfs and sysctl on Linux][]
+or [registry parameters on Windows][]. If you have no privilege to
+customize the system, you can change per-connection keepalive time
+by the `tcp_keepalive_time` property.
+
+    OCI8.properties[:tcp_keepalive_time] = 600 # 10 minutes
+
+It is supported on the following platforms since ruby-oci8 2.2.4.
+
+* Linux i386 and x86_64
+* macOS
+* Windows x86 and x64
+* Solaris x86_64
+
+When it is set on unsupported platforms, you get `NotImplementedError`.
+
+This feature is implemented with hackish way. When
+`tcp_keepalive_time` is set, Oracle client library's
+procedure linkage table is modified to intercept [setsockopt][] system
+call. When Oracle client library issues the system call which enables
+TCP keepalive, [ruby-oci8 changes][] the per-connection TCP keepalive time
+immediately.
+
+I hope that Oracle adds a new OCI handle attribute to support this
+feature natively in the future.
+
+[(ENABLE=broken)]: https://docs.oracle.com/database/121/NETRF/tnsnames.htm#CHDCDGCE
+[procfs and sysctl on Linux]: http://tldp.org/HOWTO/TCP-Keepalive-HOWTO/usingkeepalive.html
+[registry parameters on Windows]: https://blogs.technet.microsoft.com/nettracer/2010/06/03/things-that-you-may-want-to-know-about-tcp-keepalives/
+[plthook]: https://github.com/kubo/plthook
+[setsockopt]: http://pubs.opengroup.org/onlinepubs/9699919799/functions/setsockopt.html
+[ruby-oci8 changes]: https://github.com/kubo/ruby-oci8/blob/ruby-oci8-2.2.4/ext/oci8/hook_funcs.c#L302-L318

data/docs/install-binary-package.md

@@ -1,24 +1,28 @@
 # @title Install Binary Package
 
-Windows 32-bit (mingw32 ruby)
-=============================
+Install Binary Package
+======================
 
-Run the following command:
+Windows
+-------
 
-    gem install ruby-oci8
+You need to install Oracle client in advance.
+If you don't have installed Oracle client, install {file:docs/install-instant-client.md#Install_Oracle_Instant_Client_Packages instant client}. Only the Basic or Basic Lite package is needed to use ruby-oci8.
+However it is better to install SQL*Plus also because it is usable to check whether
+a problem is in Oracle setting or in ruby-oci8.
+
+Run the following command to install ruby-oci8.
 
-Windows 32-bit (mswin32 ruby)
-=============================
+    gem install ruby-oci8
 
-Run the following command:
+If you uses mswin32 ruby, use the following command instead.
 
     gem install --platform x86-mingw32 ruby-oci8
-
-Ruby-oci8 gem for x86-mingw32 works on mswin32 ruby.
-If it doesn't work, see {file:docs/install-instant-client.md} or {file:docs/install-full-client.md}.
+      or
+    gem install --platform x64-mingw32 ruby-oci8
 
 Other platforms
-===============
+---------------
 
 We doesn't make binary gems for other platforms.
 If you need to distribute a binary gem, compile ruby-oci8 and run the following command.

data/docs/install-full-client.md

@@ -1,7 +1,10 @@
 # @title Install for Oracle Full Client
 
+Install for Oracle Full Client
+==============================
+
 Introduction
-============
+------------
 
 This page explains the way to install ruby-oci8 for Oracle Full Client
 installations.
@@ -11,18 +14,16 @@ For Windows, look at {file:docs/install-binary-package.md} unless you
 have a special need to compile ruby-oci8 by yourself.
 
 Check the environment
-=====================
+---------------------
 
-Oracle installation
--------------------
+### Oracle installation
 
 Run the following command and confirm it works fine. If it doesn't
 work well, you need to ask to your database administrator.
 
     sqlplus USERNAME/PASSWORD
 
-ruby installation
------------------
+### ruby installation
 
 Run the following command. If it ends with "can't find header files
 for ruby" or "ruby: no such file to load -- mkmf (LoadError)", you need
@@ -30,8 +31,7 @@ to install ruby-devel(redhat) or ruby-dev(debian/ubuntu).
 
     ruby -r mkmf -e ""
 
-development tools
------------------
+### development tools
 
 You need a C compiler and development tools such as make or nmake.
 Note that they must be same with ones used to compile the ruby.
@@ -39,15 +39,14 @@ For example, you need Oracle Solaris Studio, not gcc, for ruby
 compiled by Oracle Solaris Studio.
 
 Installation
-============
+------------
 
 If you get a problem in the following steps, look at {file:docs/platform-specific-issues.md}
 and {file:docs/report-installation-issue.md}.
 
-Set the library search path
----------------------------
+### Set the library search path
 
-### UNIX
+#### UNIX
 
 Set the library search path, whose name depends on the OS, to point to
 $ORACLE\_HOME/lib. If the database is 64-bit and the ruby is 32-bit,
@@ -74,27 +73,25 @@ Do not forget to export the variable as follows:
     $ LD_LIBRARY_PATH=$ORACLE_HOME/lib
     $ export LD_LIBRARY_PATH
 
-### Windows(mswin32, mingw32, cygwin)
+#### Windows(mswin32, mingw32, cygwin)
 
 If sqlplus runs correctly, library search path has no problem.
 
-gem package
------------
+### gem package
 
 Run the following command.
 
     gem install ruby-oci8
 
-tar.gz package
---------------
+### tar.gz package
 
-### Download the source code
+#### Download the source code
 
 Download the latest tar.gz package from [download page][].
 
-### Run make and install
+#### Run make and install
 
-#### UNIX or Windows(mingw32, cygwin)
+##### UNIX or Windows(mingw32, cygwin)
 
     gzip -dc ruby-oci8-VERSION.tar.gz | tar xvf -
     cd ruby-oci8-VERSION
@@ -104,7 +101,7 @@ Download the latest tar.gz package from [download page][].
 note: If you use '`sudo`', use it only when running '`make install`'.
 '`sudo`' doesn't pass library search path to the executing command for security reasons.
 
-#### Windows(mswin32)
+##### Windows(mswin32)
 
     gzip -dc ruby-oci8-VERSION.tar.gz | tar xvf -
     cd ruby-oci8-VERSION

data/docs/install-instant-client.md

@@ -1,7 +1,10 @@
 # @title Install for Oracle Instant Client
 
+Install for Oracle Instant Client
+=================================
+
 Introduction
-============
+------------
 
 This page explains the way to install ruby-oci8 for Oracle Instant Client.
 
@@ -13,10 +16,10 @@ have a special need to compile ruby-oci8 by yourself.
 Look at {file:docs/install-on-osx.md} for OS X.
 
 Install Oracle Instant Client Packages
-======================================
+--------------------------------------
+
+### Download Instant Client Packages
 
-Donwload Instant Client Packages
---------------------------------
 Download the following packages from [Oracle Technology Network](http://www.oracle.com/technetwork/database/features/instant-client/index-097480.html).
 
 * Instant Client Package - Basic or Basic Lite
@@ -25,8 +28,7 @@ Download the following packages from [Oracle Technology Network](http://www.orac
 
 Note: use 32-bit packages for 32-bit ruby even though the OS is 64-bit.
 
-UNIX zip packages
------------------
+### UNIX zip packages
 
 Unzip the packages as follows:
 
@@ -79,8 +81,7 @@ Though many instant client pages indicate that the environment varialbe
 configuration files such as `tnsnames.ora` and `sqlnet.ora` are in
 `$ORACLE_HOME/network/admin/`.
 
-Linux rpm packages
-------------------
+### Linux rpm packages
 
 Install the downloaded packages as follows:
 
@@ -95,24 +96,44 @@ For example:
     $ LD_LIBRARY_PATH=/usr/lib/oracle/12.1/client/lib
     $ export LD_LIBRARY_PATH
 
-Windows
--------
+### Windows
+
+Unzip the packages and set `PATH` to point to the directory where `OCI.DLL` is installed.
+
+If `require "ruby-oci8"` raises a load error such as "OCI.DLL: 126(The
+specified module could not be found. )", either `OCI.DLL` or a DLL depended
+by `OCI.DLL` could not be found in `PATH`.
+
+If `OCI.DLL` is surely in `PATH`, the missing module is a Visual C++ runtime
+library in most cases. You need to install "Microsoft Visual C++ Redistributable
+Package" or copy a runtime library to the directory where `ruby.exe` resides.
+
+| Oracle Version | Package | Runtime Library|
+|---|---|---|
+| 18.3     | [Microsoft Visual C++ 2013 Redistributable Package][2013] | MSVCR120.DLL |
+| 12.2.0.x | [Microsoft Visual C++ 2013 Redistributable Package][2013] | MSVCR120.DLL |
+| 12.1.0.x | [Microsoft Visual C++ 2010 Redistributable Package][2010] | MSVCR100.DLL |
+| 11.2.0.x | Microsoft Visual C++ 2005 SP1 Redistributable Package ([x86][2005SP1_x86], [x64][2005SP1_x64]) | MSVCR80.DLL(The file version must be 8.0.50727.762.) |
+| 11.1.0.x | [No separate redistributable package][2003] | MSVCR71.DLL |
+| 10.2.0.x | [No separate redistributable package][2003] | MSVCR71.DLL |
 
-Unzip the packages and set PATH to point to the directory where OCI.DLL is installed.
+[2013]: https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads
+[2010]: http://www.microsoft.com/en-us/download/details.aspx?id=26999
+[2005SP1_x86]: https://www.microsoft.com/en-us/download/details.aspx?id=5638
+[2005SP1_x64]: https://www.microsoft.com/en-us/download/details.aspx?id=18471
+[2003]: http://stackoverflow.com/questions/1596167/where-to-download-microsoft-visual-c-2003-redistributable#6132093
 
 Check the environment
-=====================
+---------------------
 
-Oracle installation
--------------------
+### Oracle installation
 
 Run the following command and confirm it works fine. If it doesn't
 work well, check `LD_LIBRARY_PATH` or PATH.
 
     sqlplus USERNAME/PASSWORD
 
-ruby installation
------------------
+### ruby installation
 
 Run the following command. If it ends with "can't find header files
 for ruby" or "ruby: no such file to load -- mkmf (LoadError)", you need
@@ -120,8 +141,7 @@ to install ruby-devel(redhat) or ruby-dev(debian/ubuntu).
 
     ruby -r mkmf -e ""
 
-development tools
------------------
+### development tools
 
 You need a C compiler and development tools such as make or nmake.
 Note that they must be same with ones used to compile the ruby.
@@ -129,13 +149,12 @@ For example, you need Oracle Solaris Studio, not gcc, for ruby
 compiled by Oracle Solaris Studio.
 
 Installation
-============
+------------
 
 If you get a problem in the following steps, look at {file:docs/platform-specific-issues.md}
 and {file:docs/report-installation-issue.md}.
 
-gem package
------------
+### gem package
 
 Run the following command.
 
@@ -144,19 +163,18 @@ Run the following command.
 If you get a problem, look at {file:docs/platform-specific-issues.md}
 and {file:docs/report-installation-issue.md}.
 
-tar.gz package
---------------
+### tar.gz package
 
-### Download the source code
+#### Download the source code
 
 Download the latest tar.gz package from [download page][].
 
 Note: if you are using Windows and you have no special need to compile
 it by yourself, look at {file:docs/install-binary-packge.md}.
 
-### Run make and install
+#### Run make and install
 
-#### UNIX or Windows(mingw32, cygwin)
+##### UNIX or Windows(mingw32, cygwin)
 
     gzip -dc ruby-oci8-VERSION.tar.gz | tar xvf -
     cd ruby-oci8-VERSION
@@ -166,7 +184,7 @@ it by yourself, look at {file:docs/install-binary-packge.md}.
 note: If you use '`sudo`', use it only when running '`make install`'.
 '`sudo`' doesn't pass library search path to the executing command for security reasons.
 
-#### Windows(mswin32)
+##### Windows(mswin32)
 
     gzip -dc ruby-oci8-VERSION.tar.gz | tar xvf -
     cd ruby-oci8-VERSION

data/docs/install-on-osx.md

@@ -1,132 +1,46 @@
-# @title Install ruby-oci8 on OS X
+# @title Install ruby-oci8 on macOS
 
-This page explains the way to install ruby-oci8 os OS X.
+Install ruby-oci8 on macOS
+=========================
 
-Look at {file:docs/install-full-client.md}, {file:docs/install-instant-client.md}
-or {file:docs/install-binary-package.md} for other platforms.
+**Note: Ruby-oci8 doesn't run on Apple Silicon because Oracle instant client
+for Apple Silicon has not been released yet.**
 
-Install C compiler
-==================
+Prerequisite
+------------
 
-You need to install the command line developer tools or the Xcode.
-(The latter includes the former.)
-
-Run `"cc --version"` in a terminal to check whether they are installed.
-
-If the cc version is printed, the tools are installed.
-
-If the follwoing dialog is displayed, click its Install button to
-install the tools.
-You have no need to install the Xcode to compile ruby-oci8.
-It requires command line tools, not an IDE such as the Xcode.
-
-![dialog](osx-install-dev-tools.png)
-
-If `"Agreeing to the Xcode/iOS license requires admin privileges,
-please re-run as root via sudo."` is printed, you need to run
-`"sudo cc --version"`, enter your password, look at the license
-and type `"agree"`.
+* Command line tools for Xcode or Xcode (by executing `xcode-select --install`) or [Xcode]
 
 Install Oracle Instant Client Packages
-======================================
-
-Download Oracle Instant Client Packages
---------------------------------
-
-Download the following packages from [Oracle Technology Network][]
-
-* Instant Client Package - Basic or Basic Lite
-* Instant Client Package - SDK
-* Instant Client Package - SQL*Plus (optionally)
-
-Install Oracle Instant Client Packages via Homebrew
----------------------------------------------------
-
-To install `Oracle Instant Client Basic Lite` via [Homebrew][]
-
-* Download two instant client packages: `Basic Lite` and `SDK` and put them
-  in `/Library/Caches/Homebrew` (if the environment variable `HOMEBREW_CACHE`
-  is not set and `$HOME/Library/Caches/Homebrew` doesn't exist.)
-* Run the followining commands:
-
-        brew install InstantClientTap/instantclient/instantclient-basiclite
-        brew install InstantClientTap/instantclient/instantclient-sdk
-
-To install `Oracle Instant Client Basic` via [Homebrew][]
-
-* Download *three* instant client packages: `Basic`, `Basic Lite` and `SDK`
-  and put them in `/Library/Caches/Homebrew` (if the environment variable
-  `HOMEBREW_CACHE` is not set and `$HOME/Library/Caches/Homebrew` doesn't exist.)
-* Run the followining commands:
-
-        brew install InstantClientTap/instantclient/instantclient-basic
-        brew install InstantClientTap/instantclient/instantclient-sdk
-        
-* Set the environment variable OCI_DIR while performing the following installation steps
-  if Homebrew is installed outside `/usr/local`.
-
-        export OCI_DIR=$(brew --prefix)/lib
-
-Install Oracle Instant Client Manually
----------------------
-
-If you don't use [Homebrew][], do the following:
-
-Unzip the packages as follows:
-
-    mkdir /opt
-    mkdir /opt/oracle
-    cd /opt/oracle
-
-Copy downloaded files to /opt/oracle before running the following commands.
-
-    unzip instantclient-basic-macos.x64-11.2.0.4.0.zip
-    unzip instantclient-sdk-macos.x64-11.2.0.4.0.zip
-    unzip instantclient-sqlplus-macos.x64-11.2.0.4.0.zip
-
-Make a symbolic link to link the library.
-
-    cd /opt/oracle/instantclient11_2
-    ln -s libclntsh.dylib.11.1 libclntsh.dylib
-
-Fix the library install and identification names using [fix_oralib][] to make them work
-without `DYLD_LIBRARY_PATH`.
-
-    cd /opt/oracle/instantclient11_2
-    curl -O https://raw.githubusercontent.com/kubo/fix_oralib_osx/master/fix_oralib.rb
-    ruby fix_oralib.rb
-
-Set the environment variable OCI_DIR while performing the following installation steps.
-
-    export OCI_DIR=/opt/oracle/instantclient11_2
-
-Installation
-============
-
-If you get a problem in the following steps, look at {file:docs/report-installation-issue.md}.
-
-gem package
------------
+--------------------------------------
 
-Run the following command.
+If you have installed [Homebrew], use the following command:
 
-    gem install ruby-oci8
+```shell
+$ brew tap InstantClientTap/instantclient
+$ brew install instantclient-basic   # or instantclient-basiclite
+$ brew install instantclient-sdk
+$ brew install instantclient-sqlplus # (optionally)
+```
 
-tar.gz package
---------------
+Otherwise, look at this [page][OTN] and set the environment variable
+`OCI_DIR` to point the the directory where instant client is installed.
+Ruby-oci8 installation script checks the directory.
 
-### Download the source code
+```shell
+export OCI_DIR=$HOME/Downloads/instantclient_19_8  # for example
+```
 
-Download the latest tar.gz package from [download page][].
+Install ruby-oci8
+-----------------
 
-### Run make and install
+Note that `/usr/bin/ruby` isn't available. You need to use [`rbenv`] or so.
 
-    tar xvfz ruby-oci8-VERSION.tar.gz
-    cd ruby-oci8-VERSION
-    make
-    make install
+```shell
+$ gem install ruby-oci8
+```
 
-[download page]: https://bintray.com/kubo/generic/ruby-oci8
 [Homebrew]: http://brew.sh/
-[fix_oralib]: https://github.com/kubo/fix_oralib_osx
-[Oracle Technology Network]: http://www.oracle.com/technetwork/topics/intel-macsoft-096467.html
+[OTN]: https://www.oracle.com/database/technologies/instant-client/macos-intel-x86-downloads.html#ic_osx_inst
+[Xcode]: https://apps.apple.com/us/app/xcode/id497799835
+[`rbenv`]: https://github.com/rbenv/rbenv