Back to Tooljet

InfluxDB

docs/versioned_docs/version-2.50.0-LTS/data-sources/influxdb.md

3.20.154-lts5.2 KB
Original Source

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.

<div style={{paddingTop:'24px'}}>

Connection

ToolJet connects to InfluxDB using :

  • API Token
  • Host
  • Port
  • Protocol (HTTP/HTTPS)

:::info For generating API Token visit InfluxDB docs. :::

<div style={{textAlign: 'center'}}> </div> </div> <div style={{paddingTop:'24px'}}>

Supported Queries

Write Data

This operation writes data to a bucket.

Required Parameters:

  • Bucket
  • Organization name or ID
  • Data

Optional Parameters:

  • Precision

Query Data

Retrieves data from InfluxDB buckets.

Required Parameters:

  • Organization name or ID
  • Flux query

Example

yaml
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

Example

yaml
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.

Retrieve Query Suggestions for a Branching Suggestion

This operation retrieve query suggestions for a branching suggestion.

Required Parameters:

  • Name

Analyze a Flux Query

This Analyzes a Flux query.

Required Parameters:

  • Query

Example

yaml
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.

Create a Bucket

This operation creates a bucket in database.

Required Parameters:

  • Query

Example

yaml
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

Update a Bucket

This operaition updates the bucket in database.

Required Parameters:

  • Bucket ID
  • Query

Example

yaml
{
  "name": "updated_bucket_name",
  "retentionRules": [
    {
      "everySeconds": 7200
    }
  ]
}

Delete a Bucket

This operation delete the bucket in database.

Required Parameters:

  • Bucket ID
</div>