jaggedsoft / influxdb-client-js

InfluxDB 2.0 JavaScript client

influxdb-client-javascript

This repository contains the reference javascript client for InfluxDB 2.0. Both node and browser environments are supported.

Note: Use this client library with InfluxDB 2.x and InfluxDB 1.8+. For connecting to InfluxDB 1.7 or earlier instances, see the node-influx client library.

Features

InfluxDB 2.0 client consists of two packages

• @influxdata/influxdb-client
  • Querying data using the Flux language
  • Writing data
    • batched in chunks on background
    • automatic retries on write failures
• @influxdata/influxdb-client-apis
  • provides all other InfluxDB 2.0 APIs for managing
    • sources, buckets
    • tasks
    • authorizations
    • health check
    • ...
  • built on top of @influxdata/influxdb-client

Installation

To write or query InfluxDB, add @influxdata/influxdb-client dependency to your project using your favourite package manager.

$npm install --save @influxdata/influxdb-client
$yarn add @influxdata/influxdb-client
$pnpm add @influxdata/influxdb-client

To use InfluxDB management APIs in your project, add also @influxdata/influxdb-client-apis dependency to your project.

$npm install --save @influxdata/influxdb-client-apis
$yarn add @influxdata/influxdb-client-apis
$pnpm add @influxdata/influxdb-client-apis

Usage

The following examples helps to start quickly with this client:

• @influxdata/influxdb-client
  • write points
  • query data
• @influxdata/influxdb-client-apis
  • setup / onboarding
  • create bucket
  • health

There are also more advanced examples that shows

• how to execute parameterized queries
• how to use this client with InfluxDB 1.8+
• how to use this client in the browser
• how to process InfluxDB query results with RX Observables
• how to customize the way of how measurement points are written to InfluxDB

The client API Reference Documentation is available online at https://influxdata.github.io/influxdb-client-js/ .

Build Requirements

• node v12.13.1 or higher (older versions will work as well)
• yarn 1.9.4. or higher (older versions will work as well)

Run all unit tests:

$ yarn test:unit

Check code coverage of unit tests:

$ yarn coverage

Development

Releasing a new version

Ensure that:

• You have administrator access to this repo on GitHub
• You have permissions to publish to the influxdata organization on npm
• You are on master and the working tree is clean

Then run the publish script in the root of the repo:

make publish VERSION=1.1.0

Contributing

If you would like to contribute code you can do through GitHub by forking the repository and sending a pull request into the master branch.

License

The InfluxDB 2.0 javascript client is released under the MIT License.