node-red-contrib-ibm-db2/98-ibm-db2.html

Node-RED nodes to access Db2 cloud services and Db2 LUW

<!--
  Copyright 2014 IBM Corp.

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
-->

<script type="text/x-red" data-template-name="Db2">
    <div class="form-row">
        <label for="node-config-input-hostname"><i class="fa fa-bookmark"></i> Hostname</label>
        <input class="input-append-left" type="text" id="node-config-input-hostname">
    </div>
    <div class="form-row">
        <label for="node-config-input-db"><i class="fa fa-user"></i> Database</label>
        <input type="text" id="node-config-input-db">
    </div>
    <div class="form-row">
        <label for="node-config-input-username"><i class="fa fa-user"></i> Username</label>
        <input type="text" id="node-config-input-username">
    </div>
    <div class="form-row">
        <label for="node-config-input-password"><i class="fa fa-lock"></i> Password</label>
        <input type="password" id="node-config-input-password">
    </div>
    <div class="form-row">
        <label for="node-config-input-port"><i class="fa fa-lock"></i> Port</label>
        <input type="text" id="node-config-input-port">
    </div>
    <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" placeholder="Name">
    </div>
</script>

<script type="text/javascript">
    RED.nodes.registerType("Db2",{
        category: "config",
        color: "rgb(114, 199, 231)",
        defaults: {
            hostname: {value:"", required:true},
            db: {value:""},
            port: {value:"50000"},
            name: {value:""}
        },
        credentials: {
            username: {type:"text"},
            password: {type:"password"}
        },
        label: function() {
            return this.name || this.host;
        }
    });
</script>

<script type="text/x-red" data-template-name="Db2 out">

    <div class="form-row">
        <label for="node-input-service"><i class="fa fa-folder-close"></i> Service</label>
        <select id="node-input-service" style="width:68%;">
            <!-- <option value="" disabled></option> -->
            <option value="_ext_"> External Db2 instance</option>
        </select>
    </div>

    <div class="form-row hide" id="node-input-external-details">
        <label for="node-input-Db2"><i class="fa fa-bookmark"></i> Server</label>
        <input type="text" id="node-input-Db2">
    </div>

    <div class="form-row">
        <label for="node-input-table"><i class="fa fa-briefcase"></i> Table</label>
        <input type="text" id="node-input-table" placeholder="table">
    </div>

    <div class="form-row">
        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
        <input type="text" id="node-input-name" placeholder="name">
    </div>

</script>

<script type="text/javascript">
    RED.nodes.registerType("Db2 out", {
        category: "storage-output",
        color: "rgb(153, 204, 153)",
        defaults: {
            Db2: { type:"Db2", validate:validateServer },
            service: { value: "", required: true },
            table: { value: "", required: true },
            name: { value: "" }
        },
        inputs: 1,
        outputs: 0,
        icon: "Db2.png",
        align: "right",
        label: label,
        labelStyle: function() {
            return this.name?"node_label_italic":"";
        },
        oneditprepare: oneditprepare
    });

    function oneditprepare() {
        var node = this;

        var serviceSelect  = $('#node-input-service');

        $.getJSON('Db2/vcap/',function(data) {
            var last = serviceSelect.children().last();
            var opts = [];

            for (var i=0; i < data.length; i++) {
                var selected = node.service == data[i].name;
                opts.push(
                    '<option value="' + data[i].name + '"' + (selected ? " selected":"") + '>' +
                        data[i].name +
                    '</option>'
                );
            }

            if (opts.length == 0) {
                node.service = "_ext_";
                serviceSelect.find("option").filter(function() {
                    return $(this).val() == node.service;
                }).attr('selected', true);
            } else {
                last.before(opts.join(""));
            }
            serviceSelect.change();
        });

        serviceSelect.change(function() {
            var service = serviceSelect.val();
            if (service == "_ext_") {
                $("#node-input-external-details").show();
            } else {
                $("#node-input-external-details").hide();
            }
        });


    }

    function label() {
        return this.name || this.table || "Db2";
    }

    function validateServer(v) {
       return this.service != "_ext_" || v != "_ADD_";
    }

</script>

<script type="text/x-red" data-help-name="Db2 out">
   <p>
       A simple Db2 output node. Stores elements from the <b>msg.payload</b>
       into Db2.  The msg.payload should include a value for
       each column in your table.  If you put a 'TIMESTAMP' string as one of the
       values, the node will replace it with the current timestamp in Db2 format.
   </p>
   <p>
       So for example, if you have a table with columns (TS, SCREENNAME, TWEET, SENTIMENT, LOCATION),
       then you might create a function node that flows into your sqldb output node
       with code that maps each of those columns to other values in the msg object, like this:
   </p>
       msg.payload =<br>
       {<br>
&nbsp;&nbsp;&nbsp;TS : 'TIMESTAMP',<br>
&nbsp;&nbsp;&nbsp;SCREENNAME : msg.tweet.user.screen_name,<br>
&nbsp;&nbsp;&nbsp;TWEET : msg.payload,<br>
&nbsp;&nbsp;&nbsp;SENTIMENT : msg.sentiment.score,<br>
&nbsp;&nbsp;&nbsp;LOCATION : msg.location<br>
       }<br>
       return msg;<br><br>
   <p>
       <b>Service</b> should point to your Db2 on Cloud or Db2 Warehouse on Cloud service,
       or choose the <b>External Db2 instance</b> option to point to your own Db2.
   </p>
   <p>
       <b>Table</b> should point to the table you wish to insert the values into.
       This table needs to exist already in the database and needs to contain the
       same columns and datatypes that you are inserting through this node.
       The data needs to be in the format accepted by Db2 and within the appropriate
       ranges/parameters for that datatype.
   </p>
   <p>
      <b>Name:</b> Optionally give your node a name, otherwise the default will be the table name.
   </p>

</script>

<script type="text/x-red" data-template-name="Db2 in">
   <div class="form-row">
       <label for="node-input-service"><i class="fa fa-folder-close"></i> Service</label>
       <select id="node-input-service" style="width:68%;">
           <!-- <option value="" disabled></option> -->
           <option value="_ext_"> External Db2 instance</option>
       </select>
   </div>

   <div class="form-row hide" id="node-input-external-details">
       <label for="node-input-Db2"><i class="fa fa-bookmark"></i> Server</label>
       <input type="text" id="node-input-Db2">
   </div>

    <div class="form-row">
        <label for="node-input-query"><i class="fa fa-briefcase"></i> Query</label>
        <textarea style="width:70%; height:75px" id="node-input-query">Type your SQL query here</textarea>
    </div>

    <div class="form-row">
        <label for="node-input-params"><i class="fa fa-briefcase"></i> Parameter Markers (optional)</label>
        <input type="text" id="node-input-params" placeholder="params">
    </div>

    <div class="form-row">
        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
        <input type="text" id="node-input-name" placeholder="name">
    </div>

</script>

<script type="text/javascript">
    RED.nodes.registerType("Db2 in", {
        category: "storage-input",
        color: "rgb(153, 204, 153)",
        defaults: {
            Db2: { type:"Db2", validate:validateServer },
            service: { value: "", required: true },
            query: { value: "", required: false },
            params: { value: "", required: false },
            name: { value: "" }
        },
        inputs: 1,
        outputs: 1,
        icon: "Db2.png",
        label: label,
        labelStyle: function() {
            return this.name?"node_label_italic":"";
        },
        oneditprepare: oneditprepare
    });

    function oneditprepare() {
        var node = this;

        var serviceSelect  = $('#node-input-service');

        $.getJSON('Db2/vcap/',function(data) {
            var last = serviceSelect.children().last();
            var opts = [];

            for (var i=0; i < data.length; i++) {
                var selected = node.service == data[i].name;
                opts.push(
                    '<option value="' + data[i].name + '"' + (selected ? " selected":"") + '>' +
                        data[i].name +
                    '</option>'
                );
            }

            if (opts.length == 0) {
                node.service = "_ext_";
                serviceSelect.find("option").filter(function() {
                    return $(this).val() == node.service;
                }).attr('selected', true);
            } else {
                last.before(opts.join(""));
            }
            serviceSelect.change();
        });

        serviceSelect.change(function() {
            var service = serviceSelect.val();
            if (service == "_ext_") {
                $("#node-input-external-details").show();
            } else {
                $("#node-input-external-details").hide();
            }
        });

    }


    function label() {
        return this.name || "Db2";
    }

    function validateServer(v) {
       return this.service != "_ext_" || v != "_ADD_";
    }

</script>

<script type="text/x-red" data-help-name="Db2 in">
   <p>
       A simple Db2 node for executing queries. It executes a query on your Db2 database
       and passes along the result set in the <b>msg</b> object, as msg.payload.  If there is an
       error during execution of the query, the msg.payload will be null and the error will be in
       msg.error.
   </p>
   <p>
       <b>Service</b> should point to your Db2 on Cloud or Db2 Warehouse on Cloud service,
       or choose the <b>External Db2 instance</b> option to point to your own Db2.
   </p>
   <p>
       <b>Query</b> is the query you wish to execute on your Db2 database.  If it is empty,
       it will look for the query in the msg.payload.
   </p>
   <p>
       <b>Parameter Markers</b> is a comma delimited set of json paths.  These will replace any question
       marks that you place in your query, in the order that they appear.
   </p>
   <p>
      <b>Name:</b> Optionally give your node a name, otherwise the default will be the table name.
   </p>
</script>