@influxdata/influxdb3-client

InfluxDB 3 JavaScript Client

The JavaScript Client that provides a simple and convenient way to interact with InfluxDB 3. This package supports both writing data to InfluxDB and querying data using the FlightSQL client, which allows you to execute SQL queries against InfluxDB IOx.

Installation

To write or query InfluxDB 3, add @influxdata/influxdb3-client as a dependency to your project using your favorite package manager.

npm install --save @influxdata/influxdb3-client
yarn add @influxdata/influxdb3-client
pnpm add @influxdata/influxdb3-client

If you target Node.js, use @influxdata/influxdb3-client. It provides main (CJS), module (ESM), and browser (UMD) exports.

Usage

set environment variables:

• INFLUXDB_URL region of your influxdb cloud e.g. https://us-east-1-1.aws.cloud2.influxdata.com/
• INFLUXDB_TOKEN read/write token generated in cloud
• INFLUXDB_DATABASE name of database e.g .my-database

linux/macos

export INFLUXDB_URL="<url>"
export INFLUXDB_DATABASE="<database>"
export INFLUXDB_TOKEN="<token>"

windows

powershell

$env:INFLUXDB_URL = "<url>"
$env:INFLUXDB_DATABASE = "<database>"
$env:INFLUXDB_TOKEN = "<token>"

cmd

set INFLUXDB_URL=<url>
set INFLUXDB_DATABASE=<database>
set INFLUXDB_TOKEN=<token>

Create a client

To get started with influxdb client import @influxdata/influxdb3-client package.

import {InfluxDBClient, Point} from '@influxdata/influxdb3-client'

Assign constants for environment variables, and then instantiate InfluxDBClient inside of an asynchronous function. Make sure to close the client when it's no longer needed for writing or querying.

const host = process.env.INFLUXDB_URL
const token = process.env.INFLUXDB_TOKEN
const database = process.env.INFLUXDB_DATABASE

async function main() {
    const client = new InfluxDBClient({host, token})

    // following code goes here

    client.close()
}

main()

Write data

To write data to InfluxDB, call client.write with data in line-protocol format and the database (or bucket) name.

const line = `stat,unit=temperature avg=20.5,max=45.0`
await client.write(line, database)

Query data

To query data stored in InfluxDB, call client.query with an SQL query and the database (or bucket) name.

// Execute query
const query = `
    SELECT *
    FROM "stat"
    WHERE
    time >= now() - interval '5 minute'
    AND
    "unit" IN ('temperature')
`
const queryResult = await client.query(query, database)

for await (const row of queryResult) {
    console.log(`avg is ${row.avg}`)
    console.log(`max is ${row.max}`)
}

or use typesafe PointValues structure with client.queryPoints

const queryPointsResult = client.queryPoints(
    query,
    database,
    queryType,
    'stat'
)

for await (const row of queryPointsResult) {
    console.log(`avg is ${row.getField('avg', 'float')}`)
    console.log(`max is ${row.getField('max', 'float')}`)
    console.log(`lp: ${row.toLineProtocol()}`)
}

Examples

For more advanced usage, see examples.

Feedback

If you need help, please use our Community Slack or Community Page.

New features and bugs can be reported on GitHub: https://github.com/InfluxCommunity/influxdb3-js

Contribution

To contribute to this project, fork the GitHub repository and send a pull request based on the main branch.

Development

Update the Flight Client

For now, we're responsible for generating the Flight client. However, its Protobuf interfaces may undergo changes over time.

To regenerate the Flight client, use the yarn flight command to execute the provided script. The script will clone the Flight Protobuf repository and generate new TypeScript files in ./src/generated/flight.

License

The InfluxDB 3 JavaScript Client is released under the MIT License.