Python client library

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

  1. Install the InfluxDB Python library:

    1. pip install influxdb-client

  2. Ensure that InfluxDB is running. If running InfluxDB locally, visit http://localhost:8086. (If using InfluxDB Cloud, visit the URL of your InfluxDB Cloud UI. For example: https://us-west-2-1.aws.cloud2.influxdata.com.)

Write data to InfluxDB with Python

We are going to write some data in line protocol using the Python library.

  1. In your Python program, import the InfluxDB client library and use it to write data to InfluxDB.

    1. import influxdb_client
    2. from influxdb_client.client.write_api import SYNCHRONOUS

  2. Define a few variables with the name of your bucket, organization, and token.

    1. bucket = "<my-bucket>"
    2. org = "<my-org>"
    3. token = "<my-token>"
    4. # Store the URL of your InfluxDB instance
    5. url="http://localhost:8086"

  3. Instantiate the client. The InfluxDBClient object takes three named parameters: url, org, and token. Pass in the named parameters.

    1. client = influxdb_client.InfluxDBClient(
    2.    url=url,
    3.    token=token,
    4.    org=org
    5. )

    The InfluxDBClient object has a write_api method used for configuration.

  4. Instantiate a write client using the client object and the write_api method. Use the write_api method to configure the writer object.

    1. write_api = client.write_api(write_options=SYNCHRONOUS)

  5. 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, and record.

    1. p = influxdb_client.Point("my_measurement").tag("location", "Prague").field("temperature", 25.3)
    2. write_api.write(bucket=bucket, org=org, record=p)

Complete example write script

  1. import influxdb_client
  2. from influxdb_client.client.write_api import SYNCHRONOUS
  4. bucket = "<my-bucket>"
  5. org = "<my-org>"
  6. token = "<my-token>"
  7. # Store the URL of your InfluxDB instance
  8. url="http://localhost:8086"
  10. client = influxdb_client.InfluxDBClient(
  11.     url=url,
  12.     token=token,
  13.     org=org
  14. )
  16. write_api = client.write_api(write_options=SYNCHRONOUS)
  18. p = influxdb_client.Point("my_measurement").tag("location", "Prague").field("temperature", 25.3)
  19. write_api.write(bucket=bucket, org=org, record=p)

Query data from InfluxDB with Python

  1. Instantiate the query client.

    1. query_api = client.query_api()

  2. Create a Flux query, and then format it as a Python string.

    1. query = ' from(bucket:"my-bucket")\
    2. |> range(start: -10m)\
    3. |> filter(fn:(r) => r._measurement == "my_measurement")\
    4. |> filter(fn: (r) => r.location == "Prague")\
    5. |> filter(fn:(r) => r._field == "temperature" ) '

    The query client sends the Flux query to InfluxDB and returns a Flux object with a table structure.

  3. Pass the query() method two named parameters:org and query.

    1. result = query_api.query(org=org, query=query)

  4. Iterate through the tables and records in the Flux object.

    • Use the get_value() method to return values.
    • Use the get_field() method to return fields.
    1. results = []
    2. for table in result:
    3.   for record in table.records:
    4.     results.append((record.get_field(), record.get_value()))
    6. print(results)
    7. [(temperature, 25.3)]

The Flux object provides the following methods for accessing your data:

  • get_measurement(): Returns the measurement name of the record.
  • get_field(): Returns the field name.
  • get_value(): Returns the actual field value.
  • values: Returns a map of column values.
  • values.get("<your tag>"): Returns a value from the record for given column.
  • get_time(): Returns the time of the record.
  • get_start(): Returns the inclusive lower time bound of all records in the current table.
  • get_stop(): Returns the exclusive upper time bound of all records in the current table.

Complete example query script

  1. query_api = client.query_api()
  2. query = ‘ from(bucket:"my-bucket")\
  3. |> range(start: -10m)\
  4. |> filter(fn:(r) => r._measurement == "my_measurement")\
  5. |> filter(fn: (r) => r.location == "Prague")\
  6. |> filter(fn:(r) => r._field == "temperature" )‘
  7. result = query_api.query(org=org, query=query)
  8. results = []
  9. for table in result:
  10.     for record in table.records:
  11.         results.append((record.get_field(), record.get_value()))
  13. print(results)
  14. [(temperature, 25.3)]

For more information, see the Python client README on GitHub.