TimescaleDB Insert Documentation
Version:Â 1.1.5Â
Retrieved:Â 2025-10-09 15:16:25
Timescale Insert
The module inserts data into the TimescaleDB database.
This module is designed to be located at the end of a flow.
Settings
| Name | Requirements | Purpose | Default |
|---|---|---|---|
| Table Name | String with length 1-64 | The name of the TimescaleDB table | Â |
| Time Column | String with length 1-64 | The name of the column that contains the timestamp. If a property with this name exists on the incoming message time will be taken from there. If no such property exists the current time will be inserted automatically. | Â |
| Source Name | Not null | The property that contains the values to be inserted. This should be an object with properties matching column names in the database. | Â |
Credential
This module needs a credential of type 'Connection string' to connect to the database server. A minimal connection string is shown below. Depending on the setup of your database server additional parameters may be needed. Please consult the documentation for your server.
Server=192.168.0.5;Database=crosser;User ID=demo;Password=crosser123;
Input
For a single row insert the [Source Property] is expected to contain an object with property names matching all required column names in the database table. For multi-row inserts the [Source Property] is expected to contain an array of single-row objects.
If the [Time Column] property does not exists on the [Source Name] property the current time will be used.
| Name | Type | Description |
|---|---|---|
| [Source Name] | object | An object with properties matching the column names in the database table with the values to be inserted. |
Output
An output message will be sent each time the module receives a message.
| Name | Type | Description |
|---|---|---|
| crosser.success | Boolean | True if the message was stored properly in the database, otherwise False |
| crosser.message | String | Contains a error message in case the insert failed, if the insert is successful this property is not set. |
Example - Single measurement
Below we show an example for a single measurement and the settings that might be used for that input.
# Settings
Table: load
Source Name: data
Time Column:
# Input
"data": {
"region": "europe",
"id": "sensor123",
"temperature": 34.5
}
# Output
{
"data": {
"region": "europe",
"id": "sensor123",
"temperature": 34.5,
},
"crosser": {
"success": true
}
}
Search Documentation
Destinations
Databases