Get started writing data

To write data to InfluxDB Cloud Serverless using Python, use the influxdb_client_3 module. The following steps include setting up a Python virtual environment to scope dependencies to your current project.

1. Create a new module directory and navigate into it–for example:

   mkdir influxdb_py_client && cd $_
   

2. Setup your Python virtual environment. Inside of your module directory:

   python -m venv envs/virtual-env
   

3. Activate the virtual environment.

   source ./envs/virtual-env/bin/activate
   

4. Install the following dependencies:

   • pyarrow
   • influxdb_client_3

   pip install pyarrow influxdb_client_3
   

5. In your terminal or editor, create a new file for your code–for example: write.py.

   touch write.py
   

6. Inside of write.py, enter the following sample code:

   from influxdb_client_3 import InfluxDBClient3
   
   # INFLUX_TOKEN is an environment variable you assigned to your
   # API token value.
   token = os.getenv('INFLUX_TOKEN')
   
   # host is the URL without protocol or trailing slash
   client = InfluxDBClient3(
       host='cloud2.influxdata.com',
       org='',
       token=token,
       database='get-started'
   )
   
   lines = [
       "home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1641024000",
       "home,room=Kitchen temp=21.0,hum=35.9,co=0i 1641024000",
       "home,room=Living\ Room temp=21.4,hum=35.9,co=0i 1641027600",
       "home,room=Kitchen temp=23.0,hum=36.2,co=0i 1641027600",
       "home,room=Living\ Room temp=21.8,hum=36.0,co=0i 1641031200",
       "home,room=Kitchen temp=22.7,hum=36.1,co=0i 1641031200",
       "home,room=Living\ Room temp=22.2,hum=36.0,co=0i 1641034800",
       "home,room=Kitchen temp=22.4,hum=36.0,co=0i 1641034800",
       "home,room=Living\ Room temp=22.2,hum=35.9,co=0i 1641038400",
       "home,room=Kitchen temp=22.5,hum=36.0,co=0i 1641038400",
       "home,room=Living\ Room temp=22.4,hum=36.0,co=0i 1641042000",
       "home,room=Kitchen temp=22.8,hum=36.5,co=1i 1641042000",
       "home,room=Living\ Room temp=22.3,hum=36.1,co=0i 1641045600",
       "home,room=Kitchen temp=22.8,hum=36.3,co=1i 1641045600",
       "home,room=Living\ Room temp=22.3,hum=36.1,co=1i 1641049200",
       "home,room=Kitchen temp=22.7,hum=36.2,co=3i 1641049200",
       "home,room=Living\ Room temp=22.4,hum=36.0,co=4i 1641052800",
       "home,room=Kitchen temp=22.4,hum=36.0,co=7i 1641052800",
       "home,room=Living\ Room temp=22.6,hum=35.9,co=5i 1641056400",
       "home,room=Kitchen temp=22.7,hum=36.0,co=9i 1641056400",
       "home,room=Living\ Room temp=22.8,hum=36.2,co=9i 1641060000",
       "home,room=Kitchen temp=23.3,hum=36.9,co=18i 1641060000",
       "home,room=Living\ Room temp=22.5,hum=36.3,co=14i 1641063600",
       "home,room=Kitchen temp=23.1,hum=36.6,co=22i 1641063600",
       "home,room=Living\ Room temp=22.2,hum=36.4,co=17i 1641067200",
       "home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641067200"
   ]
   
   client.write(lines,write_precision='s')
   

   The sample does the following:

   1. Imports the InfluxDBClient3 object from the influxdb_client_3 module.

   2. Calls the InfluxDBClient3() constructor to instantiate an InfluxDB client configured with the following credentials:

      • host: InfluxDB Cloud Serverless region hostname (URL without protocol or trailing slash)
      • org: an empty or arbitrary string (InfluxDB ignores this parameter)
      • token: an InfluxDB API token with write access to the target bucket
      • database: the name of the InfluxDB Cloud Serverless bucket to write to

   3. Defines a list of line protocol strings where each string represents a data record.

   4. Calls the client.write() method with the line protocol record list and write options.

      Because the timestamps in the sample line protocol are in second precision, the example passes the write_precision='s' option to set the timestamp precision to seconds.

7. To execute the module and write line protocol to your InfluxDB Cloud Serverless bucket, enter the following command in your terminal:

   python write.py
   

To write data to InfluxDB Cloud Serverless using Go, use the influxdb-client-go module.

1. Inside of your project directory, create a new module directory and navigate into it.

   mkdir influxdb_go_client && cd $_
   

2. Initialize a new Go module in the directory.

   go mod init influxdb_go_client
   

3. In your terminal or editor, create a new file for your code–for example: write.go.

   touch write.go
   

4. Inside of write.go, enter the following sample code:

   package main
   
   import (
     "context"
     "fmt"
     "log"
     "os"
     "time"
   
     influxdb2 "github.com/influxdata/influxdb-client-go/v2"
   )
   
   // Write line protocol data to InfluxDB
   func dbWrite(ctx context.Context) error {
   
     // INFLUX_URL is an environment variable you assigned to your
     // region URL.
     url := os.Getenv("INFLUX_URL")
   
     // INFLUX_TOKEN is an environment variable you assigned to your
     // API token value.
     token := os.Getenv("INFLUX_TOKEN")
     client := influxdb2.NewClientWithOptions(url,
                     token,
                     influxdb2.DefaultOptions().SetPrecision(time.Second))
   
     // Define write API
     org := "ignored"
     bucket := "get-started"
     writeAPI := client.WriteAPIBlocking(org, bucket)
   
     // Define line protocol records to write.
     // Use a raw string literal (denoted by backticks)
     // to preserve backslashes and prevent interpretation
     // of escape sequences--for example, escaped spaces in tag values.
     lines := [...]string{
       `home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1641024000`,
       `home,room=Kitchen temp=21.0,hum=35.9,co=0i 1641024000`,
       `home,room=Living\ Room temp=21.4,hum=35.9,co=0i 1641027600`,
       `home,room=Kitchen temp=23.0,hum=36.2,co=0i 1641027600`,
       `home,room=Living\ Room temp=21.8,hum=36.0,co=0i 1641031200`,
       `home,room=Kitchen temp=22.7,hum=36.1,co=0i 1641031200`,
       `home,room=Living\ Room temp=22.2,hum=36.0,co=0i 1641034800`,
       `home,room=Kitchen temp=22.4,hum=36.0,co=0i 1641034800`,
       `home,room=Living\ Room temp=22.2,hum=35.9,co=0i 1641038400`,
       `home,room=Kitchen temp=22.5,hum=36.0,co=0i 1641038400`,
       `home,room=Living\ Room temp=22.4,hum=36.0,co=0i 1641042000`,
       `home,room=Kitchen temp=22.8,hum=36.5,co=1i 1641042000`,
       `home,room=Living\ Room temp=22.3,hum=36.1,co=0i 1641045600`,
       `home,room=Kitchen temp=22.8,hum=36.3,co=1i 1641045600`,
       `home,room=Living\ Room temp=22.3,hum=36.1,co=1i 1641049200`,
       `home,room=Kitchen temp=22.7,hum=36.2,co=3i 1641049200`,
       `home,room=Living\ Room temp=22.4,hum=36.0,co=4i 1641052800`,
       `home,room=Kitchen temp=22.4,hum=36.0,co=7i 1641052800`,
       `home,room=Living\ Room temp=22.6,hum=35.9,co=5i 1641056400`,
       `home,room=Kitchen temp=22.7,hum=36.0,co=9i 1641056400`,
       `home,room=Living\ Room temp=22.8,hum=36.2,co=9i 1641060000`,
       `home,room=Kitchen temp=23.3,hum=36.9,co=18i 1641060000`,
       `home,room=Living\ Room temp=22.5,hum=36.3,co=14i 1641063600`,
       `home,room=Kitchen temp=23.1,hum=36.6,co=22i 1641063600`,
       `home,room=Living\ Room temp=22.2,hum=36.4,co=17i 1641067200`,
       `home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641067200`,
     }
   
     // Iterate over the lines array and write each line
     // separately to InfluxDB
   
     for _, lp := range lines {
       err := writeAPI.WriteRecord(context.Background(), lp)
       if err != nil {
         log.Fatalf("Error writing line protocol: %v", err)
       }
     }
   
     fmt.Println("Data has been written successfully.")
     client.Close()
     return nil
   }
   
   // Module main function
   func main() {
     if err := dbWrite(context.Background()); err != nil {
       fmt.Fprintf(os.Stderr, "error: %v\n", err)
       os.Exit(1)
     }
   }
   

   The sample does the following:

   1. Imports required packages.

   2. Defines a dbWrite() function that does the following:

      1. Calls the influxdb2.NewClientWithOptions() with InfluxDB URL, API token, and options to create client.

         Because the timestamps in the sample line protocol are in second precision, the example passes DefaultOptions.SetPrecision(time.Second) for the precision option in order to set the timestamp precision to seconds.

      2. Calls the writeClient.WriteAPIBlocking() method to create a writeAPI client configured to write to the bucket (the method requires an org argument, but InfluxDB ignores it).

      3. Defines an array of line protocol strings where each string represents a data record.

      4. Iterates through the array of line protocol and calls the write client’s WriteRecord() method to write each line of line protocol separately to InfluxDB.

   3. Defines a main function that executes the dbWrite function for the module.

5. In your terminal, enter the following command to install the packages listed in imports:

   go get ./...
   

6. To execute the module and write the line protocol to your InfluxDB Cloud Serverless bucket, enter the following command:

   go run ./write.go
   

To write data to InfluxDB Cloud Serverless using Node.js, use the influxdb-client-js package.

1. Inside of your project directory, create an NPM or Yarn package and install the @influxdata/influxdb-client InfluxDB v2 JavaScript client library.

   npm init -y && npm install --save @influxdata/influxdb-client
   

2. In your terminal or editor, create a new file for your code–for example: write.js.

   touch write.js
   

3. Inside of write.js, enter the following sample code:

   'use strict'
   /** @module write
   * Writes line protocol strings to InfluxDB using the Javascript client
   * library with Node.js.
   **/
   import {InfluxDB} from '@influxdata/influxdb-client';
   
   /** Get credentials from environment variables. **/
   const url = process.env.INFLUX_URL;
   const token = process.env.INFLUX_TOKEN;
   const org = process.env.INFLUX_ORG;
   
   /**
   * Instantiate the InfluxDB client with a configuration object.
   **/
   const influxDB = new InfluxDB({url, token});
   
   /** 
   * Define an array of line protocol strings to write.
   * Include an additional backslash to preserve backslashes
   * and prevent interpretation of escape sequences---for example,
   * escaped spaces in tag values.
   */
   const lines = [
     'home,room=Living\\ Room temp=21.1,hum=35.9,co=0i 1641024000',
     'home,room=Kitchen temp=21.0,hum=35.9,co=0i 1641024000',
     'home,room=Living\\ Room temp=21.4,hum=35.9,co=0i 1641027600',
     'home,room=Kitchen temp=23.0,hum=36.2,co=0i 1641027600',
     'home,room=Living\\ Room temp=21.8,hum=36.0,co=0i 1641031200',
     'home,room=Kitchen temp=22.7,hum=36.1,co=0i 1641031200',
     'home,room=Living\\ Room temp=22.2,hum=36.0,co=0i 1641034800',
     'home,room=Kitchen temp=22.4,hum=36.0,co=0i 1641034800',
     'home,room=Living\\ Room temp=22.2,hum=35.9,co=0i 1641038400',
     'home,room=Kitchen temp=22.5,hum=36.0,co=0i 1641038400',
     'home,room=Living\\ Room temp=22.4,hum=36.0,co=0i 1641042000',
     'home,room=Kitchen temp=22.8,hum=36.5,co=1i 1641042000',
     'home,room=Living\\ Room temp=22.3,hum=36.1,co=0i 1641045600',
     'home,room=Kitchen temp=22.8,hum=36.3,co=1i 1641045600',
     'home,room=Living\\ Room temp=22.3,hum=36.1,co=1i 1641049200',
     'home,room=Kitchen temp=22.7,hum=36.2,co=3i 1641049200',
     'home,room=Living\\ Room temp=22.4,hum=36.0,co=4i 1641052800',
     'home,room=Kitchen temp=22.4,hum=36.0,co=7i 1641052800',
     'home,room=Living\\ Room temp=22.6,hum=35.9,co=5i 1641056400',
     'home,room=Kitchen temp=22.7,hum=36.0,co=9i 1641056400',
     'home,room=Living\\ Room temp=22.8,hum=36.2,co=9i 1641060000',
     'home,room=Kitchen temp=23.3,hum=36.9,co=18i 1641060000',
     'home,room=Living\\ Room temp=22.5,hum=36.3,co=14i 1641063600',
     'home,room=Kitchen temp=23.1,hum=36.6,co=22i 1641063600',
     'home,room=Living\\ Room temp=22.2,hum=36.4,co=17i 1641067200',
     'home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641067200',
   ];
   
   /**
   * Create a write client from the getWriteApi method.
   * Provide your org and bucket.
   **/
   const writeApi = influxDB.getWriteApi(org, 'get-started', 's');
   
   /**
   * Write line protocol to the batch
   */
   writeApi.writeRecords(lines);
   
   /**
   * Flush pending writes from the buffer and close the write client.
   **/
   writeApi.close().then(
     () => {
       console.log('Data has been written successfully.');
     },
     (err) => {
       console.log('Error writing line protocol');
     }
   );
   

   The sample does the following:

   1. Calls the new InfluxDB() constructor to instantiate a client configured with the InfluxDB URL and API token.

   2. Defines an array of line protocol strings where each string represents a data record.

   3. Calls the client’s getWriteApi() method to create a write client configured to write to the bucket (the method requires an org argument, but InfluxDB ignores it).

      Because the timestamps in the sample line protocol are in second precision, the example passes 's' for the precision option in order to set the timestamp precision to seconds.

   4. Calls the write client’s writeRecords() method with the line protocol array to write the records in batches to InfluxDB.

   5. Calls the write client’s close() method with callback functions for success and error. The close() method sends any records remaining in the buffer, executes callbacks, and releases resources.

4. To execute the file and write the line protocol to your InfluxDB Cloud Serverless bucket, enter the following command in your terminal:

   node write.js