Get started writing data
- 2 / 3
This tutorial walks you through the fundamental of creating line protocol data and writing it to InfluxDB.
InfluxDB provides many different options for ingesting or writing data, including the following:
- InfluxDB HTTP API (v1 and v2)
- Telegraf
influxctl
CLIinflux3
data CLI- InfluxDB client libraries
If using tools like Telegraf or InfluxDB client libraries, they can build the line protocol for you, but it’s good to understand how line protocol works.
Line protocol
All data written to InfluxDB is written using line protocol, a text-based format that lets you provide the necessary information to write a data point to InfluxDB. This tutorial covers the basics of line protocol, but for detailed information, see the Line protocol reference.
Line protocol elements
Each line of line protocol contains the following elements:
* Required- * measurement: A string that identifies the table to store the data in.
- tag set: Comma-delimited list of key value pairs, each representing a tag. Tag keys and values are unquoted strings. Spaces, commas, and equal characters must be escaped.
- * field set: Comma-delimited list of key value pairs, each representing a field. Field keys are unquoted strings. Spaces and commas must be escaped. Field values can be strings (quoted), floats, integers, unsigned integers, or booleans.
- timestamp: Unix timestamp associated with the data. InfluxDB supports up to nanosecond precision. If the precision of the timestamp is not in nanoseconds, you must specify the precision when writing the data to InfluxDB.
Line protocol element parsing
- measurement: Everything before the first unescaped comma before the first whitespace.
- tag set: Key-value pairs between the first unescaped comma and the first unescaped whitespace.
- field set: Key-value pairs between the first and second unescaped whitespaces.
- timestamp: Integer value after the second unescaped whitespace.
- Lines are separated by the newline character (
\n
). Line protocol is whitespace sensitive.
measurement,tag1=val1,tag2=val2 field1="v1",field2=1i 0000000000000000000
For schema design recommendations, see InfluxDB schema design.
Construct line protocol
With a basic understanding of line protocol, you can now construct line protocol and write data to InfluxDB. Consider a use case where you collect data from sensors in your home. Each sensor collects temperature, humidity, and carbon monoxide readings. To collect this data, use the following schema:
- measurement:
home
- tags
room
: Living Room or Kitchen
- fields
temp
: temperature in °C (float)hum
: percent humidity (float)co
: carbon monoxide in parts per million (integer)
- timestamp: Unix timestamp in second precision
- tags
The following line protocol sample represents data collected hourly beginning at 2022-01-01T08:00:00Z (UTC) until 2022-01-01T20:00:00Z (UTC).
Home sensor data line protocol
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
Write line protocol to InfluxDB
The following examples show how to write the preceding sample data, already in line protocol format, to an InfluxDB Cloud Dedicated database.
To learn more about available tools and options, see Write data.
Some examples in this getting started tutorial assume your InfluxDB credentials (URL, organization, and token) are provided by environment variables.
Use the
influxctl write
command
to write the home sensor sample data to your
InfluxDB Cloud Dedicated cluster. Provide the following:
- Database name using the
--database
flag - Database token using the
--token
flag (use theINFLUX_TOKEN
environment variable created in Get started–Set up InfluxDB Cloud Dedicated) - Timestamp precision as seconds (
s
) using the--precision
flag - Home sensor data line protocol
influxctl write \
--database get-started \
--token $INFLUX_TOKEN \
--precision s \
'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'
If successful, the output is the success message; otherwise, error details and the failure message.
Use Telegraf to consume line protocol, and then write it to InfluxDB Cloud Dedicated.
-
If you haven’t already, follow the instructions to download and install Telegraf.
-
Copy and save the home sensor data sample to a file on your local system–for example,
home.lp
.cat <<- EOF > home.lp 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 EOF
-
Run the following command to generate a Telegraf configuration file (
./telegraf.conf
) that enables theinputs.file
andoutputs.influxdb_v2
plugins:telegraf --sample-config \ --input-filter file \ --output-filter influxdb_v2 \ > telegraf.conf
-
In your editor, open
./telegraf.conf
and configure the following:-
file
input plugin: In the[[inputs.file]].files
list, replace"/tmp/metrics.out"
with your sample data filename. If Telegraf can’t find a file when started, it stops processing and exits.[[inputs.file]] ## Files to parse each interval. Accept standard unix glob matching rules, ## as well as ** to match recursive files and directories. files = ["home.lp"]
-
output-influxdb_v2
output plugin: In the[[outputs.influxdb_v2]]
section, replace the default values with the following configuration for your InfluxDB Cloud Dedicated database:[[outputs.influxdb_v2]] # InfluxDB cluster URL urls = ["${INFLUX_HOST}"] # INFLUX_TOKEN is an environment variable you assigned to your database token token = "${INFLUX_TOKEN}" # An empty string (InfluxDB ignores this parameter) organization = "" # Database name bucket = "get-started"
The example configuration uses the following InfluxDB credentials:
urls
: an array containing yourINFLUX_HOST
environment variabletoken
: yourINFLUX_TOKEN
environment variableorganization
: an empty string (InfluxDB ignores this parameter)bucket
: the name of the database to write to
-
-
To write the data, start the
telegraf
daemon with the following options:--config
: Specifies the path of the configuration file.--once
: Runs a single Telegraf collection cycle for the configured inputs and outputs, and then exits.
Enter the following command in your terminal:
telegraf --once --config ./telegraf.conf
If the write is successful, the output is similar to the following:
2023-05-31T20:09:08Z D! [agent] Starting service inputs 2023-05-31T20:09:19Z D! [outputs.influxdb_v2] Wrote batch of 52 metrics in 348.008167ms 2023-05-31T20:09:19Z D! [outputs.influxdb_v2] Buffer fullness: 0 / 10000 metrics
Telegraf and its plugins provide many options for reading and writing data. To learn more, see how to use Telegraf to write data.
Write data with your existing workloads that already use the InfluxDB v1
/write
API endpoint.
If migrating data from InfluxDB 1.x, see the Migrate data from InfluxDB 1.x to InfluxDB InfluxDB Cloud Dedicated guide.
To write data to InfluxDB using the
InfluxDB v1 HTTP API, send a request
to the
InfluxDB API /write
endpoint
using the POST
request method.
POST https://cluster-id.a.influxdb.io/write
Include the following with your request:
- Headers:
- Authorization: Bearer <INFLUX_TOKEN>
- Content-Type: text/plain; charset=utf-8
- Accept: application/json
- Query parameters:
- db: InfluxDB database name
- precision:timestamp precision
(default is
ns
)
- Request body: Line protocol as plain text
With the InfluxDB Cloud Dedicated
v1 API /write
endpoint,
Authorization: Bearer
and Authorization: Token
are equivalent and you can
use either scheme to pass a database token in your request. For more information
about HTTP API token schemes, see how to
authenticate API requests.
The following example uses cURL and the InfluxDB v1 API to write line protocol to InfluxDB:
response=$(curl --silent \
"https://cluster-id.a.influxdb.io/write?db=get-started&precision=s" \
--header "Authorization: Bearer DATABASE_TOKEN" \
--header "Content-type: text/plain; charset=utf-8" \
--header "Accept: application/json" \
--write-out "\n%{response_code}" \
--data-binary "
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
")
# Extract the response body (all but the last line)
response_body=$(echo "$response" | head -n -1)
# Extract the HTTP status code (the last line)
response_code=$(echo "$response" | tail -n 1)
echo "$response_code"
if [[ $response_body ]]; then
echo "$response_body"
fi
Replace the following:
DATABASE_TOKEN
: a database token with sufficient permissions to the specified database
If successful, the output is an HTTP 204 No Content
status code; otherwise,
the error status code and failure message.
204
To write data to InfluxDB using the
InfluxDB v2 HTTP API, send a request
to the InfluxDB API /api/v2/write
endpoint using the POST
request method.
POST https://cluster-id.a.influxdb.io/api/v2/write
Include the following with your request:
- Headers:
- Authorization: Bearer <INFLUX_TOKEN>
- Content-Type: text/plain; charset=utf-8
- Accept: application/json
- Query parameters:
- bucket: InfluxDB database name
- precision:timestamp precision
(default is
ns
)
- Request body: Line protocol as plain text
The InfluxDB Cloud Dedicated v2 API /api/v2/write
endpoint supports
Bearer
and Token
authorization schemes and you can use either scheme to pass
a database token in your request.
For more information about HTTP API token
schemes, see how to
authenticate API requests.
The following example uses cURL and the InfluxDB v2 API to write line protocol to InfluxDB:
response=$(curl --silent --write-out "%{response_code}:-%{errormsg}" \
"https://cluster-id.a.influxdb.io/api/v2/write?bucket=get-started&precision=s" \
--header "Authorization: Bearer DATABASE_TOKEN" \
--header "Content-Type: text/plain; charset=utf-8" \
--header "Accept: application/json" \
--data-binary "
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
")
# Format the response code and error message output.
response_code=${response%%:-*}
errormsg=${response#*:-}
# Remove leading and trailing whitespace from errormsg
errormsg=$(echo "${errormsg}" | tr -d '[:space:]')
echo "$response_code"
if [[ $errormsg ]]; then
echo "$errormsg"
fi
Replace the following:
DATABASE_TOKEN
: a database token with sufficient permissions to the specified database
If successful, the output is an HTTP 204 No Content
status code; otherwise,
the error status code and failure message.
204
To write data to InfluxDB Cloud Dedicated 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.
-
Create a module directory and navigate into it–for example:
mkdir -p influxdb_py_client && cd influxdb_py_client
-
Setup your Python virtual environment. Inside of your module directory, enter the following command:
python -m venv envs/virtual-env
-
Activate the virtual environment.
source ./envs/virtual-env/bin/activate
-
Install the client library package:
pip install influxdb3-python
The
influxdb3-python
package provides theinfluxdb_client_3
module and also installs thepyarrow
package for working with Arrow data returned from queries. -
In your terminal or editor, create a new file for your code–for example:
write.py
.touch write.py
-
Inside of
write.py
, enter the following sample code:from influxdb_client_3 import InfluxDBClient3 import os # INFLUX_TOKEN is an environment variable you assigned to your # database WRITE token value. token = os.getenv('INFLUX_TOKEN') # host is the URL hostname without protocol or trailing slash client = InfluxDBClient3( host='cluster-id.a.influxdb.io', 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:
-
Imports the
InfluxDBClient3
object from theinfluxdb_client_3
module. -
Calls the
InfluxDBClient3()
constructor to instantiate an InfluxDB client configured with the following credentials:host
: InfluxDB Cloud Dedicated cluster hostname (URL without protocol or trailing slash)org
: an empty or arbitrary string (InfluxDB ignores this parameter)token
: a database token with write access to the specified database. Store this in a secret store or environment variable to avoid exposing the raw token string.database
: the name of the InfluxDB Cloud Dedicated database to write to
-
Defines a list of line protocol strings where each string represents a data record.
-
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.
-
-
To execute the module and write line protocol to your InfluxDB Cloud Dedicated database, enter the following command in your terminal:
python write.py
If successful, the output is the success message; otherwise, error details and the failure message.
To write data to InfluxDB Cloud Dedicated using Go, use the InfluxDB v3 influxdb3-go client library package.
-
Inside of your project directory, create a new module directory and navigate into it.
mkdir -p influxdb_go_client && cd influxdb_go_client
-
Initialize a new Go module in the directory.
go mod init influxdb_go_client
-
In your terminal or editor, create a new file for your code–for example:
write.go
.touch write.go
-
Inside of
write.go
, enter the following sample code:package main import ( "context" "os" "fmt" "log" "github.com/InfluxCommunity/influxdb3-go/influxdb3" ) // Write line protocol data to InfluxDB func WriteLineProtocol() error { // INFLUX_TOKEN is an environment variable you assigned to your // database WRITE token value. token := os.Getenv("INFLUX_TOKEN") database := os.Getenv("INFLUX_DATABASE") // Initialize a client with URL and token, // and set the timestamp precision for writes. client, err := influxdb3.New(influxdb3.ClientConfig{ Host: "https://cluster-id.a.influxdb.io", Token: token, Database: database, WriteOptions: &influxdb3.WriteOptions{Precision: lineprotocol.Second}, }) // Close the client when the function returns. defer func(client *influxdb3.Client) { err := client.Close() if err != nil { panic(err) } }(client) // 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 1641124000`, `home,room=Kitchen temp=21.0,hum=35.9,co=0i 1641124000`, `home,room=Living\ Room temp=21.4,hum=35.9,co=0i 1641127600`, `home,room=Kitchen temp=23.0,hum=36.2,co=0i 1641127600`, `home,room=Living\ Room temp=21.8,hum=36.0,co=0i 1641131200`, `home,room=Kitchen temp=22.7,hum=36.1,co=0i 1641131200`, `home,room=Living\ Room temp=22.2,hum=36.0,co=0i 1641134800`, `home,room=Kitchen temp=22.4,hum=36.0,co=0i 1641134800`, `home,room=Living\ Room temp=22.2,hum=35.9,co=0i 1641138400`, `home,room=Kitchen temp=22.5,hum=36.0,co=0i 1641138400`, `home,room=Living\ Room temp=22.4,hum=36.0,co=0i 1641142000`, `home,room=Kitchen temp=22.8,hum=36.5,co=1i 1641142000`, `home,room=Living\ Room temp=22.3,hum=36.1,co=0i 1641145600`, `home,room=Kitchen temp=22.8,hum=36.3,co=1i 1641145600`, `home,room=Living\ Room temp=22.3,hum=36.1,co=1i 1641149200`, `home,room=Kitchen temp=22.7,hum=36.2,co=3i 1641149200`, `home,room=Living\ Room temp=22.4,hum=36.0,co=4i 1641152800`, `home,room=Kitchen temp=22.4,hum=36.0,co=7i 1641152800`, `home,room=Living\ Room temp=22.6,hum=35.9,co=5i 1641156400`, `home,room=Kitchen temp=22.7,hum=36.0,co=9i 1641156400`, `home,room=Living\ Room temp=22.8,hum=36.2,co=9i 1641160000`, `home,room=Kitchen temp=23.3,hum=36.9,co=18i 1641160000`, `home,room=Living\ Room temp=22.5,hum=36.3,co=14i 1641163600`, `home,room=Kitchen temp=23.1,hum=36.6,co=22i 1641163600`, `home,room=Living\ Room temp=22.2,hum=36.4,co=17i 1641167200`, `home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641167200`, } // Iterate over the lines array and write each line // separately to InfluxDB for _, record := range lines { err = client.Write(context.Background(), []byte(record)) if err != nil { log.Fatalf("Error writing line protocol: %v", err) } } if err != nil { panic(err) } fmt.Println("Data has been written successfully.") return nil }
The sample does the following:
-
Imports required packages.
-
Defines a
WriteLineProtocol()
function that does the following:-
To instantiate the client, calls the
influxdb3.New(influxdb3.ClientConfig)
function and passes the following:-
Host
: the InfluxDB Cloud Dedicated cluster URL -
Database
: The name of your InfluxDB Cloud Dedicated database -
Token
: a database token with write access to the specified database. Store this in a secret store or environment variable to avoid exposing the raw token string. -
WriteOptions
:influxdb3.WriteOptions
options for writing to InfluxDB.Because the timestamps in the sample line protocol are in second precision, the example passes the
Precision: lineprotocol.Second
option to set the timestamp precision to seconds.
-
-
Defines a deferred function that closes the client when the function returns.
-
Defines an array of line protocol strings where each string represents a data record.
-
Iterates through the array of line protocol and calls the write client’s
Write()
method to write each line of line protocol separately to InfluxDB.
-
-
-
In your editor, create a
main.go
file and enter the following sample code that calls theWriteLineProtocol()
function:package main // Module main function func main() { WriteLineProtocol() }
-
To install dependencies and write the data to your InfluxDB Cloud Dedicated database, enter the following command into your terminal:
go mod tidy && go run influxdb_go_client
If successful, the output is the success message; otherwise, error details and the failure message.
-
If you haven’t already, follow the instructions for Downloading and installing Node.js and npm for your system.
-
In your terminal, enter the following command to create a
influxdb_js_client
directory for your project:mkdir -p influxdb_js_client && cd influxdb_js_client
-
Inside of
influxdb_js_client
, enter the following command to initialize a package. This example configures the package to use ECMAScript modules (ESM).npm init -y; npm pkg set type="module"
-
Install the
@influxdata/influxdb3-client
JavaScript client library as a dependency to your project.npm install --save @influxdata/influxdb3-client
-
In your terminal or editor, create a
write.js
file.touch write.js
-
Inside of
write.js
, enter the following sample code:// write.js import { InfluxDBClient } from '@influxdata/influxdb3-client'; /** * Set InfluxDB credentials. */ const host = 'cluster-id.a.influxdb.io'; const database = 'get-started'; /** * INFLUX_TOKEN is an environment variable you assigned to your * WRITE token value. */ const token = process.env.INFLUX_TOKEN; /** * Write line protocol to InfluxDB using the JavaScript client library. */ export async function writeLineProtocol() { /** * Instantiate an InfluxDBClient */ const client = new InfluxDBClient({ host, token }); /** * Define line protocol records to write. */ const records = [ `home,room=Living\\ Room temp=21.1,hum=35.9,co=0i 1641124000`, `home,room=Kitchen temp=21.0,hum=35.9,co=0i 1641124000`, `home,room=Living\\ Room temp=21.4,hum=35.9,co=0i 1641127600`, `home,room=Kitchen temp=23.0,hum=36.2,co=0 1641127600`, `home,room=Living\\ Room temp=21.8,hum=36.0,co=0i 1641131200`, `home,room=Kitchen temp=22.7,hum=36.1,co=0i 1641131200`, `home,room=Living\\ Room temp=22.2,hum=36.0,co=0i 1641134800`, `home,room=Kitchen temp=22.4,hum=36.0,co=0i 1641134800`, `home,room=Living\\ Room temp=22.2,hum=35.9,co=0i 1641138400`, `home,room=Kitchen temp=22.5,hum=36.0,co=0i 1641138400`, `home,room=Living\\ Room temp=22.4,hum=36.0,co=0i 1641142000`, `home,room=Kitchen temp=22.8,hum=36.5,co=1i 1641142000`, `home,room=Living\\ Room temp=22.3,hum=36.1,co=0i 1641145600`, `home,room=Kitchen temp=22.8,hum=36.3,co=1i 1641145600`, `home,room=Living\\ Room temp=22.3,hum=36.1,co=1i 1641149200`, `home,room=Kitchen temp=22.7,hum=36.2,co=3i 1641149200`, `home,room=Living\\ Room temp=22.4,hum=36.0,co=4i 1641152800`, `home,room=Kitchen temp=22.4,hum=36.0,co=7i 1641152800`, `home,room=Living\\ Room temp=22.6,hum=35.9,co=5i 1641156400`, `home,room=Kitchen temp=22.7,hum=36.0,co=9i 1641156400`, `home,room=Living\\ Room temp=22.8,hum=36.2,co=9i 1641160000`, `home,room=Kitchen temp=23.3,hum=36.9,co=18i 1641160000`, `home,room=Living\\ Room temp=22.5,hum=36.3,co=14i 1641163600`, `home,room=Kitchen temp=23.1,hum=36.6,co=22i 1641163600`, `home,room=Living\\ Room temp=22.2,hum=36.4,co=17i 1641167200`, `home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641167200`, ]; /** * Creates an array that contains separate write request promises * for all the records. */ const writePromises = records.map((record) => { return client.write(record, database, '', { precision: 's' }).then( () => `Data has been written successfully: ${record}`, () => `Failed writing data: ${record}` ); }); /** * Wait for all the write promises to settle, and then output the results. */ const writeResults = await Promise.allSettled(writePromises); writeResults.forEach((write) => console.log(write.value)); /** Close the client to release resources. */ await client.close(); }
The sample code does the following:
-
Imports the
InfluxDBClient
class. -
Calls the
new InfluxDBClient()
constructor and passes aClientOptions
object to instantiate a client configured with InfluxDB credentials.host
: your InfluxDB Cloud Dedicated cluster URLtoken
: a database token with write access to the specified database. Store this in a secret store or environment variable to avoid exposing the raw token string.
-
Defines a list of line protocol strings where each string represents a data record.
-
Calls the client’s
write()
method for each record, defines the success or failure message to return, and collects the pending promises into thewritePromises
array. Each call towrite()
passes the following arguments:record
: the line protocol recorddatabase
: the name of the InfluxDB Cloud Dedicated database to write to{precision}
: aWriteOptions
object that sets theprecision
value.
Because the timestamps in the sample line protocol are in second precision, the example passes
s
as theprecision
value to set the write timestamp precision to seconds. -
Calls
Promise.allSettled()
with the promises array to pause execution until the promises have completed, and then assigns the array containing success and failure messages to awriteResults
constant. -
Iterates over and prints the messages in
writeResults
. -
Closes the client to release resources.
-
-
In your terminal or editor, create an
index.js
file. -
Inside of
index.js
, enter the following sample code to import and callwriteLineProtocol()
:// index.js import { writeLineProtocol } from './write.js'; /** * Execute the client functions. */ async function main() { /** Write line protocol data to InfluxDB. */ await writeLineProtocol(); } main();
-
In your terminal, execute
index.js
to write to InfluxDB Cloud Dedicated:node index.js
If successful, the output is the success message; otherwise, error details and the failure message.
-
If you haven’t already, follow the Microsoft.com download instructions to install .NET and the
dotnet
CLI. -
In your terminal, create an executable C# project using the .NET console template.
dotnet new console --name influxdb_csharp_client
-
Change into the generated
influxdb_csharp_client
directory.cd influxdb_csharp_client
-
Run the following command to install the latest version of the InfluxDB v3 C# client library.
dotnet add package InfluxDB3.Client
-
In your editor, create a
Write.cs
file and enter the following sample code:// Write.cs using System; using System.Threading.Tasks; using InfluxDB3.Client; using InfluxDB3.Client.Query; namespace InfluxDBv3; public class Write { /** * Writes line protocol to InfluxDB using the C# .NET client * library. */ public static async Task WriteLines() { // Set InfluxDB credentials const string host = "https://cluster-id.a.influxdb.io"; string? database = "get-started"; /** * INFLUX_TOKEN is an environment variable you assigned to your * WRITE token value. */ string? token = System.Environment .GetEnvironmentVariable("INFLUX_TOKEN"); // Instantiate the InfluxDB client with credentials. using var client = new InfluxDBClient( host, token: token, database: database); /** * 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. */ string[] lines = new 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" }; // Write each record separately. foreach (string line in lines) { // Write the record to InfluxDB with timestamp precision in seconds. await client.WriteRecordAsync( record: line, precision: WritePrecision.S); Console.WriteLine( "Data has been written successfully: {0,-30}", line); } } }
The sample does the following:
-
Calls the
new InfluxDBClient()
constructor to instantiate a client configured with InfluxDB credentials.host
: your InfluxDB Cloud Dedicated cluster URLdatabase
: the name of the InfluxDB Cloud Dedicated database to write totoken
: a database token with write access to the specified database. Store this in a secret store or environment variable to avoid exposing the raw token string.
The
using
statement ensures that the program disposes of the client when it’s no longer needed. -
Defines an array of line protocol strings where each string represents a data record.
-
Calls the client’s
WriteRecordAsync()
method to write each line protocol record to InfluxDB.Because the timestamps in the sample line protocol are in second precision, the example passes the
WritePrecision.S
enum value to theprecision:
option to set thetimestamp precision to seconds.
-
-
In your editor, open the
Program.cs
file and replace its contents with the following:// Program.cs using System; using System.Threading.Tasks; namespace InfluxDBv3; public class Program { public static async Task Main() { await Write.WriteLineProtocol(); } }
The
Program
class shares the sameInfluxDBv3
namespace as theWrite
class you defined in the preceding step and defines aMain()
function that callsWrite.WriteLineProtocol()
. Thedotnet
CLI recognizesProgram.Main()
as the entry point for your program. -
To build and execute the program and write the line protocol to your InfluxDB Cloud Dedicated database, enter the following command in your terminal:
dotnet run
If successful, the output is the success message; otherwise, error details and the failure message.
The tutorial assumes using Maven version 3.9 and Java version >= 15.
-
If you haven’t already, follow the instructions to download and install the Java JDK and Maven for your system.
-
In your terminal or editor, use Maven to generate a project–for example:
mvn org.apache.maven.plugins:maven-archetype-plugin:3.1.2:generate \ -DarchetypeArtifactId="maven-archetype-quickstart" \ -DarchetypeGroupId="org.apache.maven.archetypes" -DarchetypeVersion="1.4" \ -DgroupId="com.influxdbv3" -DartifactId="influxdb_java_client" -Dversion="1.0"
Maven creates the
<artifactId>
directory (./influxdb_java_client
) that contains apom.xml
and scaffolding for yourcom.influxdbv3.influxdb_java_client
Java application. -
In your terminal or editor, change into the
./influxdb_java_client
directory–for example:cd ./influxdb_java_client
-
In your editor, open the
pom.xml
Maven configuration file and add thecom.influxdb.influxdb3-java
client library intodependencies
.... <dependencies> ... <dependency> <groupId>com.influxdb</groupId> <artifactId>influxdb3-java</artifactId> <version>0.1.0</version> </dependency> ... </dependencies>
-
To check your
pom.xml
for problems, run Maven’svalidate
command–for example, enter the following in your terminal:mvn validate
-
In your editor, navigate to the
./influxdb_java_client/src/main/java/com/influxdbv3
directory and create aWrite.java
file. -
In
Write.java
, enter the following sample code:// Write.java package com.influxdbv3; import java.util.List; import com.influxdb.v3.client.InfluxDBClient; import com.influxdb.v3.client.write.WriteOptions; import com.influxdb.v3.client.write.WritePrecision; /** * Writes line protocol to InfluxDB using the Java client * library. */ public final class Write { /** * Write data to InfluxDB v3. */ private Write() { //not called } /** * @throws Exception */ public static void writeLineProtocol() throws Exception { // Set InfluxDB credentials final String host = "https://cluster-id.a.influxdb.io"; final String database = "get-started"; /** * INFLUX_TOKEN is an environment variable you assigned to your * WRITE token value. */ final char[] token = (System.getenv("INFLUX_TOKEN")). toCharArray(); // Instantiate the InfluxDB client. try (InfluxDBClient client = InfluxDBClient.getInstance(host, token, database)) { // Create a list of line protocol records. final List<String> records = List.of( "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" ); /** * Write each record separately to InfluxDB with timestamp * precision in seconds. * If no error occurs, print a success message. * */ for (String record : records) { client.writeRecord(record, new WriteOptions(null, null, WritePrecision.S)); System.out.printf("Data has been written successfully: %s%n", record); } } } }
The sample code does the following:
-
Imports the following classes:
java.util.List
;com.influxdb.v3.client.InfluxDBClient
com.influxdb.v3.client.write.WriteParameters
com.influxdb.v3.client.write.WritePrecision
-
Calls
InfluxDBClient.getInstance()
to instantiate a client configured with InfluxDB credentials.host
: your InfluxDB Cloud Dedicated cluster URLdatabase
: the name of the InfluxDB Cloud Dedicated database to write totoken
: a database token with write access to the specified database. Store this in a secret store or environment variable to avoid exposing the raw token string.
-
Defines a list of line protocol strings where each string represents a data record.
-
Calls the client’s
writeRecord()
method to write each record separately to InfluxDB.Because the timestamps in the sample line protocol are in second precision, the example passes the
WritePrecision.S
enum value as theprecision
argument to set the write timestamp precision to seconds.
-
-
In your editor, open the
App.java
file (created by Maven) and replace its contents with the following sample code:// App.java package com.influxdbv3; /** * Execute the client functions. * */ public class App { /** * @param args * @throws Exception */ public static void main(final String[] args) throws Exception { // Write data to InfluxDB v3. Write.writeLineProtocol(); } }
- The
App
class andWrite
class are part of the samecom.influxdbv3
package (your project groupId). App
defines amain()
function that callsWrite.writeLineProtocol()
.
- The
-
In your terminal or editor, use Maven to install dependencies and compile the project code–for example:
mvn compile
-
In your terminal or editor, execute
App.main()
to write to InfluxDB–for example, using Maven:mvn exec:java -Dexec.mainClass="com.influxdbv3.App"
If successful, the output is the success message; otherwise, error details and the failure message.
View the written data
time | room | co | hum | temp |
---|---|---|---|---|
2022-01-01T08:00:00Z | Kitchen | 0 | 35.9 | 21 |
2022-01-01T09:00:00Z | Kitchen | 0 | 36.2 | 23 |
2022-01-01T10:00:00Z | Kitchen | 0 | 36.1 | 22.7 |
2022-01-01T11:00:00Z | Kitchen | 0 | 36 | 22.4 |
2022-01-01T12:00:00Z | Kitchen | 0 | 36 | 22.5 |
2022-01-01T13:00:00Z | Kitchen | 1 | 36.5 | 22.8 |
2022-01-01T14:00:00Z | Kitchen | 1 | 36.3 | 22.8 |
2022-01-01T15:00:00Z | Kitchen | 3 | 36.2 | 22.7 |
2022-01-01T16:00:00Z | Kitchen | 7 | 36 | 22.4 |
2022-01-01T17:00:00Z | Kitchen | 9 | 36 | 22.7 |
2022-01-01T18:00:00Z | Kitchen | 18 | 36.9 | 23.3 |
2022-01-01T19:00:00Z | Kitchen | 22 | 36.6 | 23.1 |
2022-01-01T20:00:00Z | Kitchen | 26 | 36.5 | 22.7 |
2022-01-01T08:00:00Z | Living Room | 0 | 35.9 | 21.1 |
2022-01-01T09:00:00Z | Living Room | 0 | 35.9 | 21.4 |
2022-01-01T10:00:00Z | Living Room | 0 | 36 | 21.8 |
2022-01-01T11:00:00Z | Living Room | 0 | 36 | 22.2 |
2022-01-01T12:00:00Z | Living Room | 0 | 35.9 | 22.2 |
2022-01-01T13:00:00Z | Living Room | 0 | 36 | 22.4 |
2022-01-01T14:00:00Z | Living Room | 0 | 36.1 | 22.3 |
2022-01-01T15:00:00Z | Living Room | 1 | 36.1 | 22.3 |
2022-01-01T16:00:00Z | Living Room | 4 | 36 | 22.4 |
2022-01-01T17:00:00Z | Living Room | 5 | 35.9 | 22.6 |
2022-01-01T18:00:00Z | Living Room | 9 | 36.2 | 22.8 |
2022-01-01T19:00:00Z | Living Room | 14 | 36.3 | 22.5 |
2022-01-01T20:00:00Z | Living Room | 17 | 36.4 | 22.2 |
Congratulations! You’ve written data to InfluxDB. Next, learn how to query your data.
Related
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.