3.5 KiB
Use the InfluxDB Python client library to integrate InfluxDB into Python scripts and applications.
This guide presumes some familiarity with Python and InfluxDB. If just getting started, see Get started with InfluxDB.
Before you begin
You'll need the following prerequisites:
-
Install the InfluxDB Python library:
pip install influxdb-client
-
InfluxDB Cloud Dedicated cluster URL using the HTTPS protocol--for example:
https://{{< influxdb/host >}}
-
Name of the database to write to.
-
InfluxDB database token with permission to write to the database. For security reasons, we recommend setting an environment variable to store your token and avoid exposing the raw token value in your script.
Write data to InfluxDB with Python
Follow the steps to write line protocol data to an InfluxDB Cloud Dedicated database.
-
In your editor, create a file for your Python program--for example:
write.py
. -
In the file, import the InfluxDB client library.
import influxdb_client from influxdb_client.client.write_api import SYNCHRONOUS import os
-
Define variables for your database name, organization (required, but ignored), and database token.
database = "DATABASE_NAME" org = "ignored" # INFLUX_TOKEN is an environment variable you created for your database WRITE token token = os.getenv('INFLUX_TOKEN') url="https://{{< influxdb/host >}}"
-
To instantiate the client, call the
influxdb_client.InfluxDBClient()
method with the following keyword arguments:url
,org
, andtoken
.client = influxdb_client.InfluxDBClient( url=url, token=token, org=org )
The
InfluxDBClient
object has awrite_api
method used for configuration. -
Instantiate a write client by calling the
client.write_api()
method with write configuration options.write_api = client.write_api(write_options=SYNCHRONOUS)
-
Create a point object and write it to InfluxDB using the
write
method of the API writer object. The write method requires three parameters:bucket
,org
, andrecord
.p = influxdb_client.Point("my_measurement").tag("location", "Prague").field("temperature", 25.3) write_api.write(bucket=database, org=org, record=p)
Complete example write script
import influxdb_client
from influxdb_client.client.write_api import SYNCHRONOUS
import os
database = "DATABASE_NAME"
org = "ignored"
# INFLUX_TOKEN is an environment variable you created for your database WRITE token
token = os.getenv('INFLUX_TOKEN')
url="https://{{< influxdb/host >}}"
client = influxdb_client.InfluxDBClient(
url=url,
token=token,
org=org
)
# Write script
write_api = client.write_api(write_options=SYNCHRONOUS)
p = influxdb_client.Point("my_measurement").tag("location", "Prague").field("temperature", 25.3)
write_api.write(bucket=database, org=org, record=p)
Query data from InfluxDB with Python
The InfluxDB v2 Python client can't query InfluxDB Cloud Dedicated. To query your dedicated instance, use a Python Flight SQL client with gRPC.