Install the InfluxDB v2 JavaScript client library
Limited availability
InfluxDB Clustered is currently only available to a limited group of InfluxData customers. If interested in being part of the limited access group, please contact the InfluxData Sales team.
Install the Node.js JavaScript client library to write data to an InfluxDB Clustered database.
Tools to execute queries
InfluxDB v2 client libraries use the InfluxDB API /api/v2/query
endpoint.
This endpoint can’t query an InfluxDB Clustered database.
InfluxDB Clustered supports many different tools for querying data, including:
Install Node.js
Install Node.js.
Ensure that InfluxDB is running and you can connect to it. For information about what URL to use to connect to your InfluxDB cluster, contact your InfluxData account representative.
In your terminal, create a directory for your Node.js project and change to it.
mkdir influx-node-app && cd $_
Enter the following command to generate an npm package for your project. The
npm
package manager is included with Node.js.npm init -y
Install TypeScript
Many of the client library examples use TypeScript. Follow these steps to initialize the TypeScript project:
Install TypeScript and type definitions for Node.js.
npm i -g typescript && npm i --save-dev @types/node
Create a TypeScript configuration with default values.
tsc --init
Run the TypeScript compiler. To recompile your code automatically as you make changes, pass the
watch
flag to the compiler.tsc -w -p
Install dependencies
Use the @influxdata/influxdb-client
JavaScript client library to write data in InfluxDB Clustered.
Open a new terminal window and install the @influxdata/influxdb-client
package for querying and writing data:
npm i --save @influxdata/influxdb-client
The @influxdata/influxdb-client-apis
client library package won’t work with InfluxDB Clustered.
It only works with InfluxDB v2 management APIs.
Configure credentials
The client examples include an env
module for accessing your InfluxDB properties from environment variables or from env.js
.
The examples use these properties to interact with the InfluxDB API.
Set environment variables or update env.js
with your InfluxDB database, organization (required, but ignored), token, and cluster URL.
export INFLUX_URL=https://cluster-host.com
export INFLUX_TOKEN=DATABASE_TOKEN
export INFLUX_ORG=ORG_ID
export INFLUX_DATABASE=DATABASE_NAME
Replace the following:
DATABASE_TOKEN
: InfluxDB database tokenORG_ID
: An arbitrary string (InfluxDB ignores this credential, but the client library requires it)DATABASE_NAME
: InfluxDB database name
Next steps
Once you’ve installed the client library and configured credentials, you’re ready to write data to InfluxDB.
Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for InfluxDB and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.