@bkmj/node-red-contrib-odbcmj 1.2.4

package/README.md

@@ -0,0 +1,134 @@
+# node-red-contrib-odbcmj
+
+A Node Red implementation of odbc.js (https://www.npmjs.com/package/odbc).  This Node allows to make queries to a database through an ODBC connection.  Additionally, parameters can be passed to the SQL query using Mustache syntax or prepared statements.
+
+---
+## Acknowledgement
+
+This node is an unofficial fork of node-red-contrib-odbc from Mark Irish (https://github.com/markdirish/node-red-contrib-odbc) and vastly inspires from it.  It also takes ideas from node-red-contrib-odbc2 from AIS Automation (https://github.com/AISAutomation/node-red-contrib-odbc2).  Overall changes:
+
+  - Can use mustache as well as a parameter array.
+  - Warnings when mustache will render an undefined variable.
+  - Fixes the output field option so that nested object can be used.
+  - Fixes the checkbox for the pool shrink option.
+  - Uses ace/mode/sql for the SQL input field.
+  - Connection nodes can have individually defined names
+  - Selectable SQL syntax checker 
+
+
+## Installation
+
+This package is not available from within the Node Red palette tool.  Instead, in your Node-RED user directory (usually ~/.node-red/), download through the `npm` utility:
+    ```
+    npm install node-red-contrib-odbcmj
+    ```
+
+For the `odbc` connector requirements, please see [the documentation for that package](https://www.npmjs.com/package/odbc#requirements).
+
+
+## Usage
+
+`node-red-contrib-odbcmj` provides two nodes:
+
+* **`odbc config`**: A configuration node for defining your connection string and managing your connection parameters
+
+* **`odbc`**: A node for running queries with or without parameters passed using Mustache syntax or using a parameter array.
+
+
+### `odbc config`
+
+A configuration node that manages connections in an `odbc.pool` object. [Can take any configuration property recognized by `odbc.pool()`](https://www.npmjs.com/package/odbc#constructor-odbcpoolconnectionstring). The connection pool will initialize the first time an `odbc` node receives an input message.
+
+#### Properties
+
+* (**required**) **`connectionString`**: <`string`>
+
+  An ODBC connection string that defines your DSN and/or connection string options.  Check your ODBC driver documentation for more information about valid connection strings.
+
+  Example:
+  ```
+  DSN=MyDSN;DFT=2;
+  ```
+* (optional) **`initialSize`**: <`number`>
+
+  The number of connections created in the Pool when it is initialized.  Default: 5.
+
+* (optional) **`incrementSize`**: <`number`>
+
+  The number of connections that are created when the pool is exhausted. Default: 5.
+
+* (optional) **`maxSize`**: <`number`>
+
+  The maximum number of connections allowed in the pool before it won't create any more. Default: 15.
+
+* (optional) **`shrinkPool`**: <`boolean`>
+
+  Whether the number of connections should be reduced to `initialSize` when they are returned to the pool. Default: true.
+
+* (optional) **`connectionTimeout`**: <`number`>
+
+  The number of seconds for a connection to remain idle before closing.  Default: 3.
+
+* (optional) **`loginTimeout`**: <`number`>
+
+  The number of seconds for an attempt to create a connection before returning to the application. Default: 3.
+
+* (optional) **`syntaxChecker`**: <`boolean`>
+
+  Whether the syntax validator is activeted or not. If activated, the query string will be [parsed](https://www.npmjs.com/package/node-sql-parser#create-ast-for-sql-statement) and appended as an object to the output message with a key named `parsedSql`.  Default: false.
+
+* (optional) **`syntax`**: <`string`>
+
+  Dropdown list of the available [SQL flavors available](https://www.npmjs.com/package/node-sql-parser#supported-database-sql-syntax). Default: mysql.
+
+### `odbc`
+
+A node that runs a query when input is received. Each instance of the node can define its own query string, as well as take a query and/or parameters as input. A query sent as an input message will override any query defined in the node properties.
+
+#### Properties
+
+* (**required**) **`connection`**: <`odbc config`>
+
+  The ODBC pool node that defines the connection settings and manages the connection pool used by this node.
+
+* (optional) **`query`**: <`string`>
+
+  A valid SQL query string that can optionally contains parameters inserted using the Mustache syntax.  For exemple, msg.payload can be inserted anywhere in the string using triple curly brackets: `{{{payload}}}`.  The node will accept a query that is passed either as msg.query, msg.payload.query or msg.payload if payload is a stringified JSON containing a query key/value pair.  A query string passed from the input will override any query defined in the node properties.  Mustache syntax cannot be used with a query string passed from the input.
+
+  Alternatively, the query string can be constructed as a prepared statement; that is with variables replaced by question marks: `SELECT * FROM test WHERE id = ?`.  The variables must then be passed to the input using `msg.parameters`.  This object must be an array containing the same number of element that there are `?` in the query string.  The parameters are inserted one by one, from left to right.
+
+* (**required**) **`result to`**: <`dot-notation string`>
+
+  The JSON nested element structure that will contain the result output.  The string must be a valid JSON object structure using dot-notation, minus the `msg.` (ex: `payload.results`) and must not start or end with a period.  Square braquet notation is not allowed.  The node input object is carried out to the output, as long as the output object name does not conflict it.  If the targeted output JSON object was already present in the input, the result from the query will be appended to it if it was itself an object (but not an array), otherwise the original key/value pair will be overwritten.
+
+  Example:
+
+    - `input msg:   {"payload": {"result": {"othervalue": 10} } };`
+
+    - `result to:  payload.results.values`
+
+    In this case, `values` will be appended to `result` wihout overwriting `othervalue`.  If `result` had been a string, then it would have replaced by `values`.
+
+#### Inputs
+
+The `odbc` node accepts a message input that is either:
+
+  - a `payload` that contains a valid JSON string which itself contains a nested `query` key/value pair where the value is the SQL string. Ex: `msg.payload = "{'query':'<sql string>'}"`
+  - a `payload` object with a nested `query` key/value pair where the value is the SQL string. Ex: `msg.payload.query = '<sql string>'`
+  - a `query` key/value pair where the value is the SQL string. Ex: `msg.query = '<sql string>'`
+
+* (optional) **`parameters`** <`array`>:
+
+An array containing the same number of element that there are `?` in the query string.  The array is optionnal only if there are no variables markers in the query string.
+
+#### Outputs
+
+Returns a message containing an `output object` matching the `result to` dot-notation string as described above.
+
+* **`output object`**: <`array`>
+
+  The [`odbc` result array](https://www.npmjs.com/package/odbc#result-array) returned from the query.
+
+* **`odbc`**: <`object`>
+
+  Contains any key/value pairs that were in the original output and were the key was not an integer.  The module odbc.js returns a [few useful parameters](https://www.npmjs.com/package/odbc#result-array) but these parameters are not part of the output array and are thus segregated into `msg.odbc`.  This is to avoid potential issues if looping through the output array using `Object.entries`.

package/odbc.html

@@ -0,0 +1,249 @@
+<script type="text/javascript">
+  RED.nodes.registerType('odbc config',{
+    category: 'config',
+    defaults: {
+      connectionString: {value:"", required:true},
+      name: {value:""},
+      initialSize: {value:5},
+      incrementSize: {value:5},
+      maxSize: {value:15},
+      shrink:{value:true},
+      syntaxtick:{value:false},
+      syntax: {value:"mysql"},
+      connectionTimeout:{value:3},
+      loginTimeout:{value:3}
+    },
+    label: function() {
+      return this.name || 'odbc config';
+    },
+    oneditprepare: function() {
+      $(".input-syntax").hide();
+      $("#node-config-input-syntaxtick").change(function() {
+        if (this.checked){
+          $(".input-syntax").show();
+        } else {
+          $(".input-syntax").hide();
+        }
+      });
+    }
+  });
+</script>
+
+<script type="text/html" data-template-name="odbc config">
+
+  <div class="form-row">
+    <label for="node-config-input-name"><i class="fa fa-tag"></i> Name</label>
+    <input type="text" id="node-config-input-name">
+  </div>
+
+  <div class="form-row">
+    <label for="node-config-input-connectionString"><i class="icon-bookmark"></i>Connection String</label>
+    <input type="text" id="node-config-input-connectionString" placeholder="DSN=...;">
+  </div>
+
+  <div class="form-row">
+    <label for="node-config-input-initialSize"><i class="icon-bookmark"></i>Initial Size</label>
+    <input type="number" id="node-config-input-initialSize" placeholder="5">
+  </div>
+
+  <div class="form-row">
+    <label for="node-config-input-incrementSize"><i class="icon-bookmark"></i>Increment Size</label>
+    <input type="number" id="node-config-input-incrementSize" placeholder="5">
+  </div>
+
+  <div class="form-row">
+    <label for="node-config-input-maxSize"><i class="icon-bookmark"></i>Max Size</label>
+    <input type="number" id="node-config-input-maxSize" placeholder="15">
+  </div>
+
+  <div class="form-row">
+    <label for="node-config-input-shrink"><i class="icon-bookmark"></i>Shrink Pool</label>
+    <input type="checkbox" id="node-config-input-shrink" style="margin-left:0px; vertical-align:top; width:auto !important;">
+  </div>
+
+  <div class="form-row">
+    <label for="node-config-input-connectionTimeout"><i class="icon-bookmark"></i>Connection Timeout (sec)</label>
+    <input type="number" id="node-config-input-connectionTimeout" placeholder="3">
+  </div>
+
+  <div class="form-row">
+    <label for="node-config-input-loginTimeout"><i class="icon-bookmark"></i>Login Timeout (sec)</label>
+    <input type="number" id="node-config-input-loginTimeout" placeholder="3">
+  </div>
+
+  <div class="form-row">
+    <label for="node-config-input-syntaxtick" style="width: auto;"><i class="icon-bookmark"></i>Syntax Checker</label>
+    <input type="checkbox" id="node-config-input-syntaxtick" style="display: inline-block; width: auto; vertical-align: top;">
+  </div>
+
+  <div class="form-row input-syntax">
+    <label for=""><i class="icon-bookmark"></i> Syntax</label>
+    <select id="node-config-input-syntax" style="width: 70%">
+        <option value="bigquery">BigQuery</option>
+        <option value="db2">DB2</option>
+        <option value="hive">Hive</option>
+        <option value="mariadb">MariaDB</option>
+        <option value="mysql">Mysql</option>
+        <option value="postgresql">PostgresQL</option>
+        <option value="sqlite">Sqlite</option>
+        <option value="transactsql">TransactSQL</option>
+        <option value="flinksql">FlinkSQL</option>
+    </select>
+  </div>
+</script>
+
+<script type="text/javascript">
+  RED.nodes.registerType('odbc',{
+  category: 'storage',
+  color: '#89A5C0',
+  defaults: {
+      name: {value:""},
+      connection: {type:"odbc config", required:true},
+      query: {value: ""},
+      parameters: {value: ""},
+      outputObj: {value:"payload"}
+  },
+  inputs:1,
+  outputs:1,
+  icon: "db.svg",
+  label: function() {
+      return this.name||"odbc";
+  },
+  oneditprepare: function() {
+    this.editor = RED.editor.createEditor({
+      id: 'node-input-query-editor',
+      mode: 'ace/mode/sql',
+      value: this.query
+    });
+  },
+  oneditsave: function() {
+    this.query = this.editor.getValue();
+    this.editor.destroy();
+    delete this.editor;
+  },
+  oneditcancel: function() {
+    this.editor.destroy();
+    delete this.editor;
+  }
+});
+</script>
+
+<script type="text/html" data-template-name="odbc">
+
+  <div class="form-row">
+    <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+    <input type="text" id="node-input-name">
+  </div>
+
+  <div class="form-row">
+      <label for="node-input-connection"><i class="fa fa-cog"></i> Connection</label>
+      <input type="text" id="node-input-connection">
+  </div>
+
+  <div class="form-row node-text-editor-row">
+    <label for="node-input-query" style="width: 100% !important;"><i class="fa fa-search"></i> Query</label>
+    <div style="height: 250px;" class="node-text-editor" id="node-input-query-editor" ></div>
+  </div>
+  <div class="form-row">
+      <label for="node-input-outputObj"><i class="fa fa-edit"></i> Result to</label>
+      <span>msg.</span><input type="text" id="node-input-outputObj" placeholder="payload" style="width: 64%;">
+  </div>
+</script>
+
+<script type="text/markdown" data-help-name="odbc config">
+  A configuration node that manages connections in an `odbc.pool` object. [Can take any configuration property recognized by `odbc.pool()`](https://www.npmjs.com/package/odbc/v/2.4.8#constructor-odbcconnectconnectionstring). The connection pool will initialize the first time an `odbc` node receives an input message.
+
+  ## Properties
+  
+  * (**required**) **`connectionString`**: <`string`>
+  
+    An ODBC connection string that defines your DSN and/or connection string options.  Check your ODBC driver documentation for more information about valid connection strings.
+  
+    Example:
+    ```
+    DSN=MyDSN;DFT=2;
+    ```
+  * (optional) **`initialSize`**: <`number`>
+  
+    The number of connections created in the Pool when it is initialized.  Default: 5.
+  
+  * (optional) **`incrementSize`**: <`number`>
+  
+    The number of connections that are created when the pool is exhausted. Default: 5.
+  
+  * (optional) **`maxSize`**: <`number`>
+  
+    The maximum number of connections allowed in the pool before it won't create any more. Default: 15.
+  
+  * (optional) **`shrinkPool`**: <`boolean`>
+  
+    Whether the number of connections should be reduced to `initialSize` when they are returned to the pool. Default: true.
+  
+  * (optional) **`connectionTimeout`**: <`number`>
+  
+    The number of seconds for a connection to remain idle before closing.  Default: 3.
+  
+  * (optional) **`loginTimeout`**: <`number`>
+  
+    The number of seconds for an attempt to create a connection before returning to the application. Default: 3.
+  
+  * (optional) **`syntaxChecker`**: <`boolean`>
+  
+    Whether the syntax validator is activeted or not. If activated, the query string will be [parsed](https://www.npmjs.com/package/node-sql-parser#create-ast-for-sql-statement) and appended as an object to the output message with a key named `parsedQuery`.  Default: false.
+  
+  * (optional) **`syntax`**: <`string`>
+  
+    Dropdown list of the available [SQL flavors available](https://www.npmjs.com/package/node-sql-parser#supported-database-sql-syntax). Default: mysql.
+</script>
+
+<script type="text/markdown" data-help-name="odbc">
+  A node that runs a query when input is received. Each instance of the node can define its own query string, as well as take a query and/or parameters as input. A query sent as an input message will override any query defined in the node properties.
+
+## Properties
+
+* (**required**) **`connection`**: <`odbc config`>
+
+  The ODBC pool node that defines the connection settings and manages the connection pool used by this node.
+
+* (optional) **`query`**: <`string`>
+
+  A valid SQL query string that can optionally contains parameters inserted using the Mustache syntax.  For exemple, msg.payload can be inserted anywhere in the string using triple curly brackets: `{{{payload}}}`.  The node will accept a query that is passed either as msg.query, msg.payload.query or msg.payload if payload is a stringified JSON containing a query key/value pair.  A query string passed from the input will override any query defined in the node properties.  Mustache syntax cannot be used with a query string passed from the input.
+
+  Alternatively, the query string can be constructed as a prepared statement; that is with variables replaced by question marks: `SELECT * FROM test WHERE id = ?`.  The variables must then be passed to the input using `msg.parameters`.  This object must be an array containing the same number of element that there are `?` in the query string.  The parameters are inserted one by one, from left to right.
+
+* (**required**) **`result to`**: <`dot-notation string`>
+
+  The JSON nested element structure that will contain the result output.  The string must be a valid JSON object structure using dot-notation, minus the `msg.` (ex: `payload.results`) and must not start or end with a period.  Square braquet notation is not allowed.  The node input object is carried out to the output, as long as the output object name does not conflict it.  If the targeted output JSON object was already present in the input, the result from the query will be appended to it if it was itself an object (but not an array), otherwise the original key/value pair will be overwritten.
+
+  Example:
+
+    - `input msg:   {"payload": {"result": {"othervalue": 10} } };`
+
+    - `result to:  payload.results.values`
+
+    In this case, `values` will be appended to `result` wihout overwriting `othervalue`.  If `result` had been a string, then it would have replaced by `values`.
+
+## Inputs
+
+The `odbc` node accepts a message input that is either:
+
+- a `payload` that contains a valid JSON string which itself contains a nested `query` key/value pair where the value is the SQL string. Ex: `msg.payload = "{'query':'<sql string>'}"`
+- a `payload` object with a nested `query` key/value pair where the value is the SQL string. Ex: `msg.payload.query = '<sql string>'`
+- a `query` key/value pair where the value is the SQL string. Ex: `msg.query = '<sql string>'`
+
+* (optional) **`parameters`** <`array`>:
+
+An array containing the same number of element that there are `?` in the query string.  The array is optionnal only if there are no variables markers in the query string.
+
+## Outputs
+
+Returns a message containing an `output object` matching the `result to` dot-notation string as described above.
+
+* **`output object`**: <`array`>
+
+  The [`odbc` result array](https://www.npmjs.com/package/odbc#result-array) returned from the query.
+
+* **`odbc`**: <`object`>
+
+  Contains any key/value pairs that were in the original output and were the key was not an integer.  The module odbc.js returns a [few useful parameters](https://www.npmjs.com/package/odbc#result-array) but these parameters are not part of the output array and are thus segregated into `msg.odbc`.  This is to avoid potential issues if looping through the output array using `Object.entries`.
+</script>

package/odbc.js

@@ -0,0 +1,223 @@
+module.exports = function(RED) {
+  const odbcModule = require('odbc');
+  const mustache = require('mustache');
+  const objPath = require('object-path');
+  //----poolConfig is the function associated to the odbc config node.
+  function poolConfig(config){
+    RED.nodes.createNode(this, config);
+    this.config = config;
+    this.pool = null;
+    this.connecting = false;
+    const thick = this.config.syntaxtick;
+    const syntax = this.config.syntax;
+    delete this.config.syntaxtick;
+    delete this.config.syntax;
+    //----Check if the user ticked the syntax checker and if so we create a parser object based on the specified syntax.
+    this.parser = ((thick) => {
+      if(thick){
+        const { Parser } = require('node-sql-parser/build/' + syntax);
+        return new Parser();
+      } else {return null}
+    })(thick)    
+    //----Converting numeric configuration parameters to integers instead of strings. 
+    for (let [key,value] of Object.entries(this.config)){
+      if (!isNaN(parseInt(value))) this.config[key] = parseInt(value);
+    }
+    this.connect = async () => {      
+      if (this.pool == null) { //----Request connection pool.
+        this.pool = await odbcModule.pool(this.config);
+        this.connecting = false;        
+      }
+      let connection = await this.pool.connect();
+      return connection;
+    };
+    this.on('close', async (removed, done) => {
+      if (removed && this?.pool) { await this.pool.close() }  
+      done();      
+    })
+  }
+  //----Registering the odbc config node to the poolConfig function.
+  RED.nodes.registerType('odbc config', poolConfig);
+
+  //----odbc is the function associated to the odbc node.
+  function odbc(config){
+    RED.nodes.createNode(this, config);    
+    this.config = config;
+    //----Retrieving the specific configuration node.    
+    
+    this.poolNode = RED.nodes.getNode(this.config.connection);
+    this.name = this.config.name;
+
+    //The runQuery function handles the actual query to the database using odbc.js.
+    this.runQuery = async function(msg, send, done) {
+      try {
+        this.status({fill:"blue",shape:"dot",text:"querying..."});
+        //---If the output object was passed in the msg, it overwrites to output in the config.
+        this.config.outputObj = msg?.output || this.config?.outputObj;
+        //---Re-fetching queryString here since it can change because of Mustache even if the node itself doesn't change.
+        this.queryString = this.config.query;
+        if(this.queryString.length){
+          //---Testing if all mustache tags were provided.
+          for(var parsed of mustache.parse(this.queryString)){
+              if(parsed[0] == "name" || parsed[0] == "&"){
+                  if(!objPath.has(msg, parsed[1])){
+                      this.warn(`mustache parameter "${parsed[1]}" is absent and will render to undefined`);
+                  }
+              }
+          }
+          //---Replace the mustaches tags with the appropriate values from the input msg.
+          this.queryString = mustache.render(this.queryString, msg);    
+        }    
+        //----Case were the query is in the message, not in the payload.
+        if (msg?.query) this.queryString = msg.query || this.queryString
+        //---Handles the case were the received message is a stringified JSON containing a valid query.
+        else if (msg?.payload) {
+          if (typeof msg.payload == 'string'){
+            let payloadJson = null;
+            try { payloadJson = JSON.parse(msg.payload) }
+            catch (err) {}//---Do nothing, if the payload was not a JSON it will be handled below.
+            //----If the payload, which is now equivalent to a non-stringified incoming message, contains a query string.
+            if(typeof payloadJson == 'object'){
+              if(payloadJson?.query){
+                if(typeof payloadJson.query != 'string'){
+                  this.status({fill: "red", shape: "ring",text: "Invalid query"});
+                  throw new Error("object msg.payload.query must be a string");
+                } else {
+                  //---A query string coming from an input message as priority over the query defined in Node.
+                  this.queryString = payloadJson.query || this.queryString;
+                }
+              }
+            }
+          } else {
+            if (msg?.payload?.query){
+              if(typeof msg.payload.query != 'string'){
+                this.status({fill: "red", shape: "ring",text: "Invalid query"});
+                throw new Error("object msg.payload.query must be a string");
+              } else { this.queryString = msg.payload.query || this.queryString }        
+            }
+          }
+        }
+        //----Case were the query is in the payload, not in the messsage.
+        
+        //----Case were there was no query pased to the node.
+        if(!this.queryString){
+          this.status({fill: "red", shape: "ring",text: "Invalid query"});
+          throw new Error("no query to execute");          
+        }
+        if(this.queryString.includes('\?') && !msg?.parameters){
+          this.status({fill: "red", shape: "ring",text: "Invalid statement"});
+          throw new Error("the query string includes ? markers but no msg.params was provided");          
+        }
+        else if(this.queryString.includes('\?') && !Array.isArray(msg.parameters)){
+          this.status({fill: "red", shape: "ring",text: "Invalid statement"});
+          throw new Error("the query string includes question marks but msg.params is not an array");          
+        }
+        if(this.queryString.includes('\?')){
+          if((this.queryString.match(/\?/g) || []).length != msg.parameters.length){
+            this.status({fill: "red", shape: "ring",text: "Invalid statement"});
+            throw new Error("the number of parameters provided doesn't match the number of ? markers");          
+          }
+        }
+        //----Check if the query string is a syntaxically valid SQL query
+        if(this.poolNode?.parser){
+          let clone = structuredClone(this.queryString);
+          try { this.parseSql = this.poolNode.parser.astify(clone) }
+          catch (error) {   
+            this.status({fill: "red", shape: "ring",text: "Invalid query"});       
+            throw new Error("the query failed the sql syntax check");
+          }
+        }
+        //---If no output object was specified.
+        if (!this.config.outputObj){
+          this.status({fill: "red", shape: "ring",text: "Invalid output field"});
+          throw new Error("invalid output object definition");
+        }
+        //----If the output string contains illegal punctuation.
+        const reg = new RegExp('^((?![,;:`\[\]{}+=()!"$%?&*|<>\/^¨`\s]).)*$')
+        if (!this.config.outputObj.match(reg)){ 
+          this.status({fill: "red", shape: "ring",text: "Invalid output field"});
+          throw new Error("invalid output field");        
+        }
+        //----If ouput string starts or ends with a period (usually because the user left one there inadvertently)
+        if (this.config.outputObj.charAt(0) == "." || this.config.outputObj.charAt(this.config.outputObj.length-1) == "."){ 
+          this.status({fill: "red", shape: "ring",text: "Invalid output field"});
+          throw new Error("invalid output field");
+        }
+        //---Retrieving one connection from the pool.
+        this.connection = null;
+        try { this.connection = await this.poolNode.connect() }
+        catch (error) {
+          this.status({fill: "red", shape: "ring",text: "connection error"});
+          throw new Error(error);
+        }
+        if(!this.connection){
+          this.status({fill: "red", shape: "ring",text: "no connection"});
+          throw new Error("no connection");
+        }
+        //----Actual attempt to send the query to the ODBC driver.
+        try { 
+          const result = await this.connection.query(this.queryString, msg?.parameters);
+          if(result){
+            //----Sending the results to the defined dot notation object.
+            let otherParams = {};
+            for(const [key, value] of Object.entries(result)){
+              if(isNaN(parseInt(key))){
+                 otherParams[key] = value;
+                 delete result[key];
+              }
+            }
+            objPath.set(msg,this.config.outputObj,result);
+            if(this?.parseSql) msg.parsedQuery = this.parseSql;
+            if(Object.keys(otherParams).length) msg.odbc = otherParams;
+            this.status({fill:'blue',shape:'dot',text:'finish'});
+            send(msg); 
+          } else {
+            this.status({fill: "red", shape: "ring",text: "query error"});
+            throw new Error("the query returns a falsy");
+          }
+        } catch (error) {
+          this.status({fill: "red", shape: "ring",text: "query error"});
+          throw new Error(error);
+        }
+        finally {
+          //----Close the connection.
+          await this.connection.close();
+        }
+        if (done) done();
+      } catch (err) {
+        if (done) {done(err)} else {this.error(err, msg)}
+      }
+      
+    };
+    //----This function runs following an input message.
+    this.checkPool = async function(msg, send, done) {
+      //----Loops while other nodes are awaiting connections.  See poolConfig.
+      try {
+        if (this.poolNode.connecting) {
+          this.warn("received msg while requesting pool");
+          this.status({fill: "yellow", shape: "ring",text: "requesting pool"});
+          setTimeout(() => {
+            this.checkPool(msg, send, done);
+          }, 1000);
+          return;
+        }
+        //----On initialization, the pool will be null. Set connecting to true so that other nodes are immediately blocked, then call runQuery (which will actually do the pool initialization)
+        if (this.poolNode.pool == null) this.poolNode.connecting = true;
+        //----If a connection is available, run the runQuery function.
+        await this.runQuery(msg, send, done);
+      } catch (err) {
+        this.status({fill: "red",shape: "dot", text: "operation failed"});
+        if (done) {done(err)} else {this.error(err, msg)}
+      }
+
+    };
+    this.on('input', this.checkPool);
+    this.on('close', async (done) => {
+      if(this?.connection) await this.connection.close();
+      done();      
+    })
+    this.status({fill:'green',shape:'dot',text:'ready'});
+  }
+    //----Registering the odbc node to the odbc function.
+  RED.nodes.registerType("odbc", odbc);
+};

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@bkmj/node-red-contrib-odbcmj",
+  "version": "1.2.4",
+  "description": "Node Red implementation of odbc.js",
+  "keywords": [
+    "node-red",
+    "odbc",
+    "SQL",
+    "query"
+  ],
+  "dependencies": {
+    "mustache": "^4.2.0",
+    "node-sql-parser": "^4.17.0",
+    "object-path": "^0.11.8",
+    "odbc": "^2.4.8"
+  },
+  "node-red": {
+    "nodes": {
+      "odbc": "odbc.js"
+    }
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "license": "Apache 2",
+  "author": "Marc-André Morneau <ma.morneau.1@gmail.com>",
+  "main": "odbc.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mamorneau/node-red-contrib-odbcmj.git"
+  },
+  "bugs": {
+    "url": "https://github.com/mamorneau/node-red-contrib-odbcmj/issues"
+  },
+  "homepage": "https://github.com/mamorneau/node-red-contrib-odbcmj#readme"
+}