mg-dbx 2.4.27 → 2.4.28

package/README.md

@@ -3,9 +3,9 @@
 High speed Synchronous and Asynchronous access to InterSystems Cache/IRIS and YottaDB from Node.js.
 
 Chris Munt <cmunt@mgateway.com>  
-20 October 2021, M/Gateway Developments Ltd [http://www.mgateway.com](http://www.mgateway.com)
+7 November 2023, MGateway Ltd [http://www.mgateway.com](http://www.mgateway.com)
 
-* Verified to work with Node.js v8 to v17.
+* Verified to work with Node.js v8 to v20.
 * Two connectivity models to the InterSystems or YottaDB database are provided: High performance via the local database API or network based.
 * [Release Notes](#RelNotes) can be found at the end of this document.
 
@@ -61,6 +61,9 @@ Assuming that Node.js is already installed and a C++ compiler is available to th
 
 This command will create the **mg-dbx** addon (*mg-dbx.node*).
 
+### Enabling the API for InterSystems IRIS and Cache
+
+Before connecting to a local (relative to Node.js) InterSystems database via its API, check that the InterSystems ***'Callin API'*** is enabled.  From the InterSystems Database Management Portal select ***System Administration***; then ***Security***; then ***Services***.  Look for the row containing ***%Service_Callin*** and check that it is ***Enabled***.  Edit the row and mark this service as ***Enabled*** if necessary.
 
 ### Installing the M support routines (also known as the DB Superserver)
 
@@ -70,6 +73,8 @@ The M support routines are required for:
 * Direct access to SQL (either via the API or via the network).
 * The Merge command under YottaDB (either via the API or via the network).
 
+If none of the above apply you do not need to install these routines - proceed to  [Connecting to the database](#Connect). 
+
 Two M routines need to be installed (%zmgsi and %zmgsis).  These can be found in the *Service Integration Gateway* (**mgsi**) GitHub source code repository ([https://github.com/chrisemunt/mgsi](https://github.com/chrisemunt/mgsi)).  Note that it is not necessary to install the whole *Service Integration Gateway*, just the two M routines held in that repository.
 
 #### Installation for InterSystems Cache/IRIS
@@ -82,8 +87,8 @@ Change to your development UCI and check the installation:
 
        do ^%zmgsi
 
-       M/Gateway Developments Ltd - Service Integration Gateway
-       Version: 4.4; Revision 25 (2 September 2021)
+       MGateway Ltd - Service Integration Gateway
+       Version: 4.5; Revision 28 (3 February 2023)
 
 
 #### Installation for YottaDB
@@ -111,8 +116,8 @@ Link all the **zmgsi** routines and check the installation:
 
        do ^%zmgsi
 
-       M/Gateway Developments Ltd - Service Integration Gateway
-       Version: 4.4; Revision 25 (2 September 2021)
+       MGateway Ltd - Service Integration Gateway
+       Version: 4.5; Revision 28 (3 February 2023)
 
 Note that the version of **zmgsi** is successfully displayed.
 
@@ -1021,7 +1026,7 @@ Logging can be switched off by calling the **setloglevel** function without spec
 
 ## <a name="License"></a> License
 
-Copyright (c) 2018-2021 M/Gateway Developments Ltd,
+Copyright (c) 2018-2023 MGateway Ltd,
 Surrey UK.                                                      
 All rights reserved.
  
@@ -1201,4 +1206,25 @@ Unless required by applicable law or agreed to in writing, software distributed
 
 ### v2.4.27 (20 October 2021)
 
-* Verify that **mg-dbx** will build and work with Node.js v17.x.x.
+* Verify that **mg-dbx** will build and work with Node.js v17.x.x.
+
+### v2.4.27a (25 April 2022)
+
+* Verify that **mg-dbx** will build and work with Node.js v18.x.x.
+
+### v2.4.27b (4 November 2022)
+
+* Verify that **mg-dbx** will build and work with Node.js v19.x.x.
+
+### v2.4.27c (3 May 2023)
+
+* Verify that **mg-dbx** will build and work with Node.js v20.x.x.
+
+### v2.4.27d (22 June 2023)
+
+* Documentation update.
+
+### v2.4.28 (7 November 2023)
+
+* Correct a fault affecting the return of Unicode data to Node.js through SQL.
+

package/package.json

@@ -2,7 +2,7 @@
   "author": "Chris Munt <cmunt@mgateway.com> (http://www.gateway.com/)",
   "name": "mg-dbx",
   "description": "High speed Synchronous and Asynchronous access to InterSystems Cache/IRIS and YottaDB from Node.js.",
-  "version": "2.4.27",
+  "version": "2.4.28",
   "maintainers": "Chris Munt <cmunt@mgateway.com>",
   "homepage": "https://github.com/chrisemunt/mg-dbx",
   "repository": {

package/src/mg-class.cpp

@@ -3,7 +3,7 @@
    | mg-dbx.node                                                              |
    | Author: Chris Munt cmunt@mgateway.com                                    |
    |                    chris.e.munt@gmail.com                                |
-   | Copyright (c) 2016-2021 M/Gateway Developments Ltd,                      |
+   | Copyright (c) 2019-2023 MGateway Ltd                                     |
    | Surrey UK.                                                               |
    | All rights reserved.                                                     |
    |                                                                          |

package/src/mg-class.h

@@ -3,7 +3,7 @@
    | mg-dbx.node                                                              |
    | Author: Chris Munt cmunt@mgateway.com                                    |
    |                    chris.e.munt@gmail.com                                |
-   | Copyright (c) 2016-2021 M/Gateway Developments Ltd,                      |
+   | Copyright (c) 2019-2023 MGateway Ltd                                     |
    | Surrey UK.                                                               |
    | All rights reserved.                                                     |
    |                                                                          |

package/src/mg-cursor.cpp

@@ -3,7 +3,7 @@
    | mg-dbx.node                                                              |
    | Author: Chris Munt cmunt@mgateway.com                                    |
    |                    chris.e.munt@gmail.com                                |
-   | Copyright (c) 2016-2021 M/Gateway Developments Ltd,                      |
+   | Copyright (c) 2019-2023 MGateway Ltd                                     |
    | Surrey UK.                                                               |
    | All rights reserved.                                                     |
    |                                                                          |
@@ -552,7 +552,8 @@ void mcursor::Next(const FunctionCallbackInfo<Value>& args)
             }
 
             key = dbx_new_string8n(isolate, (char *) pmeth->psql->cols[n]->name.buf_addr, pmeth->psql->cols[n]->name.len_used, 0);
-            DBX_SET(obj, key, dbx_new_string8n(isolate,  pmeth->output_val.svalue.buf_addr + pmeth->output_val.offs, len, 0));
+            /* v2.4.28 add utf8 flag */
+            DBX_SET(obj, key, dbx_new_string8n(isolate,  pmeth->output_val.svalue.buf_addr + pmeth->output_val.offs, len, pcon->utf8));
             pmeth->output_val.offs += len;
          }
 

package/src/mg-cursor.h

@@ -3,7 +3,7 @@
    | mg-dbx.node                                                              |
    | Author: Chris Munt cmunt@mgateway.com                                    |
    |                    chris.e.munt@gmail.com                                |
-   | Copyright (c) 2016-2021 M/Gateway Developments Ltd,                      |
+   | Copyright (c) 2019-2023 MGateway Ltd                                     |
    | Surrey UK.                                                               |
    | All rights reserved.                                                     |
    |                                                                          |

package/src/mg-dbx.cpp

@@ -3,7 +3,7 @@
    | mg-dbx.node                                                              |
    | Author: Chris Munt cmunt@mgateway.com                                    |
    |                    chris.e.munt@gmail.com                                |
-   | Copyright (c) 2016-2021 M/Gateway Developments Ltd,                      |
+   | Copyright (c) 2019-2023 MGateway Ltd                                     |
    | Surrey UK.                                                               |
    | All rights reserved.                                                     |
    |                                                                          |
@@ -162,6 +162,21 @@ Version 2.4.26 2 September 2021:
 Version 2.4.27 20 October 2021:
    Verify that mg-dbx will build and work with Node.js v17.x.x. (ABI: 102).
 
+Version 2.4.27a 25 April 2022:
+   Verify that mg-dbx will build and work with Node.js v18.x.x. (ABI: 108).
+
+Version 2.4.27b 4 November 2022:
+   Verify that mg-dbx will build and work with Node.js v19.x.x. (ABI: 111).
+
+Version 2.4.27c 3 May 2023:
+   Verify that mg-dbx will build and work with Node.js v20.x.x. (ABI: 115).
+
+Version 2.4.27d 22 June 2023:
+   Documentation update.
+
+Version 2.4.28 7 November 2023:
+   Correct a fault affecting the return of Unicode data to Node.js through SQL.
+
 */
 
 
@@ -7207,6 +7222,7 @@ __try {
 
          if (pcon->p_isc_so->loaded) {
             /* pcon->p_isc_so->p_CacheEnd(); */
+            pcon->p_isc_so->p_CacheEnd();
             dbx_dso_unload(pcon->p_isc_so->p_library);
             pcon->p_isc_so->p_library = NULL;
             pcon->p_isc_so->loaded = 0;
@@ -9104,6 +9120,7 @@ __except (EXCEPTION_EXECUTE_HANDLER) {
 int dbx_sql_execute(DBXMETH *pmeth)
 {
    int rc, len, dsort, dtype, cn, no_cols;
+   short utf16;
    unsigned long offset;
    char label[16], routine[16], params[9], buffer[8];
    DBXFUN fun;
@@ -9119,6 +9136,9 @@ __try {
    strcpy(pmeth->psql->sqlstate, "00000");
 
    strcpy(params, "");
+   if (pcon->utf8 == 2) { /* v2.4.28 */
+      strcat(params,";utf16");
+   }
    if (pmeth->psql->sql_type == DBX_SQL_ISCSQL) {
       strcpy(label, "sqleisc");
    }
@@ -9144,13 +9164,15 @@ __try {
 
    if (pcon->log_transmissions) {
       int nx;
+      char label_log[64]; /* v2.4.28 */
       v8::Local<v8::String> str;
 
       pmeth->ibuffer_used = 0;
       nx = 0;
-      strcat(label, "^");
-      strcat(label, routine);
-      dbx_ibuffer_add(pmeth, NULL, nx ++, str, (void *) label, (int) strlen(label), 0, 0);
+      strcpy(label_log, label);
+      strcat(label_log, "^");
+      strcat(label_log, routine);
+      dbx_ibuffer_add(pmeth, NULL, nx ++, str, (void *) label_log, (int) strlen(label_log), 0, 0);
       sprintf(buffer, "%d", pmeth->psql->sql_no);
       dbx_ibuffer_add(pmeth, NULL, nx ++, str, (void *) buffer, (int) strlen(buffer), 0, 0);
       dbx_ibuffer_add(pmeth, NULL, nx ++, str, (void *) pmeth->psql->sql_script, (int) strlen(pmeth->psql->sql_script), 0, 0);
@@ -9214,7 +9236,11 @@ __try {
       rc = pcon->p_isc_so->p_CachePushStr((int) strlen(params), (Callin_char_t *) params);
       rc = pcon->p_isc_so->p_CacheExtFun(fun.rflag, 3);
       if (rc == CACHE_SUCCESS) {
+         /* v2.4.28 */
+         utf16 = pcon->utf16;
+         pcon->utf16 = 0;
          isc_pop_value(pmeth, &(pmeth->output_val), DBX_DTYPE_STR);
+         pcon->utf16 = utf16;
       }
       isc_cleanup(pmeth);
    }
@@ -9310,6 +9336,7 @@ __except (EXCEPTION_EXECUTE_HANDLER) {
 int dbx_sql_row(DBXMETH *pmeth, int rn, int dir)
 {
    int rc, len, dsort, dtype, row_no, eod;
+   short utf16;
    unsigned long offset;
    char label[16], routine[16], params[9], buffer[8], rowstr[8];
    DBXFUN fun;
@@ -9329,6 +9356,11 @@ __try {
       strcpy(params, "-1");
    else
       strcpy(params, "");
+
+   if (pcon->utf8 == 2) { /* v2.4.28 */
+      strcat(params,";utf16");
+   }
+
    strcpy(label, "sqlrow");
 
    strcpy(routine, "%zmgsis");
@@ -9345,13 +9377,14 @@ __try {
 
    if (pcon->log_transmissions) {
       int nx;
+      char label_log[64]; /* v2.4.28 */
       v8::Local<v8::String> str;
 
       pmeth->ibuffer_used = 0;
       nx = 0;
-      strcat(label, "^");
-      strcat(label, routine);
-      dbx_ibuffer_add(pmeth, NULL, nx ++, str, (void *) label, (int) strlen(label), 0, 0);
+      strcat(label_log, "^");
+      strcat(label_log, routine);
+      dbx_ibuffer_add(pmeth, NULL, nx ++, str, (void *) label_log, (int) strlen(label_log), 0, 0);
       sprintf(buffer, "%d", pmeth->psql->sql_no);
       dbx_ibuffer_add(pmeth, NULL, nx ++, str, (void *) buffer, (int) strlen(buffer), 0, 0);
       sprintf(rowstr, "%d", rn);
@@ -9418,7 +9451,11 @@ __try {
       rc = pcon->p_isc_so->p_CachePushStr((int) strlen(params), (Callin_char_t *) params);
       rc = pcon->p_isc_so->p_CacheExtFun(fun.rflag, 3);
       if (rc == CACHE_SUCCESS) {
+         /* v2.4.28 */
+         utf16 = pcon->utf16;
+         pcon->utf16 = 0;
          isc_pop_value(pmeth, &(pmeth->output_val), DBX_DTYPE_STR);
+         pcon->utf16 = utf16;
       }
       isc_cleanup(pmeth);
    }
@@ -9468,9 +9505,9 @@ __try {
    row_no = (int) strtol(buffer, NULL, 10);
    pmeth->psql->row_no = row_no;
    pmeth->output_val.offs = offset;
-
-   /* printf("\r\nROW NUMBER: len=%d; row_no=%d; pmeth->output_val.offs=%d; total=%d;", len, row_no, pmeth->output_val.offs, pmeth->output_val.svalue.len_used); */
-
+/*
+   printf("\r\nROW NUMBER: len=%d; row_no=%d; pmeth->output_val.offs=%d; total=%d;", len, row_no, pmeth->output_val.offs, pmeth->output_val.svalue.len_used);
+*/
 dbx_sql_row_exit:
 
    return eod;
@@ -9512,6 +9549,10 @@ __try {
    strcpy(pmeth->psql->sqlstate, "00000");
    pmeth->output_val.offs = 0;
    strcpy(params, "");
+   if (pcon->utf8 == 2) { /* v2.4.28 */
+      strcat(params,";utf16");
+   }
+
    strcpy(label, "sqldel");
 
    strcpy(routine, "%zmgsis");
@@ -9528,13 +9569,14 @@ __try {
 
    if (pcon->log_transmissions) {
       int nx;
+      char label_log[64]; /* v2.4.28 */
       v8::Local<v8::String> str;
 
       pmeth->ibuffer_used = 0;
       nx = 0;
-      strcat(label, "^");
-      strcat(label, routine);
-      dbx_ibuffer_add(pmeth, NULL, nx ++, str, (void *) label, (int) strlen(label), 0, 0);
+      strcat(label_log, "^");
+      strcat(label_log, routine);
+      dbx_ibuffer_add(pmeth, NULL, nx ++, str, (void *) label_log, (int) strlen(label_log), 0, 0);
       sprintf(buffer, "%d", pmeth->psql->sql_no);
       dbx_ibuffer_add(pmeth, NULL, nx ++, str, (void *) buffer, (int) strlen(buffer), 0, 0);
       dbx_ibuffer_add(pmeth, NULL, nx ++, str, (void *) params, (int) strlen(params), 0, 0);

package/src/mg-dbx.h

@@ -3,7 +3,7 @@
    | mg-dbx.node                                                              |
    | Author: Chris Munt cmunt@mgateway.com                                    |
    |                    chris.e.munt@gmail.com                                |
-   | Copyright (c) 2016-2021 M/Gateway Developments Ltd,                      |
+   | Copyright (c) 2019-2023 MGateway Ltd                                     |
    | Surrey UK.                                                               |
    | All rights reserved.                                                     |
    |                                                                          |
@@ -33,7 +33,7 @@
 
 #define DBX_VERSION_MAJOR        "2"
 #define DBX_VERSION_MINOR        "4"
-#define DBX_VERSION_BUILD        "27"
+#define DBX_VERSION_BUILD        "28"
 
 #define DBX_VERSION              DBX_VERSION_MAJOR "." DBX_VERSION_MINOR "." DBX_VERSION_BUILD
 
@@ -203,6 +203,8 @@ DISABLE_WCAST_FUNCTION_TYPE
 #define DBX_CMND_CGETP           42
 #define DBX_CMND_CSETP           43
 #define DBX_CMND_CMETH           44
+/* v2.4.28 */
+#define DBX_CMND_CCLOSE          45
 
 #define DBX_CMND_GNAMENEXT       51
 #define DBX_CMND_GNAMEPREVIOUS   52

package/src/mg-global.cpp

@@ -3,7 +3,7 @@
    | mg-dbx.node                                                              |
    | Author: Chris Munt cmunt@mgateway.com                                    |
    |                    chris.e.munt@gmail.com                                |
-   | Copyright (c) 2016-2021 M/Gateway Developments Ltd,                      |
+   | Copyright (c) 2019-2023 MGateway Ltd                                     |
    | Surrey UK.                                                               |
    | All rights reserved.                                                     |
    |                                                                          |

package/src/mg-global.h

@@ -3,7 +3,7 @@
    | mg-dbx.node                                                              |
    | Author: Chris Munt cmunt@mgateway.com                                    |
    |                    chris.e.munt@gmail.com                                |
-   | Copyright (c) 2016-2021 M/Gateway Developments Ltd,                      |
+   | Copyright (c) 2019-2023 MGateway Ltd                                     |
    | Surrey UK.                                                               |
    | All rights reserved.                                                     |
    |                                                                          |

package/src/mg-net.cpp

@@ -3,7 +3,7 @@
    | mg-dbx.node                                                              |
    | Author: Chris Munt cmunt@mgateway.com                                    |
    |                    chris.e.munt@gmail.com                                |
-   | Copyright (c) 2016-2021 M/Gateway Developments Ltd,                      |
+   | Copyright (c) 2019-2023 MGateway Ltd                                     |
    | Surrey UK.                                                               |
    | All rights reserved.                                                     |
    |                                                                          |

package/src/mg-net.h

@@ -3,7 +3,7 @@
    | mg-dbx.node                                                              |
    | Author: Chris Munt cmunt@mgateway.com                                    |
    |                    chris.e.munt@gmail.com                                |
-   | Copyright (c) 2016-2021 M/Gateway Developments Ltd,                      |
+   | Copyright (c) 2019-2023 MGateway Ltd                                     |
    | Surrey UK.                                                               |
    | All rights reserved.                                                     |
    |                                                                          |