关于

这是一个社区Python代码库，用于InfluxDB的IOx。虽然此代码基于官方支持的API构建，但此处提供的库和CLI并非由Influx Data官方支持。

安装后，您将有权访问以下两个功能

1. 一个用于读取和写入InfluxDB（具有IOx）的CLI。
2. 一个用于读取和写入InfluxDB（具有IOx）的客户端库。

安装

仅安装客户端

python3 -m pip install pyinflux3

安装客户端和CLI

sudo python3 -m pip install "pyinflux3[cli]"

*注意：如果您想直接将客户端安装到您的路径，请使用sudo。否则请使用--user标志。

添加配置

要配置pyinflux3和CLI，请执行以下操作之一

您可以在运行influx3命令的目录中放入名为config.json的配置文件

{
    "my-config": {
        "database": "your-database",
        "host": "your-host",
        "token": "your-token",
        "org": "your-org-id",
        "active": true
    }
}

• 使用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>"
  

如果您正在针对InfluxDB Cloud Serverless进行操作，请在配置中使用桶名称作为数据库名称。

作为命令运行

influx3 sql "select * from anomalies"

influx3 write testmes f=7 

交互式查询和写入

在您的终端中，输入以下命令

influx3

influx3显示(>)交互式提示并等待输入。

Welcome to my IOx CLI.

(>)

要查询，请在提示符处输入sql。

(>) sql

在(sql >)提示符处，输入您的查询语句

(sql >) select * from home

influx3 CLI以Markdown表格格式显示查询结果--例如

|     |   co |   hum | room        |   temp | time                          |
|----:|-----:|------:|:------------|-------:|:------------------------------|
|   0 |    0 |  35.9 | Kitchen     |   21   | 2023-03-09 08:00:00           |
|   1 |    0 |  35.9 | Kitchen     |   21   | 2023-03-09 08:00:50           |

要写入，请在(>)提示符处输入write。

(>) write

在 (写入 >) 提示符下，输入行协议数据。

(>) write 
home,room=kitchen temp=70.5,hum=80

要退出提示符，输入 exit。

从文件写入

InfluxDB CLI 和客户端库都支持从 CSV 文件写入。CSV 文件必须包含包含列名的标题行。必须有包含时间戳的列。以下是解析选项

• --file - CSV 文件的路径。
• --time - 包含时间戳的列的名称。
• --measurement - 将 CSV 数据存储在下面的测量名称。 (目前仅支持用户指定的字符串)
• --tags - (可选) 指定用作标签的列名数组。 (目前仅支持用户指定的字符串) 例如： --tags=host,region

influx3 write_csv --file ./Examples/example.csv --measurement table2 --time Date --tags host,region

客户端库

此项目还包括一个新的客户端库，力求极致简洁。它包括 3 个函数：构造函数、write() 和 read()。

贡献

如果您正在为 CLI 或客户端库开发新功能，请确保测试两者以检查破坏性更改。目前可以通过以下方法实现

python3 -m venv .venv
source .venv/bin/activate
chmod +x ./test/test-package.sh 
./test/test-package.sh 

每次您在代码中做出更改并希望重新测试时，只需再次运行脚本即可

./test/test-package.sh