influxdb-client-js
This repository contains the reference javascript client for InfluxDB 2.0. Node, browser and deno environments are supported.
node-influx client library.
Note: Use this client library with InfluxDB 2.x and InfluxDB 1.8+. For connecting to InfluxDB 1.7 or earlier instances, see theFeatures
InfluxDB 2.0 client consists of two main 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
- provides all other InfluxDB 2.0 APIs for managing
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
@influxdata/influxdb-client module primarily works in Node.js (main CJS and module ESM), but a browser (browser UMD) distribution is also available therein. If you target browser or deno, use @influxdata/influxdb-client-browser.
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 help to start quickly with this client:
- @influxdata/influxdb-client
- @influxdata/influxdb-client-apis
There are also more advanced examples that show
- how to execute parameterized queries
- how to use this client with InfluxDB 1.8+
- how to use this client in the browser or deno
- how to process InfluxDB query results with RX Observables
- how to customize the way of how measurement points are written to InfluxDB
- how to visualize query results in Giraffe
The client API Reference Documentation is available online at https://influxdata.github.io/influxdb-client-js/ .
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.
Build Requirements:
- node v14 LTS
- yarn 1.9.4. or higher
Run tests:
$ yarn test
Check code coverage:
$ yarn coverage
Build distributions:
$ yarn build
License
The InfluxDB 2.0 javascript client is released under the MIT License.