This is a community repository of Python code for InfluxDB with IOx. While this code is built on officially supported APIs, the library and CLI here are not officially support by Influx Data.
When installed, you have access to 2 pieces of functionality:
- A CLI for reading and writing data to InfluxDB with IOx.
- A client library for reading and writing data to InfluxDB with IOx.
To install only the client:
python3 -m pip install pyinflux3
To install the client and CLI:
sudo python3 -m pip install "pyinflux3[cli]"
*Note: Use sudo if you would like to directly install the client onto your path. Otherwise use the --user
flag.
You can drop a config file called config.json in the directory where you are running the influx3 command:
{
{
"my-config": {
"database": "your-database",
"host": "your-host",
"token": "your-token",
"org": "your-org-id",
"active": true
}
}
}
Or you can use the config command to create or modify a config:
% influx3 config --name="my-config" --database="<database or bucket name>" --host="us-east-1-1.aws.cloud2.influxdata.com" --token="<your token>" --org="<your org ID>"
If you are running against InfluxDB Cloud Serverless, then use the bucket name for the database in you configuration.
% influx3 sql "select * from anomalies"
% influx3 write testmes f=7
% influx3
Welcome to my IOx CLI.
(>) sql
(sql >) select * from anomalies
check id observed time type user_id value
0 1 None NaN 2023-02-03 20:56:57.513279776 error 1 400.0
1 1 None NaN 2023-02-03 17:52:54.328785835 latency 1 900.0
(>) write
testmes f=5 boring-observability
This project also includes a new client library that strives for utter simplicity. It includes 3 functions, a constuctor, write(), and read().