InfluxDB Python Client (for InfluxDB 1.x)

Warnings

• breaking This `influxdb` library is *only* for InfluxDB 1.x. It is not compatible with InfluxDB 2.x or 3.x.
  Fix: For InfluxDB 2.x, use `pip install influxdb-client` and import `from influxdb_client import InfluxDBClient`. For InfluxDB 3.x, use `pip install influxdb3-python` and import `from influxdb_client_3 import InfluxDBClient`.
• deprecated The `influxdb` library for InfluxDB 1.x is in maintenance mode; new feature development has ceased.
  Fix: For new projects, consider migrating to InfluxDB 2.x or 3.x and using their respective client libraries (`influxdb-client` or `influxdb3-python`) to leverage active development and newer features.
• gotcha Authentication methods differ significantly between InfluxDB 1.x and 2.x/3.x.
  Fix: InfluxDB 1.x uses username/password for authentication (as seen in `InfluxDBClient(username, password)`). InfluxDB 2.x/3.x primarily use API tokens. Attempting to use a token with this 1.x client will likely fail authentication.
• gotcha Data organization and query languages are different across InfluxDB versions.
  Fix: InfluxDB 1.x uses `databases` and `retention policies` and queries primarily with `InfluxQL`. InfluxDB 2.x uses `buckets` and `organizations` and queries primarily with `Flux`. InfluxDB 3.x uses `databases` and can query with `SQL` or `InfluxQL` via Apache Arrow Flight. Ensure your code aligns with the specific InfluxDB server version and its terminology/query language.
• gotcha Default connection parameters might not match your InfluxDB setup, especially if running on Docker or a custom port.
  Fix: Explicitly define `host`, `port`, `username`, `password`, and `database` when initializing `InfluxDBClient`. Use environment variables or a configuration file for sensitive credentials.

Install

• pip install influxdb Install the library

Imports

• InfluxDBClient

  from influxdb import InfluxDBClient

  This library (`influxdb`) is for InfluxDB 1.x. The `influxdb_client` library is for InfluxDB 2.x and has a different API.
• DataFrameClient

  from influxdb import DataFrameClient

  For simplified interaction with Pandas DataFrames in InfluxDB 1.x.

Quickstart

This quickstart demonstrates how to connect to an InfluxDB 1.x instance, create a database if necessary, write data points using line protocol, and query the data back. Ensure your InfluxDB 1.x instance is running and accessible. Connection details can be provided via environment variables (INFLUXDB_HOST, INFLUXDB_PORT, INFLUXDB_USERNAME, INFLUXDB_PASSWORD, INFLUXDB_DATABASE).

import os
from influxdb import InfluxDBClient

# Configuration for InfluxDB 1.x
HOST = os.environ.get('INFLUXDB_HOST', 'localhost')
PORT = int(os.environ.get('INFLUXDB_PORT', 8086))
USER = os.environ.get('INFLUXDB_USERNAME', 'root')
PASSWORD = os.environ.get('INFLUXDB_PASSWORD', 'root')
DATABASE = os.environ.get('INFLUXDB_DATABASE', 'testdb')

client = InfluxDBClient(host=HOST, port=PORT, username=USER, password=PASSWORD)

try:
    # Create database if it doesn't exist
    databases = client.get_list_database()
    if {'name': DATABASE} not in databases:
        client.create_database(DATABASE)
        print(f"Database '{DATABASE}' created.")
    client.switch_database(DATABASE)

    # Prepare data points
    points = [
        {
            "measurement": "cpu_load_short",
            "tags": {
                "host": "server01",
                "region": "us-west"
            },
            "time": "2009-11-10T23:00:00Z",
            "fields": {
                "value": 0.64
            }
        },
        {
            "measurement": "cpu_load_short",
            "tags": {
                "host": "server02",
                "region": "us-east"
            },
            "time": "2009-11-10T23:00:00Z",
            "fields": {
                "value": 0.99
            }
        }
    ]

    # Write data points
    client.write_points(points)
    print("Data points written successfully.")

    # Query data
    results = client.query('SELECT value FROM cpu_load_short WHERE region = \'us-west\'')
    print("Query Results:")
    for item in results.get_points(measurement='cpu_load_short'):
        print(item)

except Exception as e:
    print(f"An error occurred: {e}")
finally:
    client.close()