@flowfuse/nr-tables-nodes 0.1.0

package/examples/flow.json

@@ -0,0 +1,291 @@
+[
+	{
+		"id": "36d7a2e7.38e4de",
+		"type": "inject",
+		"z": "6bd3da1a.7e2b84",
+		"name": "Start",
+		"props": [
+			{
+				"p": "payload"
+			},
+			{
+				"p": "topic",
+				"vt": "str"
+			}
+		],
+		"repeat": "",
+		"crontab": "",
+		"once": false,
+		"onceDelay": 0.1,
+		"topic": "",
+		"payloadType": "date",
+		"x": 190,
+		"y": 1620,
+		"wires": [
+			[
+				"1b00f74dc3098005"
+			]
+		]
+	},
+	{
+		"id": "ee38d447.1c13a8",
+		"type": "debug",
+		"z": "6bd3da1a.7e2b84",
+		"name": "Done",
+		"active": true,
+		"tosidebar": true,
+		"console": false,
+		"tostatus": true,
+		"complete": "true",
+		"targetType": "full",
+		"statusVal": "complete",
+		"statusType": "msg",
+		"x": 1210,
+		"y": 1620,
+		"wires": []
+	},
+	{
+		"id": "12f229bfef5ad2a5",
+		"type": "function",
+		"z": "6bd3da1a.7e2b84",
+		"name": "Ready for next lines",
+		"func": "return [\n    msg.complete || msg.abort ? msg : null,\n    { tick: true },\n];\n",
+		"outputs": 2,
+		"noerr": 0,
+		"initialize": "",
+		"finalize": "",
+		"libs": [],
+		"x": 980,
+		"y": 1560,
+		"wires": [
+			[
+				"ee38d447.1c13a8"
+			],
+			[
+				"1b00f74dc3098005"
+			]
+		]
+	},
+	{
+		"id": "178252a8d3c54b16",
+		"type": "function",
+		"z": "6bd3da1a.7e2b84",
+		"name": "",
+		"func": "let payload = `(0, FALSE),`;\nif (msg.payload && msg.payload.length > 0) {\n    for (const line of msg.payload) {\n        const valid = 'TRUE'; // Call some kind of test\n        payload += `(${line['id']}, ${valid}),`;\n    }\n}\nmsg.payload = payload.slice(0, - 1);\nreturn msg;\n",
+		"outputs": 1,
+		"noerr": 0,
+		"initialize": "",
+		"finalize": "",
+		"libs": [],
+		"x": 560,
+		"y": 1620,
+		"wires": [
+			[
+				"6d2073ec4db26f2f"
+			]
+		]
+	},
+	{
+		"id": "4fd30ba36702842a",
+		"type": "debug",
+		"z": "6bd3da1a.7e2b84",
+		"name": "Progress",
+		"active": true,
+		"tosidebar": true,
+		"console": false,
+		"tostatus": true,
+		"complete": "true",
+		"targetType": "full",
+		"statusVal": "parts.index",
+		"statusType": "msg",
+		"x": 940,
+		"y": 1620,
+		"wires": []
+	},
+	{
+		"id": "1b00f74dc3098005",
+		"type": "postgresql",
+		"z": "6bd3da1a.7e2b84",
+		"name": "SELECT many",
+		"query": "SELECT * FROM mytable\nORDER BY id ASC\nLIMIT 2000;\n",
+		"postgreSQLConfig": "20ae1e52d1eef983",
+		"split": true,
+		"rowsPerMsg": "100",
+		"outputs": 1,
+		"x": 380,
+		"y": 1620,
+		"wires": [
+			[
+				"178252a8d3c54b16"
+			]
+		]
+	},
+	{
+		"id": "6d2073ec4db26f2f",
+		"type": "postgresql",
+		"z": "6bd3da1a.7e2b84",
+		"name": "UPDATE many",
+		"query": "UPDATE mytable AS c\nSET validity = v.validity\nFROM (VALUES\n\t{{{ msg.payload }}}\n) AS v (id, validity)\nWHERE v.id = c.id;\n",
+		"postgreSQLConfig": "20ae1e52d1eef983",
+		"split": false,
+		"rowsPerMsg": "1",
+		"outputs": 1,
+		"x": 740,
+		"y": 1620,
+		"wires": [
+			[
+				"12f229bfef5ad2a5",
+				"4fd30ba36702842a"
+			]
+		]
+	},
+	{
+		"id": "64a657de3954a4b5",
+		"type": "debug",
+		"z": "6bd3da1a.7e2b84",
+		"name": "Results",
+		"active": true,
+		"tosidebar": true,
+		"console": false,
+		"tostatus": true,
+		"complete": "true",
+		"targetType": "full",
+		"statusVal": "pgsql.rowCount",
+		"statusType": "msg",
+		"x": 560,
+		"y": 1700,
+		"wires": []
+	},
+	{
+		"id": "adf069475c5e0ba3",
+		"type": "postgresql",
+		"z": "6bd3da1a.7e2b84",
+		"name": "SELECT",
+		"query": "SELECT * FROM mytable\nWHERE id < 100;\n",
+		"postgreSQLConfig": "20ae1e52d1eef983",
+		"split": false,
+		"rowsPerMsg": "1",
+		"outputs": 1,
+		"x": 360,
+		"y": 1700,
+		"wires": [
+			[
+				"64a657de3954a4b5"
+			]
+		]
+	},
+	{
+		"id": "3134bfc0f12e13c3",
+		"type": "inject",
+		"z": "6bd3da1a.7e2b84",
+		"name": "Start",
+		"props": [
+			{
+				"p": "payload"
+			},
+			{
+				"p": "topic",
+				"vt": "str"
+			}
+		],
+		"repeat": "",
+		"crontab": "",
+		"once": false,
+		"onceDelay": 0.1,
+		"topic": "",
+		"payloadType": "date",
+		"x": 190,
+		"y": 1700,
+		"wires": [
+			[
+				"adf069475c5e0ba3"
+			]
+		]
+	},
+	{
+		"id": "d04c65ee97e3a273",
+		"type": "inject",
+		"z": "6bd3da1a.7e2b84",
+		"name": "Prepare",
+		"props": [
+			{
+				"p": "payload"
+			},
+			{
+				"p": "topic",
+				"vt": "str"
+			}
+		],
+		"repeat": "",
+		"crontab": "",
+		"once": false,
+		"onceDelay": 0.1,
+		"topic": "",
+		"payloadType": "date",
+		"x": 180,
+		"y": 1520,
+		"wires": [
+			[
+				"82b7c689d6682f72"
+			]
+		]
+	},
+	{
+		"id": "c5f0b4b2442e3137",
+		"type": "debug",
+		"z": "6bd3da1a.7e2b84",
+		"name": "Done",
+		"active": true,
+		"tosidebar": true,
+		"console": false,
+		"tostatus": true,
+		"complete": "true",
+		"targetType": "full",
+		"statusVal": "pgsql",
+		"statusType": "msg",
+		"x": 550,
+		"y": 1520,
+		"wires": []
+	},
+	{
+		"id": "82b7c689d6682f72",
+		"type": "postgresql",
+		"z": "6bd3da1a.7e2b84",
+		"name": "ADD COLUMN",
+		"query": "ALTER TABLE mytable\n    DROP COLUMN IF EXISTS validity;\n\nALTER TABLE mytable\n    ADD COLUMN validity BOOLEAN;\n",
+		"postgreSQLConfig": "20ae1e52d1eef983",
+		"split": false,
+		"rowsPerMsg": "10",
+		"outputs": 1,
+		"x": 380,
+		"y": 1520,
+		"wires": [
+			[
+				"c5f0b4b2442e3137"
+			]
+		]
+	},
+	{
+		"id": "20ae1e52d1eef983",
+		"type": "postgreSQLConfig",
+		"name": "myuser@timescale:5432/iot",
+		"host": "timescale",
+		"hostFieldType": "str",
+		"port": "5432",
+		"portFieldType": "num",
+		"database": "iot",
+		"databaseFieldType": "str",
+		"ssl": "false",
+		"sslFieldType": "bool",
+		"max": "10",
+		"maxFieldType": "num",
+		"idle": "1000",
+		"idleFieldType": "num",
+		"connectionTimeout": "10000",
+		"connectionTimeoutFieldType": "num",
+		"user": "myuser",
+		"userFieldType": "str",
+		"password": "???",
+		"passwordFieldType": "str"
+	}
+]

package/node-postgres-named.js

@@ -0,0 +1,33 @@
+'use strict';
+
+/**
+ * Rewritten subset of the library https://github.com/bwestergard/node-postgres-named/blob/master/main.js
+ * https://github.com/ksteckert/node-postgres-named/tree/patch-1
+ */
+
+const tokenPattern = /(?<=\$)[a-zA-Z]([a-zA-Z0-9_]*)\b/g;
+
+function numericFromNamed(sql, parameters) {
+	const fillableTokens = new Set(Object.keys(parameters));
+	const matchedTokens = new Set(sql.match(tokenPattern));
+
+	const unmatchedTokens = Array.from(matchedTokens).filter((token) => !fillableTokens.has(token));
+	if (unmatchedTokens.length > 0) {
+		throw new Error('Missing Parameters: ' + unmatchedTokens.join(', '));
+	}
+
+	const fillTokens = Array.from(matchedTokens).filter((token) => fillableTokens.has(token)).sort();
+	const fillValues = fillTokens.map((token) => parameters[token]);
+
+	const interpolatedSql = fillTokens.reduce((partiallyInterpolated, token, index) => {
+		const replaceAllPattern = new RegExp('\\$' + fillTokens[index] + '\\b', 'g');
+		return partiallyInterpolated.replace(replaceAllPattern, '$' + (index + 1)); // PostgreSQL parameters are 1-indexed
+	}, sql);
+
+	return {
+		text: interpolatedSql,
+		values: fillValues,
+	};
+}
+
+module.exports.convert = numericFromNamed;

package/nodes/icons/circle-stack.svg

@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="#fff">
+  <path stroke-linecap="round" stroke-linejoin="round" d="M20.25 6.375c0 2.278-3.694 4.125-8.25 4.125S3.75 8.653 3.75 6.375m16.5 0c0-2.278-3.694-4.125-8.25-4.125S3.75 4.097 3.75 6.375m16.5 0v11.25c0 2.278-3.694 4.125-8.25 4.125s-8.25-1.847-8.25-4.125V6.375m16.5 0v3.75m-16.5-3.75v3.75m16.5 0v3.75C20.25 16.153 16.556 18 12 18s-8.25-1.847-8.25-4.125v-3.75m16.5 0c0 2.278-3.694 4.125-8.25 4.125s-8.25-1.847-8.25-4.125" />
+</svg>

package/nodes/icons/flowfuse.svg

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="90" height="135" version="1.1" viewBox="0 0 90 135" xmlns="http://www.w3.org/2000/svg">
+ <g transform="matrix(1.0078 0 0 1.0078 -67.007 -65.914)">
+  <path d="m77.77 92.7c-3.497 0-6.311 2.816-6.311 6.313-0.0052 11.55-0.01316 23.11-0.01499 34.66 7.5 0.0444 15.01 0.217 22.49-0.3183 10.43-0.9511 19.61-6.552 29.22-10.23 8.742-3.697 18.13-5.941 27.66-5.741l-1e-3 -18.38c4e-3 -3.498-2.815-6.313-6.311-6.313zm73.05 37.19c-1.055 0.0169-2.111 0.0457-3.166 0.0889-11.64-0.0448-21.96 5.974-32.46 10.19 8.115 3.283 15.95 7.454 24.55 9.389 3.675 0.5576 7.372 0.8292 11.08 0.9085zm-71.13 16.57c-2.747 6e-3 -5.494 0.0346-8.239 0.0486 0.0024 6.416 0.0072 12.83 0.01757 19.25 0.0037 3.498 2.815 6.313 6.311 6.313h66.73c3.497 0 6.311-2.816 6.311-6.313v-2.778c-8.203-0.0537-16.4-1.304-24.04-4.374-11.82-4.124-22.85-11.45-35.68-11.94-3.798-0.1794-7.602-0.2147-11.41-0.2062z" fill="#DA3D0B"/>
+ </g>
+</svg>

package/nodes/locales/en-US/query-config.json

@@ -0,0 +1,37 @@
+{
+	"tables-query-config": {
+		"label": {
+			"host": "Host",
+			"port": "Port",
+			"database": "Database",
+			"ssl": "SSL",
+			"user": "User",
+			"password": "Password",
+			"applicationName": "Application name",
+			"max": "Maximum size",
+			"idle": "Idle Timeout",
+			"connectionTimeout": "Connection Timeout"
+		},
+		"tab": {
+			"connection": "Connection",
+			"security": "Security",
+			"pool": "Pool"
+		},
+		"placeholder": {
+			"name": "dbConnection",
+			"host": "127.0.0.1",
+			"port": "5432",
+			"database": "dbExample",
+			"applicationName": "",
+			"max": "10",
+			"idle": "1000 (Milliseconds)",
+			"connectionTimeout": "10000 (Milliseconds)",
+			"user": "dbUser",
+			"password": "dbPassword"
+		},
+		"title": {
+			"applicationName": "The name of the application that created this Client instance.",
+			"max": "Maximum number of physical database connections that this connection pool can contain."
+		}
+	}
+}

package/nodes/locales/en-US/query.html

@@ -0,0 +1,99 @@
+<script type="text/x-red" data-help-name="tables-query">
+	<p>
+		This node allows you to write and run queries against database tables that are managed by FlowFuse Tables.
+	</p>
+
+	<h3>Outputs</h3>
+	<p>The response (rows) is provided in <code>msg.payload</code> as an array.</p>
+	<p>
+		An exception is if the <em>Split results</em> option is enabled and the <em>Number of rows per message</em> is set to 1,
+		then <code>msg.payload</code> is not an array but the single-row response.
+	</p>
+	<p>
+		Additional information is provided as <code>msg.pgsql.rowCount</code> and <code>msg.pgsql.command</code>.
+		See the <a href="https://node-postgres.com/apis/result">underlying documentation</a> for details.
+	</p>
+	<p>In the case of multiple queries, then <code>msg.pgsql</code> is an array.</p>
+
+	<h3>Inputs</h3>
+	<h4>SQL query template</h4>
+	<p>This node uses the <a href="https://github.com/janl/mustache.js">Mustache template system</a> to generate queries based on the message:</p>
+<pre>
+-- INTEGER id column
+SELECT * FROM table WHERE id = {{{ msg.id }}}
+
+-- TEXT id column
+SELECT * FROM table WHERE id = '{{{ msg.id }}}'
+</pre>
+
+	<h4>Dynamic SQL queries</h4>
+	<p>As an alternative to using the query template above, this node also accepts an SQL query via the <code>msg.query</code> parameter.</p>
+
+	<h4>Parameterized queries</h4>
+	<p>Parameters for parameterized queries can be passed as an array <code>msg.params</code>:</p>
+<pre>
+// In a function, provide parameters for the parameterized query
+msg.params = [ msg.id ];
+</pre>
+
+<pre>
+-- In this node, use a parameterized query
+SELECT * FROM table WHERE id = $1
+</pre>
+
+<h4>Parameterized queries</h4>
+<p>
+	As an alternative to numeric parameters,
+	named parameters for parameterized queries can be passed as a parameter object <code>msg.queryParameters</code>:
+</p>
+<pre>
+// In a function, provide parameters for the named parameterized query
+msg.queryParameters.id = msg.id;
+</pre>
+
+<pre>
+-- In this node, use a named parameterized query
+SELECT * FROM table WHERE id = $id;
+</pre>
+
+<p>
+	<em>Note</em>: named parameters are not natively supported by PostgreSQL, and this library just emulates them,
+	so this is less robust than numeric parameters.
+</p>
+
+	<h3>Backpressure</h3>
+	<p>
+		This node supports <em>backpressure</em> / <em>flow control</em>:
+		when the <em>Split results</em> option is enabled, it waits for a <em>tick</em> before releasing the next batch of lines,
+		to make sure the rest of your Node-RED flow is ready to process more data
+		(instead of risking an out-of-memory condition), and also conveys this information upstream.
+	</p><p>
+		So when the <em>Split results</em> option is enabled, this node will only output one message at first,
+		and then awaits a message containing a truthy <code>msg.tick</code> before releasing the next message.
+	</p><p>
+		To make this behaviour potentially automatic (avoiding manual wires),
+		this node declares its ability by exposing a truthy <code>node.tickConsumer</code> for downstream nodes to detect this feature,
+		and a truthy <code>node.tickProvider</code> for upstream nodes.
+		Likewise, this node detects upstream nodes using the same back-pressure convention, and automatically sends ticks.
+	</p>
+
+	<h3>Sequences for split results</h3>
+	<p>
+		When the <em>Split results</em> option is enabled (streaming), the messages contain some information following the conventions
+		for <a href="https://nodered.org/docs/user-guide/messages#message-sequences"><em>messages sequences</em></a>.
+	</p>
+
+<pre>
+{
+  payload: '...',
+    parts: {
+      id: 0.1234, // sequence ID, randomly generated (changes for every sequence)
+      index: 5, // incremented for each message of the same sequence
+      count: 6, // total number of messages; only available in the last message of a sequence
+      parts: {}, // optional upstream parts information
+    },
+    complete: true, // True only for the last message of a sequence
+}
+</pre>
+
+</script>

package/nodes/locales/en-US/query.json

@@ -0,0 +1,10 @@
+{
+	"tables-query": {
+		"label": {
+			"name": "Name",
+			"query": "Query",
+			"split": "Split results in multiple messages",
+			"rowsPerMsg": "Rows per message"
+		}
+	}
+}

package/nodes/query.html

@@ -0,0 +1,91 @@
+<script type="text/javascript">
+	/* global RED:false, $:false */
+	RED.nodes.registerType('tables-query', {
+		category: 'FlowFuse',
+		color: 'white',
+		defaults: {
+			name: {
+				value: '',
+			},
+			query: {
+				value: 'SELECT * FROM table_name;',
+			},
+			split: {
+				value: false,
+			},
+			rowsPerMsg: {
+				value: 1,
+			}
+		},
+		inputs: 1,
+		outputs: 1,
+		icon: 'flowfuse.svg',
+		align: 'left',
+		paletteLabel: 'query',
+		label: function () {
+			return this.name || 'query';
+		},
+		labelStyle: function () {
+			const classes = 'nr-tables-query-node';
+			return this.name ? `${classes} node_label_italic` : classes;
+		},
+		oneditprepare: function () {
+			$('#node-input-split').prop('checked', this.split);
+
+			// when node-input-split is modified, react:
+			$('#node-input-split').on('change', function () {
+				// if checked, show the rowsPerMsg input
+				if ($('#node-input-split').is(':checked')) {
+					$('#node-input-rowsPerMsg-container').show();
+				} else {
+					$('#node-input-rowsPerMsg-container').hide();
+				}
+			});
+
+			$('#node-input-rowsPerMsg').value = this.split ? this.rowsPerMsg : 1;
+			this.editor = RED.editor.createEditor({
+				id: 'node-input-editor',
+				mode: 'ace/mode/sql',
+				value: $('#node-input-query').val(),
+			});
+			this.editor.focus();
+		},
+		oneditsave: function () {
+			$('#node-input-query').val(this.editor.getValue());
+			delete this.editor;
+		},
+	});
+</script>
+
+<script type="text/x-red" data-template-name="tables-query">
+	<div class="form-row">
+		<label for="node-input-name">
+			<i class="icon-tag"></i>
+			<span data-i18n="tables-query.label.name"></span>
+		</label>
+		<input type="text" id="node-input-name" data-i18n="[placeholder]node-red:common.label.name" />
+	</div>
+	<div class="form-row" style="position: relative; margin-bottom: 0px;">
+		<label for="node-input-query">
+			<i class="fa fa-file-code-o"></i>
+			<span data-i18n="tables-query.label.query"></span>
+		</label>
+		<input type="hidden" id="node-input-query" autofocus="autofocus" />
+	</div>
+	<div class="form-row node-text-editor-row">
+		<div style="height: 300px; min-height: 150px;" class="node-text-editor" id="node-input-editor"></div>
+	</div>
+    <h4 style="margin-bottom: 0.5rem;">Output</h4>
+	<div class="form-row">
+		<input type="checkbox" id="node-input-split" style="display: inline-block; width: auto; vertical-align: top;" />
+		<label for="node-input-split" style="width: auto;">
+			<span data-i18n="tables-query.label.split"></span>
+		</label>
+	</div>
+	<div class="form-row" id="node-input-rowsPerMsg-container">
+		<label for="node-input-rowsPerMsg">
+			<span data-i18n="tables-query.label.rowsPerMsg"></span>
+		</label>
+		<input type="number" id="node-input-rowsPerMsg" placeholder="1" value="1" min="1" />
+	</div>
+</script>