Added a type property to the Lob class to distinguish CLOB and BLOB types

Author: cjbj

CHANGELOG.md

@@ -16,6 +16,8 @@
 
 - Fixed encoding issues with several files that caused compilation warnings in some Windows environments.
 
+- Added a `type` property to the Lob class to distinguish CLOB and BLOB types.
+
 ## node-oracledb v1.1.0 (3 Sep 2015)
 
 - Enhanced pool.release() to drop the session if it is known to be unusable, allowing a new session to be created.

doc/api.md

@@ -73,6 +73,7 @@ limitations under the License.
      - 5.1.1 [chunkSize](#proplobchunksize)
      - 5.1.2 [length](#proploblength)
      - 5.1.3 [pieceSize](#proplobpiecesize)
+	 - 5.1.4 [type](#proplobtype)
 6. [Pool Class](#poolclass)
   - 6.1 [Pool Properties](#poolproperties)
      - 6.1.1 [connectionsInUse](#proppoolconnectionsinuse)
@@ -253,7 +254,7 @@ Oracledb.ARRAY                     // Fetch each row as array of column values
 Oracledb.OBJECT                    // Fetch each row as an object
 ```
 
-#### Constants for `execute()` [bind parameter](#executebindParams) `type` properties, for [`fetchAsString`](#propdbfetchasstring) and for [`fetchInfo`](#propfetchinfo):
+#### Type constants for `execute()` [bind parameter](#executebindParams) and [Lob](#proplobpiecesize) `type` properties, for [`fetchAsString`](#propdbfetchasstring), and for [`fetchInfo`](#propfetchinfo):
 
 ```
 Oracledb.BLOB                      // Bind a BLOB to return a Node.js buffer
@@ -264,7 +265,7 @@ Oracledb.CURSOR                    // Bind a REF CURSOR to a node-oracledb Resul
 
 Oracledb.DATE                      // Bind as JavaScript date type.  Can also be used for fetchAsString and fetchInfo
 
-Oracledb.DEFAULT                   // Used with [`fetchInfo`](#propfetchinfo) to reset the fetch type to the database type
+Oracledb.DEFAULT                   // Used with fetchInfo to reset the fetch type to the database type
 
 Oracledb.NUMBER                    // Bind as JavaScript number type.  Can also be used for fetchAsString and fetchInfo
 
@@ -1401,6 +1402,19 @@ For efficiency, it is recommended that `pieceSize` be a multiple of
 
 The maximum value for `pieceSize` is limited to the value of UINT_MAX.
 
+#### <a name="proplobtype"></a> 5.1.4 type
+
+```
+readonly Number type
+```
+
+This read-only attribute shows the type of Lob being used.  It will
+have the value of one of the constants
+[`Oracledb.BLOB`](#oracledbconstants) or
+[`Oracledb.CLOB`](#oracledbconstants).  The value is derived from the
+bind type when using LOB bind variables, or from the column type when
+a LOB is returned by a query.
+
 ## <a name="poolclass"></a> 6. Pool Class
 
 A connection *Pool* object is created by calling the
@@ -2756,11 +2770,10 @@ writing it to a file.  It is similar to the example
 The returned column value is a Lob stream which is piped to an opened
 file stream.
 
-By default the Lob stream is a buffer, so the `setEncoding()` call is
-used to indicate data should be a string.  This CLOB example uses
-'utf8'.  (A buffer would be useful for BLOB data).  Both the Lob
-stream and output data stream have 'error' events to handle unexpected
-issues:
+By default the Lob stream is a Node.js buffer - which is useful for
+BLOB data.  Since this example uses a CLOB, the `setEncoding()` call
+is used to indicate data should be a string.  Both the Lob stream and
+output data stream have 'error' events to handle unexpected issues:
 
 ```javascript
 var oracledb = require('oracledb');

lib/oracledb.js

@@ -49,6 +49,8 @@ function Lob(iLob, opt)
 
       "pieceSize": {get: function() {return iLob.pieceSize;},
                     set: function(newPieceSize) {iLob.pieceSize = newPieceSize;}},
+
+      "type": {get: function() {return iLob.type}}
     });
 }
 

src/njs/src/njsIntLob.cpp

@@ -89,7 +89,7 @@ Persistent<FunctionTemplate> ILob::iLobTemplate_s;
 ILob::ILob():
   lobLocator_(NULL), njsconn_(NULL), dpiconn_(NULL), svch_(NULL), errh_(NULL),
   isValid_(false), state_(INACTIVE), buf_(NULL), bufSize_(0), chunkSize_(0),
-  length_(0), offset_(1), amountRead_(0)
+  length_(0), offset_(1), amountRead_(0), type_(DATA_UNKNOWN)
 {
 
 }
@@ -227,10 +227,12 @@ void ILob::setILob(eBaton *executeBaton, ProtoILob *protoILob)
     {
       // accommodate multi-byte charsets
       buf_ = new char[bufSize_ * dpiconn_->getByteExpansionRatio()];
+      type_ = DATA_CLOB;
     }
-    else
+    else if (fetchType_ == DpiBlob)
     {
       buf_ = new char[bufSize_];
+      type_ = DATA_BLOB;
     }
 
     // Now the ILob object is valid
@@ -293,6 +295,10 @@ void ILob::Init(Handle<Object> target)
                                        ILob::GetOffset,
                                        ILob::SetOffset);
 
+  tpl->InstanceTemplate()->SetAccessor(NanNew<v8::String>("type"),
+                                       ILob::GetType,
+                                       ILob::SetType);
+
   NanAssignPersistent(iLobTemplate_s, tpl);
   target->Set(NanNew<v8::String>("ILob"), tpl->GetFunction());
 }
@@ -521,7 +527,7 @@ NAN_PROPERTY_GETTER(ILob::GetLength)
 /*****************************************************************************/
 /*
   DESCRIPTION
-    Set Accessor of length property - throws error as lenght is a read-only
+    Set Accessor of length property - throws error as length is a read-only
     property.
 
   PARAMETERS
@@ -739,6 +745,66 @@ NAN_SETTER(ILob::SetOffset)
 }
 
 
+/*****************************************************************************/
+/*
+  DESCRIPTION
+    Get Accessor of type property
+
+  PARAMETERS
+    args - ILob object
+
+  RETURNS
+    the type of the LOB (either CLOB or BLOB)
+
+  NOTES
+    
+*/
+
+NAN_PROPERTY_GETTER(ILob::GetType)
+{  
+  NanScope();
+
+  ILob *iLob = ObjectWrap::Unwrap<ILob>(args.Holder());
+
+  try
+  {
+    Local<Number> value = NanNew<v8::Number>((unsigned long)iLob->type_);
+    NanReturnValue(value);
+  }
+
+  catch(dpi::Exception &e)
+  {
+    NJS_SET_EXCEPTION(e.what(), strlen(e.what()));
+    NanReturnUndefined();
+  }
+
+  NanReturnUndefined();
+}
+
+
+/*****************************************************************************/
+/*
+  DESCRIPTION
+    Set Accessor of type property - throws error as type is a read-only
+    property.
+
+  PARAMETERS
+    args - ILob object
+
+  RETURNS
+    throws error
+
+  NOTES
+    
+*/
+
+NAN_SETTER(ILob::SetType)
+{
+  lobPropertyException(ObjectWrap::Unwrap<ILob>(args.Holder()), errReadOnly,
+                       "type");
+}
+
+
 
 /*****************************************************************************/
 /*
@@ -825,7 +891,7 @@ void ILob::Async_Read(uv_work_t *req)
   try
   {
     unsigned long long byteAmount = (unsigned long int)iLob->bufSize_;
-    unsigned long long charAmount = 0; 
+    unsigned long long charAmount = 0;
 
     // Clobs read by characters
     if (iLob->fetchType_ == DpiClob)

src/njs/src/njsIntLob.h

@@ -170,13 +170,15 @@ class ILob : public ObjectWrap
   static NAN_PROPERTY_GETTER(GetLength);
   static NAN_PROPERTY_GETTER(GetPieceSize);
   static NAN_PROPERTY_GETTER(GetOffset);
+  static NAN_PROPERTY_GETTER(GetType);
 
 
                                 // Setters for properties
   static NAN_SETTER(SetChunkSize);
   static NAN_SETTER(SetLength);
   static NAN_SETTER(SetPieceSize);
   static NAN_SETTER(SetOffset);
+  static NAN_SETTER(SetType);
 
 
                                 // Read Method on ILob class
@@ -205,13 +207,14 @@ class ILob : public ObjectWrap
   bool           isValid_;
   State          state_;
 
-  char          *buf_;
-  unsigned int   bufSize_;
-  unsigned int   chunkSize_;
+  char              *buf_;
+  unsigned int       bufSize_;
+  unsigned int       chunkSize_;
   unsigned long long length_;
   unsigned long long offset_;
   unsigned long      amountRead_;
   unsigned long long amountWritten_;
+  unsigned int       type_;
 };