ruby-oci8 2.1.0 → 2.1.1

data/docs/report-installation-issue.md

@@ -0,0 +1,50 @@
+# @title Report Installation Issues
+
+Look at {file:docs/platform-specific-issues.md},
+[the issues page on github][github] and [the ruby-oci8 help forum on rubyforge][rubyforge]
+to check whether your issue is fixed or not.
+
+If it is a new one, post the following information to [github][] or [rubyforge][].
+
+[github]: https://github.com/kubo/ruby-oci8/issues
+[rubyforge]: http://rubyforge.org/forum/forum.php?forum_id=1078
+
+*    Messages printed out to the console
+
+*    `gem_make.out` if you install a gem
+
+*    Last 100 lines of 'ext/oci8/mkmf.log'
+
+     Get them as follows.
+
+         tail -100 ext/oci8/mkmf.log
+
+*    The results of the following commands:
+
+         file `which ruby`
+         ruby --version
+         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['DLDLAGS']"
+         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
+         
+         # Oracle full client
+         file $ORACLE_HOME/bin/oracle
+         
+         # Oracle Instant client. You need to change INSTANT_CLIENT_DIRECTORY.
+         file INSTANT_CLIENT_DIRECTORY/libclntsh.*
+         
+         echo $LD_LIBRARY_PATH
+         echo $LIBPATH              # AIX
+         echo $SHLIB_PATH           # HP-UX PA-RISC 32-bit ruby
+         echo $DYLD_LIBRARY_PATH    # Mac OS X
+         echo $LD_LIBRARY_PATH_32   # Solaris 32-bit ruby
+         echo $LD_LIBRARY_PATH_64   # Solaris 64-bit ruby

data/ext/oci8/apiwrap.yml

@@ -379,20 +379,6 @@ OCILogoff:
             - OCISvcCtx *svchp
             - OCIError *errhp
 
-# round trip: 1
-OCILogon_nb:
-  :version: 800
-  :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
-
 # round trip: 0
 OCINumberAbs:
   :version: 800
@@ -1301,6 +1287,21 @@ 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
@@ -1342,6 +1343,28 @@ OCINlsCharSetNameToId:
             - dvoid *envhp
             - const oratext *name
 
+OCIStmtPrepare2:
+  :version: 920
+  :args:
+            - OCISvcCtx *svchp
+            - OCIStmt **stmtp
+            - OCIError *errhp
+            - const OraText *stmt
+            - ub4 stmt_len
+            - const OraText *key
+            - ub4 key_len
+            - ub4 language
+            - ub4 mode
+
+OCIStmtRelease:
+  :version: 920
+  :args:
+            - OCIStmt *stmtp
+            - OCIError *errhp
+            - const OraText *key
+            - ub4 key_len
+            - ub4 mode
+
 #
 # Oracle 10.1
 #

data/ext/oci8/error.c

@@ -2,7 +2,7 @@
 /*
   error.c - part of ruby-oci8
 
-  Copyright (C) 2002-2011 KUBO Takehiro <kubo@jiubao.org>
+  Copyright (C) 2002-2012 KUBO Takehiro <kubo@jiubao.org>
 
 */
 #include "oci8.h"
@@ -162,9 +162,13 @@ static VALUE set_backtrace(VALUE exc, const char *file, int line)
 
 /*
  * call-seq:
- *    OCI8.new(message, code = nil, sql = nil, parse_error_offset = nil)
+ *    initialize(message, code = nil, sql = nil, parse_error_offset = nil)
  *
  * Creates a new OCIError object.
+ *
+ * @example
+ *   OCIError.new("ORA-00001: unique constraint (%s.%s) violated", 1)
+ *   # => #<OCIError: ORA-00001: unique constraint (%s.%s) violated>
  */
 static VALUE oci8_error_initialize(int argc, VALUE *argv, VALUE self)
 {
@@ -211,6 +215,10 @@ void Init_oci8_error(void)
     eOCISuccessWithInfo = rb_define_class("OCISuccessWithInfo", eOCIError);
 
     rb_define_method(eOCIError, "initialize", oci8_error_initialize, -1);
+
+    /*
+     * @attr_reader [Integer] code  error code
+     */
     rb_define_attr(eOCIError, "code", 1, 0);
     rb_define_attr(eOCIError, "sql", 1, 0);
     rb_define_attr(eOCIError, "parse_error_offset", 1, 0);
@@ -296,14 +304,11 @@ void oci8_check_error_(sword status, oci8_base_t *base, OCIStmt *stmthp, const c
  * These exceptions are raised when Oracle Call Interface functions
  * return with an error status.
  *
- * - OCIBreak
- * - OCIContinue
- * - OCIError
- *   - OCISuccessWithInfo
- *   - OCINoData (It had been a subclass of OCIException, not OCIError, until ruby-oci8 2.0)
- * - OCIInvalidHandle
- * - OCINeedData
- * - OCIStillExecuting
+ * - {OCIBreak}
+ * - {OCIError}
+ *   - {OCISuccessWithInfo}
+ *   - {OCINoData} (It had been a subclass of OCIException, not OCIError, until ruby-oci8 2.0)
+ * - {OCIInvalidHandle}
  */
 
 /*
@@ -311,7 +316,7 @@ void oci8_check_error_(sword status, oci8_base_t *base, OCIStmt *stmthp, const c
  *
  * Subclass of OCIException
  *
- * Raised when a SQL execution is cancelled by OCI8#break.
+ * Raised when a SQL execution is cancelled by {OCI8#break}.
  */
 
 /*
@@ -335,6 +340,10 @@ void oci8_check_error_(sword status, oci8_base_t *base, OCIStmt *stmthp, const c
  *
  * Raised when underlying Oracle Call Interface failed with an Oracle error code
  * such as ORA-00001.
+ *
+ * @attr_reader [Integer] code  error code
+ * @attr_reader [String] sql    SQL statement
+ * @attr_reader [Integer] parse_error_offset position
  */
 
 /*
@@ -352,6 +361,8 @@ void oci8_check_error_(sword status, oci8_base_t *base, OCIStmt *stmthp, const c
  * Subclass of OCIException
  *
  * Report to the ruby-oci8 author if it is raised.
+ *
+ * @private
  */
 
 /*
@@ -360,6 +371,8 @@ void oci8_check_error_(sword status, oci8_base_t *base, OCIStmt *stmthp, const c
  * Subclass of OCIError
  *
  * Report to the ruby-oci8 author if it is raised.
+ *
+ * @private
  */
 
 /*
@@ -368,6 +381,8 @@ void oci8_check_error_(sword status, oci8_base_t *base, OCIStmt *stmthp, const c
  * Subclass of OCIException
  *
  * Report to the ruby-oci8 author if it is raised.
+ *
+ * @private
  */
 
 /*

data/ext/oci8/extconf.rb

@@ -136,9 +136,8 @@ end
 
 # Config::CONFIG["ruby_version"] indicates the ruby API version.
 #  1.8   - ruby 1.8.x
-#  1.9.1 - ruby 1.9.1 and 1.9.2
-#  1.9.x - ruby 1.9.x future version which will break the API compatibility
-so_basename += Config::CONFIG["ruby_version"].gsub(/\W/, '')
+#  1.9.1 - ruby 1.9.1, 1.9.2 and 2.0.0-dev at the present time.
+so_basename += RbConfig::CONFIG["ruby_version"].gsub(/\W/, '')
 
 $defs << "-DInit_oci8lib=Init_#{so_basename}"
 $defs << "-Doci8lib=#{so_basename}"
@@ -174,6 +173,23 @@ end
 
 create_apiwrap()
 
+case RUBY_PLATFORM
+when /mingw32/
+  # Drop '-s' option from LDSHARED and explicitly run 'strip' to get the map file.
+  if RbConfig::MAKEFILE_CONFIG["LDSHARED"].gsub!(/-s\b/, '')
+    alias :oci8_configuration_orig :configuration
+    def configuration(*args)
+      oci8_configuration_orig(*args) << <<EOS
+
+# Dirty hack to get the map file.
+all__: all
+	nm $(DLLIB) | grep ' [TtBb] _[A-Za-z]' > $(TARGET).map
+	strip -s $(DLLIB)
+EOS
+    end
+  end
+end
+
 create_makefile(so_basename)
 
 exit 0

data/ext/oci8/lob.c

@@ -163,6 +163,41 @@ static void bfile_close(oci8_lob_t *lob)
     }
 }
 
+/*
+ *  Document-class: OCI8::LOB
+ *
+ *  This is the abstract base class of large-object data types; BFILE, BLOB, CLOB and NCLOB.
+ *
+ */
+
+/*
+ *  Document-class: OCI8::CLOB
+ *
+ */
+
+/*
+ *  Document-class: OCI8::NCLOB
+ *
+ */
+
+/*
+ *  Document-class: OCI8::BLOB
+ *
+ */
+
+/*
+ *  Document-class: OCI8::BFILE
+ *
+ *  @method truncate(length)
+ *  @method size = length
+ *  @method write(data)
+ */
+
+/*
+ *  Closes the lob.
+ *
+ *  @return [self]
+ */
 static VALUE oci8_lob_close(VALUE self)
 {
     oci8_lob_t *lob = DATA_PTR(self);
@@ -199,28 +234,87 @@ static VALUE oci8_lob_do_initialize(int argc, VALUE *argv, VALUE self, ub1 csfrm
                &svcctx->base);
         lob->svchp = oci8_get_oci_svcctx(svc);
         oci8_lob_write(self, val);
+        lob->pos = 0; /* reset the position */
     }
     return Qnil;
 }
 
+/*
+ *  call-seq:
+ *    initialize(conn, contents = nil)
+ *
+ *  Creates a temporary CLOB when <i>contents</i> is not nil.
+ *  Otherwise, it creates an uninitialized lob, which is used internally
+ *  to fetch CLOB column data.
+ *
+ *  @example
+ *    # Inserts a file name and its contents as CLOB.
+ *    clob = OCI8::CLOB.new(conn, File.read(file_name))
+ *    conn.exec('insert into file_contents values (:1, :2)', file_name, clob)
+ *
+ *  @param [OCI8] conn connection
+ *  @param [String] contents
+ *  @return [OCI8::CLOB]
+ */
 static VALUE oci8_clob_initialize(int argc, VALUE *argv, VALUE self)
 {
     oci8_lob_do_initialize(argc, argv, self, SQLCS_IMPLICIT, OCI_TEMP_CLOB);
     return Qnil;
 }
 
+/*
+ *  call-seq:
+ *    initialize(conn, contents = nil)
+ *
+ *  Creates a temporary NCLOB when <i>contents</i> is not nil.
+ *  Otherwise, it creates an uninitialized lob, which is used internally
+ *  to fetch NCLOB column data.
+ *
+ *  @example
+ *    # Inserts a file name and its contents as NCLOB.
+ *    clob = OCI8::NCLOB.new(conn, File.read(file_name))
+ *    conn.exec('insert into file_contents values (:1, :2)', file_name, clob)
+ *
+ *  @param [OCI8] conn
+ *  @param [String] contents
+ *  @return [OCI8::NCLOB]
+ */
 static VALUE oci8_nclob_initialize(int argc, VALUE *argv, VALUE self)
 {
     oci8_lob_do_initialize(argc, argv, self, SQLCS_NCHAR, OCI_TEMP_CLOB);
     return Qnil;
 }
 
+/*
+ *  call-seq:
+ *    initialize(conn, contents = nil)
+ *
+ *  Creates a temporary BLOB when <i>contents</i> is not nil.
+ *  Otherwise, it creates an uninitialized lob, which is used internally
+ *  to fetch BLOB column data.
+ *
+ *  @example
+ *    # Inserts a file name and its contents as BLOB.
+ *    clob = OCI8::BLOB.new(conn, File.read(file_name, :mode => 'rb'))
+ *    conn.exec('insert into file_contents values (:1, :2)', file_name, clob)
+ *
+ *  @param [OCI8] conn
+ *  @param [String] contents
+ *  @return [OCI8::BLOB]
+ */
 static VALUE oci8_blob_initialize(int argc, VALUE *argv, VALUE self)
 {
     oci8_lob_do_initialize(argc, argv, self, SQLCS_IMPLICIT, OCI_TEMP_BLOB);
     return Qnil;
 }
 
+/*
+ *  call-seq:
+ *    __char_width = size
+ *
+ *  @private
+ *  IMO, nobody need and use this.
+ */
 static VALUE oci8_lob_set_char_width(VALUE self, VALUE vsize)
 {
     oci8_lob_t *lob = DATA_PTR(self);
@@ -234,6 +328,11 @@ static VALUE oci8_lob_set_char_width(VALUE self, VALUE vsize)
     return vsize;
 }
 
+/*
+ *  Returns +true+ when <i>self</i> is initialized.
+ *
+ *  @return [true or false]
+ */
 static VALUE oci8_lob_available_p(VALUE self)
 {
     oci8_lob_t *lob = DATA_PTR(self);
@@ -244,17 +343,36 @@ static VALUE oci8_lob_available_p(VALUE self)
     return is_initialized ? Qtrue : Qfalse;
 }
 
+/*
+ *  Returns the size.
+ *  For CLOB and NCLOB it is the number of characters,
+ *  for BLOB and BFILE it is the number of bytes.
+ *
+ *  @return [Integer]
+ */
 static VALUE oci8_lob_get_size(VALUE self)
 {
     return UB4_TO_NUM(oci8_lob_get_length(DATA_PTR(self)));
 }
 
+/*
+ *  Returns the current offset.
+ *  For CLOB and NCLOB it is the number of characters,
+ *  for BLOB and BFILE it is the number of bytes.
+ *
+ *  @return [Integer]
+ */
 static VALUE oci8_lob_get_pos(VALUE self)
 {
     oci8_lob_t *lob = DATA_PTR(self);
     return UB4_TO_NUM(lob->pos);
 }
 
+/*
+ *  Returns true if the current offset is at end of lob.
+ *
+ *  @return [true or false]
+ */
 static VALUE oci8_lob_eof_p(VALUE self)
 {
     oci8_lob_t *lob = DATA_PTR(self);
@@ -264,6 +382,20 @@ static VALUE oci8_lob_eof_p(VALUE self)
         return Qtrue;
 }
 
+/*
+ *  call-seq:
+ *     seek(amount, whence=IO::SEEK_SET)
+ *
+ *  Seeks to the given offset in the stream. The new position, measured in characters,
+ *  is obtained by adding offset <i>amount</i> to the position specified by <i>whence</i>.
+ *  If <i>whence</i> is set to IO::SEEK_SET, IO::SEEK_CUR, or IO::SEEK_END,
+ *  the offset is relative to the start of the file, the current position
+ *  indicator, or end-of-file, respectively.
+ *
+ *  @param [Integer] amount
+ *  @param [IO::SEEK_SET, IO::SEEK_CUR or IO::SEEK_END] whence
+ *  @return [self]
+ */
 static VALUE oci8_lob_seek(int argc, VALUE *argv, VALUE self)
 {
     oci8_lob_t *lob = DATA_PTR(self);
@@ -288,6 +420,11 @@ static VALUE oci8_lob_seek(int argc, VALUE *argv, VALUE self)
     return self;
 }
 
+/*
+ *  Sets the current offset at the beginning.
+ *
+ *  @return [true or false]
+ */
 static VALUE oci8_lob_rewind(VALUE self)
 {
     oci8_lob_t *lob = DATA_PTR(self);
@@ -295,6 +432,15 @@ static VALUE oci8_lob_rewind(VALUE self)
     return self;
 }
 
+/*
+ *  call-seq:
+ *    truncate(length)
+ *
+ *  Changes the lob size to the given <i>length</i>.
+ *
+ *  @param [Integer] length
+ *  @return [self]
+ */
 static VALUE oci8_lob_truncate(VALUE self, VALUE len)
 {
     oci8_lob_t *lob = DATA_PTR(self);
@@ -306,12 +452,36 @@ static VALUE oci8_lob_truncate(VALUE self, VALUE len)
     return self;
 }
 
+/*
+ *  call-seq:
+ *    size = length
+ *
+ *  Changes the lob size to the given <i>length</i>.
+ *
+ *  @param [Integer] length
+ *  @return [Integer]
+ */
 static VALUE oci8_lob_set_size(VALUE self, VALUE len)
 {
     oci8_lob_truncate(self, len);
     return len;
 }
 
+/*
+ *  call-seq:
+ *    read(length = nil)
+ *
+ *  Reads <i>length</i> characters for CLOB and NCLOB or <i>length</i>
+ *  bytes for BLOB and BILF from the current position.
+ *  If <i>length</i> is <code>nil</code>, it reads data until EOF.
+ *
+ *  It returns a string or <code>nil</code>. <code>nil</code> means it
+ *  met EOF at beginning. As a special exception, when <i>length</i> is
+ *  <code>nil</code> and the lob length is zero, it returns an empty string ''.
+ *
+ *  @param [Integer] length
+ *  @return [String or nil]
+ */
 static VALUE oci8_lob_read(int argc, VALUE *argv, VALUE self)
 {
     oci8_lob_t *lob = DATA_PTR(self);
@@ -327,6 +497,9 @@ static VALUE oci8_lob_read(int argc, VALUE *argv, VALUE self)
 
     rb_scan_args(argc, argv, "01", &size);
     length = oci8_lob_get_length(lob);
+    if (length == 0 && NIL_P(size)) {
+        return rb_usascii_str_new("", 0);
+    }
     if (length <= lob->pos) /* EOF */
         return Qnil;
     length -= lob->pos;
@@ -412,6 +585,15 @@ static VALUE oci8_lob_read(int argc, VALUE *argv, VALUE self)
     }
 }
 
+/*
+ *  call-seq:
+ *    write(data)
+ *
+ *  Writes <i>data</i>.
+ *
+ *  @param [String] data
+ *  @return [Integer]
+ */
 static VALUE oci8_lob_write(VALUE self, VALUE data)
 {
     oci8_lob_t *lob = DATA_PTR(self);
@@ -427,18 +609,30 @@ static VALUE oci8_lob_write(VALUE self, VALUE data)
     }
     RB_GC_GUARD(data);
     amt = RSTRING_LEN(data);
+    if (amt == 0) {
+        /* to avoid ORA-24801: illegal parameter value in OCI lob function */
+        return INT2FIX(0);
+    }
     chker2(OCILobWrite_nb(svcctx, svcctx->base.hp.svc, oci8_errhp, lob->base.hp.lob, &amt, lob->pos + 1, RSTRING_PTR(data), amt, OCI_ONE_PIECE, NULL, NULL, 0, lob->csfrm),
            &svcctx->base);
     lob->pos += amt;
     return UINT2NUM(amt);
 }
 
+/*
+ *  @deprecated I'm not sure that this is what the name indicates.
+ *  @private
+ */
 static VALUE oci8_lob_get_sync(VALUE self)
 {
     oci8_lob_t *lob = DATA_PTR(self);
     return (lob->state == S_NO_OPEN_CLOSE) ? Qtrue : Qfalse;
 }
 
+/*
+ *  @deprecated I'm not sure that this is what the name indicates.
+ *  @private
+ */
 static VALUE oci8_lob_set_sync(VALUE self, VALUE b)
 {
     oci8_lob_t *lob = DATA_PTR(self);
@@ -452,6 +646,10 @@ static VALUE oci8_lob_set_sync(VALUE self, VALUE b)
     return b;
 }
 
+/*
+ *  @deprecated I'm not sure that this is what the name indicates.
+ *  @private
+ */
 static VALUE oci8_lob_flush(VALUE self)
 {
     oci8_lob_t *lob = DATA_PTR(self);
@@ -459,6 +657,12 @@ static VALUE oci8_lob_flush(VALUE self)
     return self;
 }
 
+/*
+ *  Returns the chunk size of a LOB.
+ *
+ *  @see http://docs.oracle.com/cd/E16338_01/appdev.112/e10646/oci17msc002.htm#i493090
+ *  @return [Integer]
+ */
 static VALUE oci8_lob_get_chunk_size(VALUE self)
 {
     oci8_lob_t *lob = DATA_PTR(self);
@@ -544,6 +748,19 @@ static void oci8_bfile_set_name(VALUE self, VALUE dir_alias, VALUE filename)
            &lob->base);
 }
 
+/*
+ *  call-seq:
+ *    initialize(conn, dir_alias = nil, filename = nil)
+ *
+ *  Creates a BFILE object.
+ *  This is correspond to {http://docs.oracle.com/cd/E11882_01/server.112/e17118/functions019.htm#sthref953 BFILENAME}.
+ *
+ *  @param [OCI8] conn
+ *  @param [String] dir_alias  a directory object created by
+ *    {http://docs.oracle.com/cd/E11882_01/server.112/e17118/statements_5007.htm "CREATE DIRECTORY"}.
+ *  @param [String] filename
+ *  @return [OCI8::BFILE]
+ */
 static VALUE oci8_bfile_initialize(int argc, VALUE *argv, VALUE self)
 {
     oci8_lob_t *lob = DATA_PTR(self);
@@ -574,6 +791,11 @@ static VALUE oci8_bfile_initialize(int argc, VALUE *argv, VALUE self)
     return Qnil;
 }
 
+/*
+ *  Returns the directory object name.
+ *
+ *  @return [String]
+ */
 static VALUE oci8_bfile_get_dir_alias(VALUE self)
 {
     VALUE dir_alias;
@@ -582,6 +804,11 @@ static VALUE oci8_bfile_get_dir_alias(VALUE self)
     return dir_alias;
 }
 
+/*
+ *  Returns the file name.
+ *
+ *  @return [String]
+ */
 static VALUE oci8_bfile_get_filename(VALUE self)
 {
     VALUE filename;
@@ -590,6 +817,14 @@ static VALUE oci8_bfile_get_filename(VALUE self)
     return filename;
 }
 
+/*
+ *  call-seq:
+ *    dir_alias = name
+ *
+ *  Changes the directory object name.
+ *
+ *  @param [String] name
+ */
 static VALUE oci8_bfile_set_dir_alias(VALUE self, VALUE dir_alias)
 {
     VALUE filename;
@@ -601,6 +836,14 @@ static VALUE oci8_bfile_set_dir_alias(VALUE self, VALUE dir_alias)
     return dir_alias;
 }
 
+/*
+ *  call-seq:
+ *    filename = name
+ *
+ *  Changes the file name.
+ *
+ *  @param [String] name
+ */
 static VALUE oci8_bfile_set_filename(VALUE self, VALUE filename)
 {
     VALUE dir_alias;
@@ -612,6 +855,11 @@ static VALUE oci8_bfile_set_filename(VALUE self, VALUE filename)
     return filename;
 }
 
+/*
+ *  Returns <code>true</code> when the BFILE exists on the server's operating system.
+ *
+ *  @return [true or false]
+ */
 static VALUE oci8_bfile_exists_p(VALUE self)
 {
     oci8_lob_t *lob = DATA_PTR(self);
@@ -623,6 +871,39 @@ static VALUE oci8_bfile_exists_p(VALUE self)
     return flag ? Qtrue : Qfalse;
 }
 
+/*
+ *  Document-method: OCI8::BFILE#truncate
+ *
+ *  call-seq:
+ *    truncate(length)
+ *
+ *  Raises <code>RuntimeError</code>.
+ *
+ *  @raise [RuntimeError] cannot modify a read-only BFILE object
+ */
+
+/*
+ *  Document-method: OCI8::BFILE#size=
+ *
+ *  call-seq:
+ *    size = length
+ *
+ *  Raises <code>RuntimeError</code>.
+ *
+ *  @raise [RuntimeError] cannot modify a read-only BFILE object
+ */
+
+/*
+ *  Document-method: OCI8::BFILE#write
+ *
+ *  call-seq:
+ *    write(data)
+ *
+ *  Raises <code>RuntimeError</code>.
+ *
+ *  @raise [RuntimeError] cannot modify a read-only BFILE object
+ */
+
 static VALUE oci8_bfile_error(VALUE self, VALUE dummy)
 {
     rb_raise(rb_eRuntimeError, "cannot modify a read-only BFILE object");
@@ -761,6 +1042,12 @@ void Init_oci8_lob(VALUE cOCI8)
     seek_cur = rb_eval_string("::IO::SEEK_CUR");
     seek_end = rb_eval_string("::IO::SEEK_END");
 
+#if 0
+    cOCIHandle = rb_define_class("OCIHandle", rb_cObject);
+    cOCI8 = rb_define_class("OCI8", cOCIHandle);
+    cOCI8LOB = rb_define_class_under(cOCI8, "LOB", cOCIHandle);
+#endif
+
     cOCI8LOB = oci8_define_class_under(cOCI8, "LOB", &oci8_lob_vtable);
     cOCI8CLOB = rb_define_class_under(cOCI8, "CLOB", cOCI8LOB);
     cOCI8NCLOB = rb_define_class_under(cOCI8, "NCLOB", cOCI8LOB);