InfluxDB
ToolJet can connect to InfluxDB databases to read and write data. Use the Token authentication scheme to authenticate to the InfluxDB API. For more info visit InfluxDB docs.
Connection
ToolJet connects to InfluxDB using :
- API Token
- Host
- Port
- Protocol (HTTP/HTTPS)
For generating API Token visit InfluxDB docs.
![influx auth](/img/datasource-reference/influxdb/influxauth-v3.png)
Supported Queries
- Write data
- Query data
- Generate an Abstract Syntax Tree (AST) from a query
- Retrieve query suggestions
- Retrieve query suggestions for a branching suggestion
- Analyze a Flux query
- List buckets
- Create a bucket
- Retrieve a bucket
- Update a bucket
- Delete a bucket
![influx operations](/img/datasource-reference/influxdb/operations-v3.png)
Write Data
This operation writes data to a bucket.
Required Parameters:
- Bucket
- Organization name or ID
- Data
Optional Parameters:
- Precision
![influx operations](/img/datasource-reference/influxdb/write.png)
Query Data
Retrieves data from InfluxDB buckets.
Required Parameters:
- Organization name or ID
- Flux query
![influx operations](/img/datasource-reference/influxdb/query.png)
Example
from(bucket: "sensor_data")
|> range(start: -1h)
|> filter(fn: (r) => r["_measurement"] == "temperature")
Generate an Abstract Syntax Tree (AST) from a Query
This operation analyzes flux query and generates a query specification.
Required Parameters:
- Query
![influx operations](/img/datasource-reference/influxdb/ast.png)
Example
from(bucket: "website_metrics")
|> range(start: -7d)
|> filter(fn: (r) => r["_measurement"] == "page_views")
|> group(columns: ["url"])
|> sum(column: "_value")
|> sort(columns: ["_value"], desc: true)
Retrieve Query Suggestions
This query retrieve query suggestions.
![influx operations](/img/datasource-reference/influxdb/retrieveQuery.png)
Retrieve Query Suggestions for a Branching Suggestion
This operation retrieve query suggestions for a branching suggestion.
Required Parameters:
- Name
![influx operations](/img/datasource-reference/influxdb/queryBranch.png)
Analyze a Flux Query
This Analyzes a Flux query.
Required Parameters:
- Query
![influx operations](/img/datasource-reference/influxdb/fluxQuery.png)
Example
from(bucket: "sensor_data")
|> range(start: -1d)
|> filter(fn: (r) => r["_measurement"] == "humidity")
|> mean(column: "_value")
List Buckets
This operation lists all the buckets in a database.
![influx operations](/img/datasource-reference/influxdb/listBucket.png)
Create a Bucket
This operation creates a bucket in database.
Required Parameters:
- Query
![influx operations](/img/datasource-reference/influxdb/createBucket.png)
Example
POST http://localhost:8086/api/v2/buckets
Content-Type: application/json
Authorization: Token your_auth_token
{
"name": "new_bucket",
"orgID": "your_org_id",
"retentionRules": [
{
"everySeconds": 3600
}
]
}
Retrieve a Bucket
This operation retrieve a bucket in a database.
Required Parameters:
- Bucket ID
![influx operations](/img/datasource-reference/influxdb/retrieveBucket.png)
Update a Bucket
This operaition updates the bucket in database.
Required Parameters:
- Bucket ID
- Query
![influx operations](/img/datasource-reference/influxdb/updateBucket.png)
Example
{
"name": "updated_bucket_name",
"retentionRules": [
{
"everySeconds": 7200
}
]
}
Delete a Bucket
This operation delete the bucket in database.
Required Parameters:
- Bucket ID
![influx operations](/img/datasource-reference/influxdb/deleteBucket.png)