Added binding support for DB_TYPE_BOOLEAN (Diego Arce)

Author: Christopher Jones

CHANGELOG.md

@@ -5,7 +5,10 @@
 - Added support for binding using the node-oracledb [Database Type
   Constants](https://oracle.github.io/node-oracledb/doc/api.html#oracledbconstantsdbtype)
   `DB_TYPE_DATE`, `DB_TYPE_CHAR`, `DB_TYPE_NCHAR`, `DB_TYPE_NVARCHAR`,
-  `DB_TYPE_NCLOB`, `DB_TYPE_TIMESTAMP`, and `DB_TYPE_TIMESTAMP_TZ`.
+  `DB_TYPE_NCLOB`, `DB_TYPE_BINARY_DOUBLE`, `DB_TYPE_BINARY_FLOAT`,
+  `DB_TYPE_BINARY_INTEGER`, `DB_TYPE_TIMESTAMP`, and `DB_TYPE_TIMESTAMP_TZ`.
+
+- Added support for binding using `DB_TYPE_BOOLEAN` (Diego Arce).
 
 - Added support for creating temporary NCLOBS with
   [`connection.createLob(oracledb.NCLOB)`](https://oracle.github.io/node-oracledb/doc/api.html#connectioncreatelob).

doc/api.md

@@ -3127,13 +3127,14 @@ Lob           | NCLOB                          | `oracledb.NCLOB` or `oracledb.D
 String        | ROWID                          | `oracledb.STRING` or `oracledb.DB_TYPE_VARCHAR`     |                                                                   |
 String        | UROWID                         | `oracledb.STRING` or `oracledb.DB_TYPE_VARCHAR`     |                                                                   |
 String        | XMLType                        | `oracledb.STRING` or `oracledb.DB_TYPE_VARCHAR`     | Size is limited to the maximum database VARCHAR length            |
+Boolean       | BOOLEAN                        | `oracledb.DB_TYPE_BOOLEAN`                          | This combination is supported from node-oracledb 4.2.  Only supported for PL/SQL binds |
 ResultSet     | CURSOR                         | `oracledb.CURSOR` or `oracledb.DB_TYPE_CURSOR`      | Only supported for OUT binds                                      |
 DbObject      | Named type or collection       | A string with the name of the Oracle Database object or collection, or a [DbObject](#dbobjectclass) | This combination is supported from node-oracledb 4.0 |
 
 When binding LONG, LONG RAW, CLOB, NCLOB, and BLOB database types using string
 or buffer bind types, then data is limited to a maxium size of 1 GB.
 
-Binding Oracle Database INTERVAL types, BFILE, or BOOLEAN is not supported.
+Binding Oracle Database INTERVAL types or BFILE not supported.
 
 ##### <a name="executebindparamval"></a> 4.2.6.2.5 `val`
 
@@ -11153,7 +11154,7 @@ For IN binds:
 - The `val` attribute may be a constant or a JavaScript variable.
 
 - If `type` is omitted, it is derived from the bind data value.  If it is set,
-  it can be one of the values in the [`type`](#executebindparamtype) table.
+  it can be one of the values in the [`type` table](#executebindparamtype).
   Typically `type` is one of `oracledb.STRING`, `oracledb.NUMBER`,
   `oracledb.DATE` or `oracledb.BUFFER` matching the standard Node.js type of the
   data being passed into the database.  Use a bind type of `oracledb.BLOB` or
@@ -11248,9 +11249,9 @@ bind variable object containing [`dir`](#executebindparamdir),
 - The `val` parameter in needed when binding IN OUT to pass a value
   into the database.  It is not used for OUT binds.
 
-- The `type` attribute can be one of the constants as discussed in [`execute()`
-  `bindParams` `type`](#executebindparamtype).  This determines the mapping
-  between the database type and the JavaScript type.
+- The `type` attribute can be one of the constants as discussed in the [`type`
+  table](#executebindparamtype).  This determines the mapping between the
+  database type and the JavaScript type.
 
   The attribute should be set for OUT binds.  If `type` is not specified, then
   `oracledb.STRING` is assumed.
@@ -11260,11 +11261,10 @@ bind variable object containing [`dir`](#executebindparamdir),
   determined if the input data is null.  The output data type will always be the
   same as the input data type.
 
-- A `maxSize` attribute should be set for `oracledb.STRING` or
-  `oracledb.BUFFER` OUT or IN OUT binds.  This is the maximum number
-  of bytes the bind parameter will return.  If the output value does
-  not fit in `maxSize` bytes, then an error such *ORA-06502: PL/SQL:
-  numeric or value error: character string buffer too small* or
+- A `maxSize` attribute should be set for String and Buffer OUT or IN OUT binds.
+  This is the maximum number of bytes the bind parameter will return.  If the
+  output value does not fit in `maxSize` bytes, then an error such *ORA-06502:
+  PL/SQL: numeric or value error: character string buffer too small* or
   *NJS-016: buffer is too small for OUT binds* occurs.
 
   A default value of 200 bytes is used when `maxSize` is not provided for OUT

src/njsBaton.c

@@ -917,7 +917,7 @@ bool njsBaton_isBindValue(njsBaton *baton, napi_env env, napi_value value)
         return false;
     if (valueType != napi_undefined && valueType != napi_null &&
             valueType != napi_number && valueType != napi_string &&
-            valueType != napi_object)
+            valueType != napi_object && valueType != napi_boolean)
         return false;
     if (valueType != napi_object)
         return true;

src/njsConnection.c

@@ -1088,6 +1088,12 @@ static bool njsConnection_getBindInfoFromValue(njsBaton *baton,
         return true;
     }
 
+    // booleans
+    if (valueType == napi_boolean) {
+        *bindType = NJS_DATATYPE_BOOLEAN;
+        return true;
+    }
+
     // dates, LOBs, buffers and arrays are all objects
     if (valueType == napi_object) {
 

src/njsDbObject.c

@@ -826,6 +826,10 @@ static bool njsDbObject_transformFromOracle(njsDbObject *obj, napi_env env,
         case DPI_ORACLE_TYPE_OBJECT:
             return njsDbObject_new(typeInfo->objectType, data->value.asObject,
                     env, value);
+        case DPI_ORACLE_TYPE_BOOLEAN:
+            NJS_CHECK_NAPI(env, napi_get_boolean(env, data->value.asBoolean,
+                    value))
+            return true;
         default:
             break;
     }
@@ -852,9 +856,9 @@ static bool njsDbObject_transformToOracle(njsDbObject *obj, napi_env env,
     napi_valuetype valueType;
     njsDbObjectType *objType;
     njsDbObject *valueObj;
+    bool check, tempBool;
     void *bufferData;
     size_t length;
-    bool check;
 
     data->isNull = 0;
     *strBuffer = NULL;
@@ -885,6 +889,13 @@ static bool njsDbObject_transformToOracle(njsDbObject *obj, napi_env env,
             }
             return true;
 
+        // handle booleans
+        case napi_boolean:
+            NJS_CHECK_NAPI(env, napi_get_value_bool(env, value, &tempBool))
+            *nativeTypeNum = DPI_NATIVE_TYPE_BOOLEAN;
+            data->value.asBoolean = (int) tempBool;
+            return true;
+
         // several types of objects are supported
         case napi_object:
 

src/njsModule.h

@@ -133,6 +133,7 @@
 #define NJS_DATATYPE_CLOB               DPI_ORACLE_TYPE_CLOB
 #define NJS_DATATYPE_NCLOB              DPI_ORACLE_TYPE_NCLOB
 #define NJS_DATATYPE_BLOB               DPI_ORACLE_TYPE_BLOB
+#define NJS_DATATYPE_BOOLEAN            DPI_ORACLE_TYPE_BOOLEAN
 #define NJS_DATATYPE_OBJECT             DPI_ORACLE_TYPE_OBJECT
 
 // error messages used within the driver

src/njsVariable.c

@@ -99,6 +99,9 @@ bool njsVariable_createBuffer(njsVariable *var, njsConnection *conn,
         case DPI_ORACLE_TYPE_BLOB:
             var->nativeTypeNum = DPI_NATIVE_TYPE_LOB;
             break;
+        case NJS_DATATYPE_BOOLEAN:
+            var->nativeTypeNum = DPI_NATIVE_TYPE_BOOLEAN;
+            break;
         case DPI_ORACLE_TYPE_OBJECT:
             var->nativeTypeNum = DPI_NATIVE_TYPE_OBJECT;
             break;
@@ -424,6 +427,10 @@ bool njsVariable_getScalarValue(njsVariable *var, njsVariableBuffer *buffer,
             NJS_CHECK_NAPI(env, napi_create_string_utf8(env, rowidValue,
                     rowidValueLength, value))
             break;
+        case DPI_NATIVE_TYPE_BOOLEAN:
+            NJS_CHECK_NAPI(env, napi_get_boolean(env, data->value.asBoolean,
+                    value))
+            break;
         case DPI_NATIVE_TYPE_OBJECT:
             if (!njsDbObject_new(var->objectType, data->value.asObject,
                     env, value))
@@ -962,6 +969,15 @@ bool njsVariable_setScalarValue(njsVariable *var, uint32_t pos, napi_env env,
         return true;
     }
 
+    // handle binding booleans
+    if (valueType == napi_boolean) {
+        if (var->varTypeNum != DPI_ORACLE_TYPE_BOOLEAN)
+            return njsVariable_setInvalidBind(var, pos, baton);
+        NJS_CHECK_NAPI(env, napi_get_value_bool(env, value,
+                (bool*) &data->value.asBoolean))
+        return true;
+    }
+
     // handle binding objects
     if (valueType == napi_object) {