docs-v2

3.2 KiB

Raw Blame History

title

seotitle

description

influxdb/cloud-dedicated/tags

weight

aliases

Install the InfluxDB JavaScript client library

Install the InfluxDB Node.js JavaScript client library

Install the Node.js JavaScript client library to interact with the InfluxDB v2 API.

influxdb_cloud_dedicated

name	parent
Install	Node.js

client libraries

JavaScript

100

/influxdb/cloud-dedicated/reference/api/client-libraries/nodejs/install

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 Cloud Dedicated cluster, contact your InfluxData account representative.
Start a new Node.js project. The npm package manager is included with Node.js.

npm init -y influx-node-app

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

The JavaScript client library contains two packages: @influxdata/influxdb-client and @influxdata/influxdb-client-apis. Add both as dependencies of your project.

Open a new terminal window and install @influxdata/influxdb-client for querying and writing data:
```
npm install --save @influxdata/influxdb-client
```
Install @influxdata/influxdb-client-apis for access to the InfluxDB management APIs:
```
npm install --save @influxdata/influxdb-client-apis
```

Next steps

Once you've installed the Javascript client library, you're ready to write data to InfluxDB or get started with other examples from the client library.

Get started with examples

{{% note %}} 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. {{% /note %}}

Set environment variables or update env.js with your InfluxDB database (bucket), organization (required, but ignored), token, and cluster URL.
```
export INFLUX_URL=https://cluster-id.influxdb.io
export INFLUX_TOKEN=YOUR_API_TOKEN
export INFLUX_ORG=YOUR_ORG
export INFLUX_BUCKET=YOUR_BUCKET
```
Replace the following:
- YOUR_API_TOKEN: InfluxDB database token
- YOUR_ORG: An arbitrary string (this credential is ignored)
- YOUR_BUCKET: InfluxDB database name
Run an example script.
```
query.ts
```

3.2 KiB Raw Blame History