node-red-contrib-clickhouse 1.0.4
A clickhouse node for Node-Red
node-red-contrib-clickhouse
A Clickhouse driver node for Node-Red.
)
This package includes two nodes for node-red:
The Config Node
Connect to your local Clickhouse Server or a Cloud versions.
The Flow Node
Execute an query/insert/command within your flow.
_This node was inspired by other projects like node-red-contrib-mongodb4
Installation
Navigate to your .node-red directory - typically ~/.node-red.
npm install --save --omit=dev node-red-contrib-clickhouse
Compatibility
The latest version of [email protected] is tested with the following Clickhouse server versions: 25.3.1
Node-RED >= v3.0.0
NodeJS >= v16.20.1
Usage Example
Import the example flow to get a quick introduction how to use this node.
flow.json 
The Configuration Node
Simple Connection URI
Protocol -
httporhttpsHostname - Hostname / IP to connect to Clickhouse
Port - Optional port number. In most cases
8123.Pathname - Custom path name to add to URI. Details
Advanced Connection URI
- URI - Define your own connection string in URI format.
Authentication (optional)
Username - Username for authentication.
Password - Password for authentication.
Application
Database - A Clickhouse database name is required.
Application Name - The name of the application that created this MongoClient instance. MongoDB 3.4 and newer will print this value in the server log upon establishing each connection. It is also recorded in the slow query log and profile collections.
If this field is unspecified, the client node will create a app name for you.
That looks like this: nodered-azmr5z97. The prefix nodered is static. azmr5z97 is a random connection pool id, created on runtime start-up, config-node update and full deployment.
The current app name of a config node is logged to the node-red runtime log.
Connect Options
MaxPoolsize - Specifies the maximum number of connections the driver should create in its connection pool. This count includes connections in use.
MaxIdleTimeMS - Specifies the amount of time, in milliseconds, a connection can be idle before it's closed. Specifying 0 means no minimum.
Connection Pools
Each configuration node has his own connection pool with a default max poolsize of 100 connection at a given time.
The Flow Node
Execute MongoDB collection operations with this node.
Inputs / Options
Connection (clickhouse-client) - Select a Clickhouse server connection.
Mode | msg.mode (string) - Decide which operation do you want to use {'query', 'command', 'insert'}
Table | msg.table (string) - table name for insert operation.
Output | msg.output (string) - Define output processing for 'query' mode {'toArray', 'forEach'}.
'forEach' produce output for each received record in stream manner and additional msg with an payload equal to null.Format | msg.format (string) - format output. By default assigned 'JSONEachRow' value but you can define your own if needed.
msg.payload (array | JSON ) - Pass message payload as array for 'insert' mode. For 'query' mode it should be JSON object.
Wait for completion - With this feature enabled, the operation node will wait until execution were complete. See wait_end_of_query
Do not throw error (place it into msg) - With this feature enabled, the operation node will return error in msg insted of throwing it
Payload Output
The node will output the database driver response as message payload.
The mode query can output with toArray or forEach.
Node Status
Node status information is displayed below the node:
Tags
- s : Number of successful executions
- err : Number of failed executions
- rt : Last execution runtime in ms
Colors
- green : Last execution was successful
- blue : Node execution in progress
- red : Last execution failed
