Added oracledb.oracleClientVersion and connection.oracleServerVersion

Author: cjbj

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## node-oracledb v1.3.0 (DD Mon YYYY)
 
+- Added oracledb.oracleClientVersion property giving the version of the Oracle
+  client library, and connection.oracleServerVersion property giving the Oracle
+  Database Server version.
+
 - BIND_IN is default when not specified.
 
 - Fixed 11.2.0.4 DB-specific NULL output with DML RETURNING when string value is of size 4k.

binding.gyp

@@ -18,7 +18,8 @@
              "src/dpi/src/dpiPoolImpl.cpp",
              "src/dpi/src/dpiStmtImpl.cpp",
              "src/dpi/src/dpiUtils.cpp",
-             "src/dpi/src/dpiLob.cpp"
+             "src/dpi/src/dpiLob.cpp",
+             "src/dpi/src/dpiCommon.cpp"
     ],
     "conditions" : [
     [

doc/api.md

@@ -42,14 +42,15 @@ limitations under the License.
      - 3.2.4 [fetchAsString](#propdbfetchasstring)
      - 3.2.5 [lobPrefetchSize](#propdblobprefetchsize)
      - 3.2.6 [maxRows](#propdbmaxrows)
-     - 3.2.7 [outFormat](#propdboutformat)
-     - 3.2.8 [poolIncrement](#propdbpoolincrement)
-     - 3.2.9 [poolMax](#propdbpoolmax)
-     - 3.2.10 [poolMin](#propdbpoolmin)
-     - 3.2.11 [poolTimeout](#propdbpooltimeout)
-     - 3.2.12 [prefetchRows](#propdbprefetchrows)
-     - 3.2.13 [stmtCacheSize](#propdbstmtcachesize)
-     - 3.2.14 [version](#propdbversion)
+     - 3.2.7 [oracleClientVersion](#propdboracleClientVersion)
+     - 3.2.8 [outFormat](#propdboutformat)
+     - 3.2.9 [poolIncrement](#propdbpoolincrement)
+     - 3.2.10 [poolMax](#propdbpoolmax)
+     - 3.2.11 [poolMin](#propdbpoolmin)
+     - 3.2.12 [poolTimeout](#propdbpooltimeout)
+     - 3.2.13 [prefetchRows](#propdbprefetchrows)
+     - 3.2.14 [stmtCacheSize](#propdbstmtcachesize)
+     - 3.2.15 [version](#propdbversion)
   - 3.3 [Oracledb Methods](#oracledbmethods)
      - 3.3.1 [createPool()](#createpool)
      - 3.3.2 [getConnection()](#getconnectiondb)
@@ -58,7 +59,8 @@ limitations under the License.
      - 4.1.1 [action](#propconnaction)
      - 4.1.2 [clientId](#propconnclientid)
      - 4.1.3 [module](#propconnmodule)
-     - 4.1.4 [stmtCacheSize](#propconnstmtcachesize)
+     - 4.1.4 [oracleServerVersion](#propconnoracleserverversion)
+     - 4.1.5 [stmtCacheSize](#propconnstmtcachesize)
   - 4.2 [Connection Methods](#connectionmethods)
      - 4.2.1 [break()](#break)
      - 4.2.2 [commit()](#commit)
@@ -504,7 +506,23 @@ var oracledb = require('oracledb');
 oracledb.lobPrefetchSize = 16384;
 ```
 
-#### <a name="propdboutformat"></a> 3.2.7 outFormat
+#### <a name="propdboracleClientVersion"></a> 3.2.7 oracleClientVersion
+
+```
+readonly Number oracleClientVersion
+```
+
+This readonly property gives a numeric representation of the Oracle client library version. 
+For version *a.b.c.d.e*, this property gives the number: `(100000000 * a) + (1000000 * b) + (10000 * c) + (100 * d) + e`
+
+##### Example
+
+```javascript
+var oracledb = require('oracledb');
+console.log("Oracle client library version number is " + oracledb.oracleClientVersion);
+```
+
+#### <a name="propdboutformat"></a> 3.2.8 outFormat
 
 ```
 Number outFormat
@@ -534,7 +552,7 @@ var oracledb = require('oracledb');
 oracledb.outFormat = oracledb.ARRAY;
 ```
 
-#### <a name="propdbpoolincrement"></a> 3.2.8 poolIncrement
+#### <a name="propdbpoolincrement"></a> 3.2.9 poolIncrement
 
 ```
 Number poolIncrement
@@ -554,7 +572,7 @@ var oracledb = require('oracledb');
 oracledb.poolIncrement = 1;
 ```
 
-#### <a name="propdbpoolmax"></a> 3.2.9 poolMax
+#### <a name="propdbpoolmax"></a> 3.2.10 poolMax
 
 ```
 Number poolMax
@@ -573,7 +591,7 @@ var oracledb = require('oracledb');
 oracledb.poolMax = 4;
 ```
 
-#### <a name="propdbpoolmin"></a> 3.2.10 poolMin
+#### <a name="propdbpoolmin"></a> 3.2.11 poolMin
 
 ```
 Number poolMin
@@ -593,7 +611,7 @@ var oracledb = require('oracledb');
 oracledb.poolMin = 0;
 ```
 
-#### <a name="propdbpooltimeout"></a> 3.2.11 poolTimeout
+#### <a name="propdbpooltimeout"></a> 3.2.12 poolTimeout
 
 ```
 Number poolTimeout
@@ -615,7 +633,7 @@ var oracledb = require('oracledb');
 oracledb.poolTimeout = 60;
 ```
 
-#### <a name="propdbprefetchrows"></a> 3.2.12 prefetchRows
+#### <a name="propdbprefetchrows"></a> 3.2.13 prefetchRows
 
 ```
 Number prefetchRows
@@ -645,7 +663,7 @@ var oracledb = require('oracledb');
 oracledb.prefetchRows = 100;
 ```
 
-#### <a name="propdbstmtcachesize"></a> 3.2.13 stmtCacheSize
+#### <a name="propdbstmtcachesize"></a> 3.2.14 stmtCacheSize
 
 ```
 Number stmtCacheSize
@@ -672,12 +690,12 @@ var oracledb = require('oracledb');
 oracledb.stmtCacheSize = 30;
 ```
 
-#### <a name="propdbversion"></a> 3.2.14 version
+#### <a name="propdbversion"></a> 3.2.15 version
 ```
 readonly Number version
 ```
 
-This readonly property gives a numeric representation of the node-oracledb's version.
+This readonly property gives a numeric representation of the node-oracledb version.
 For version *x.y.z*, this property gives the number: `(10000 * x) + (100 * y) + z`
 
 ##### Example
@@ -994,7 +1012,16 @@ This is a write-only property.  Displaying a Connection object will
 show a value of `null` for this attribute.  See
 [End-to-end Tracing, Mid-tier Authentication, and Auditing](#endtoend).
 
-#### <a name="propconnstmtcachesize"></a> 4.1.4 stmtCacheSize
+#### <a name="propconnoracleserverversion"></a> 4.1.4 oracleServerVersion
+
+```
+readonly Number oracleServerVersion
+```
+
+This readonly property gives a numeric representation of the Oracle database version. 
+For version *a.b.c.d.e*, this property gives the number: `(100000000 * a) + (1000000 * b) + (10000 * c) + (100 * d) + e`
+
+#### <a name="propconnstmtcachesize"></a> 4.1.5 stmtCacheSize
 
 ```
 readonly Number stmtCacheSize

examples/connect.js

@@ -39,7 +39,6 @@ oracledb.getConnection(
       console.error(err.message);
       return;
     }
-
     console.log('Connection was successful!');
 
     connection.release(

examples/version.js

@@ -19,15 +19,51 @@
  *   version.js
  *
  * DESCRIPTION
- *   Shows the oracledb version attribute
+ *   Shows the oracledb version attributes
  *
  *****************************************************************************/
 
 var oracledb = require('oracledb');
+var dbConfig = require('./dbconfig.js');
 
-console.log("Driver version number is " + oracledb.version);
+var addonVer, clientVer, serverVer;
+var major, minor, update, port, portUpdate;
 
-major = Math.floor(oracledb.version/10000);
-minor = Math.floor(oracledb.version/100) % 100;
-patch = oracledb.version % 100;
-console.log("Driver version text is " + major + "." + minor + "." + patch);
+addonVer = oracledb.version
+major  = Math.floor(addonVer / 10000);
+minor  = Math.floor(addonVer / 100) % 100;
+update = addonVer % 100;
+console.log("Node-oracledb version: " + addonVer);
+console.log("Node-oracledb text format: " + major + "." + minor + "." + update);
+
+clientVer = oracledb.oracleClientVersion;
+major      = Math.floor (clientVer / 100000000);
+minor      = Math.floor (clientVer / 1000000) % 100 ;
+update     = Math.floor (clientVer / 10000) % 100 ;
+port       = Math.floor (clientVer / 100) % 100 ;
+portUpdate = clientVer % 100 ;
+console.log("Oracle Client library version: " +clientVer);
+console.log("Oracle Client library text format: " + major + "." + minor + "." + update + "." + port + "." + portUpdate);
+
+oracledb.getConnection(
+  {
+    user          : dbConfig.user,
+    password      : dbConfig.password,
+    connectString : dbConfig.connectString
+  },
+  function(err, connection)
+  {
+    if (err) {
+      console.error(err.message);
+      return;
+    }
+
+    serverVer = connection.oracleServerVersion;
+    major      = Math.floor (serverVer / 100000000);
+    minor      = Math.floor (serverVer / 1000000) % 100 ;
+    update     = Math.floor (serverVer / 10000) % 100 ;
+    port       = Math.floor (serverVer / 100) % 100 ;
+    portUpdate = serverVer % 100 ;
+    console.log ("Oracle Database version: " + serverVer);
+    console.log("Oracle Database text format: " + major + "." + minor + "." + update + "." + port + "." + portUpdate);
+});

src/dpi/include/dpiCommon.h

@@ -56,6 +56,18 @@ enum DescriptorType
 struct DpiHandle;
 struct Descriptor;
 
+
+/* Utiltiy class containing common functions */
+class Common
+{
+public:
+  // To obtain the Oracle Client Library Version
+  static void clientVersion (int *majorv, int *minorv, int *patchv,
+                                        int *portv, int *portUpdv );
+};
+
+
+
 /*----------------------------------------------------------------------------
                      PUBLIC METHODS
   ----------------------------------------------------------------------------*/

src/dpi/include/dpiConn.h

@@ -88,6 +88,8 @@ class Conn
 
   virtual DpiHandle *getErrh () = 0;
 
+  virtual unsigned int getServerVersion () = 0;
+
 protected:
                                 // clients cannot do new and delete
   Conn(){};

src/dpi/include/dpiEnv.h

@@ -86,6 +86,7 @@ class Env
   virtual void externalAuth(bool externalAuth) = 0;
   virtual bool externalAuth() const = 0;
 
+
                                  // methods
   virtual SPool * createPool(const string &user, const string &password,
                              const string &connString,

src/dpi/include/dpiException.h

@@ -54,6 +54,7 @@ enum DpiError                          // error type
   DpiOciInvalidHandle,
     // "Invalid OCI Handle/Descriptor or invalid parameter for OCI handle/descriptor allocation call"
   DpiErrMemAllocFail,   // "Memory allocatio failed"
+  DpiErrNullValue,      // "Unexpected NULL value"
 };
 
 

src/dpi/src/dpiConnImpl.cpp

@@ -56,6 +56,8 @@
 #define DPI_CONNERR_ORA_NOT_LOGGED_ON             1012
 #define DPI_CONNERR_MAX_IDLE_TIMEOUT              2396
 
+#define DPI_MAX_VERSION_SIZE                      512
+
 using namespace std;
 
 
@@ -130,7 +132,8 @@ ConnImpl::ConnImpl(PoolImpl *pool, OCIEnv *envh, bool externalAuth,
 
 try :  env_(NULL), pool_(pool),
        envh_(envh), errh_(NULL), auth_(NULL),
-       svch_(NULL), sessh_(NULL), hasTxn_(false), srvh_(NULL), dropConn_(false)
+       svch_(NULL), sessh_(NULL), hasTxn_(false), srvh_(NULL),
+       dropConn_(false)
 {
   this->initConnImpl ( true, externalAuth, connClass, poolName, poolNameLen,
                        "", "" );
@@ -525,6 +528,31 @@ void ConnImpl::setErrState ( int errNum )
 }
 
 
+/*****************************************************************************/
+/*
+  DESCRIPTION
+    To obtain the Oracle Database Server version
+
+  PARAMETERS
+    -None-
+
+  RETURNS
+    version
+*/
+unsigned int ConnImpl::getServerVersion ()
+{
+  ub4  oraServerVer = 0;
+  char verbuf[ DPI_MAX_VERSION_SIZE ];
+
+  ociCall ( OCIServerRelease ( svch_, errh_, (OraText *)verbuf,
+                               (ub4) sizeof ( verbuf ),
+                               (ub1) OCI_HTYPE_SVCCTX, &oraServerVer ),
+              errh_ ) ;
+
+  return oraServerVer;
+}
+
+
 /*---------------------------------------------------------------------------
                           PRIVATE METHODS
   ---------------------------------------------------------------------------*/