influx - InfluxDB 命令行接口
该 influx 命令行界面 (CLI) 包含用于管理 InfluxDB 的许多方面的命令,包括存储桶、组织、用户、任务等。
InfluxDB OSS 和 influx CLI 版本
从 InfluxDB 2.1 开始,influx CLI 被单独打包和版本控制,和 InfluxDB 分开。InfluxDB 和 influx CLI 的版本可能不同,但每个命令的兼容性都有说明。
下载并安装 influx CLI
执行以下操作之一:
使用 Homebrew
brew install influxdb-cli
如果您使用 Homebrew 安装了 InfluxDB 2.7,则 influxdb-cli
公式作为依赖项下载并应已安装。
如果已安装,influxdb-cli 将出现在以下命令的输出中:
brew list | grep influxdb-cli
手动下载和安装
下载
influxCLI 包。解压下载的包。
执行以下操作之一:
在Finder中双击下载的包文件。
在macOS命令提示应用程序中运行以下命令,例如终端或iTerm2:
# Unpackage contents to the current working directory tar zxvf ~/Downloads/influxdb2-client-2.7.5-darwin-amd64.tar.gz
(可选) 将二进制文件放入你的
$PATH中。# (Optional) Copy the influx binary to your $PATH sudo cp ~/Downloads/influxdb2-client-2.7.5-darwin-amd64/influx /usr/local/bin/如果您不将
influx二进制文件移动到您的$PATH中,请在可执行文件前加上./在当前位置运行它。(macOS Catalina 和更新版本) 授权
influx二进制文件。macOS要求下载的二进制文件必须由注册的Apple开发者签名。 当您第一次尝试运行
influx时,macOS会阻止它运行。 要授权influx二进制文件:- Attempt to run an
influxcommand. - Open System Preferences and click Security & Privacy.
- Under the General tab, there is a message about
influxbeing blocked. Click Open Anyway.
- Attempt to run an
下载 influx CLI 包。
下载
influxCLI 包 通过你的浏览器 或 通过命令行。从您的浏览器下载
influx CLI v2.7.5 (amd64) influx CLI v2.7.5 (arm)
从命令行下载
# amd64 wget https://dl.influxdata.com/influxdb/releases/influxdb2-client-2.7.5-linux-amd64.tar.gz # arm wget https://dl.influxdata.com/influxdb/releases/influxdb2-client-2.7.5-linux-arm64.tar.gz解压下载的包。
注意: 以下命令为示例。如有必要,请调整文件名、路径和工具。
# amd64 tar xvzf path/to/influxdb2-client-2.7.5-linux-amd64.tar.gz # arm tar xvzf path/to/influxdb2-client-2.7.5-linux-arm64.tar.gz(可选) 将未打包的
influx可执行文件放入您的系统$PATH。# amd64 sudo cp influxdb2-client-2.7.5-linux-amd64/influx /usr/local/bin/ # arm sudo cp influxdb2-client-2.7.5-linux-arm64/influx /usr/local/bin/如果您不将
influx二进制文件移动到您的$PATH中,请在可执行文件前面加上./以在当前位置运行它。
我们推荐在 Powershell 中运行 influx CLI 命令。命令提示符不完全兼容。
下载
influxCLI 包。解压下载的压缩文件。
将下载的压缩包解压到
C:\Program Files\InfluxData\并根据需要重命名。> Expand-Archive .\influxdb2-client-2.7.5-windows-amd64.zip -DestinationPath 'C:\Program Files\InfluxData\' > mv 'C:\Program Files\InfluxData\influxdb2-client-2.7.5-windows-amd64' 'C:\Program Files\InfluxData\influx'授予
influxCLI 网络访问权限。当首次使用
influxCLI 时, Windows Defender 显示以下消息:Windows Defender 防火墙阻止了此应用程序的某些功能。
要授予
influxCLI 所需的访问权限,请执行以下操作:- Select Private networks, such as my home or work network.
- Click Allow access.
提供所需的认证凭据
为了避免每个命令都需要传递您的 InfluxDB 主机、API 令牌 和 组织,请将它们存储在 influx CLI 配置 (config) 中。需要这些凭据的 influx 命令会自动从活动配置中检索这些凭据。
使用influx config create命令创建一个influx CLI配置并将其设置为活动状态:
influx config create --config-name <config-name> \
--host-url http://localhost:8086 \
--org <your-org> \
--token <your-auth-token> \
--active
有关管理CLI配置的更多信息,请参阅
influx config 文档。
凭证优先级
有三种方法可以向 influx CLI 提供必要的凭据,在检索凭据时遵循以下优先顺序:
- 命令行标志 (
--host,--org -o,--token -t) - 环境变量 (
INFLUX_HOST,INFLUX_ORG,INFLUX_TOKEN) - CLI 配置文件
用法
influx [flags]
influx [command]
命令
| 命令 | 描述 |
|---|---|
| apply | 应用一个InfluxDB模板 |
| auth | API令牌管理命令 |
| backup | 备份数据 (仅适用于 InfluxDB OSS) |
| bucket | 桶管理命令 |
| bucket-schema | 管理 InfluxDB 存储桶模式 (仅限 InfluxDB Cloud) |
| completion | 生成完成脚本 |
| config | 配置管理命令 |
| dashboards | 列出仪表板 |
| delete | 从InfluxDB中删除点 |
| export | 将资源导出为模板 |
| help | 任何命令的帮助 |
| org | 组织管理命令 |
| ping | 检查 InfluxDB /health 端点 |
| query | 执行一个 Flux 查询 |
| restore | 恢复备份数据 (仅限 InfluxDB OSS) |
| scripts | 脚本管理命令 (仅限 InfluxDB Cloud) |
| secret | 管理机密 |
| setup | 创建默认用户名、密码、组织、桶等。 (仅限 InfluxDB OSS) |
| stacks | 管理 InfluxDB 堆栈 |
| task | 任务管理命令 |
| telegrafs | Telegraf 配置管理命令 |
| template | 总结和验证一个InfluxDB模板 |
| user | 用户管理命令 |
| v1 | 使用v1兼容API |
| version | 打印 influx CLI 版本 |
| write | 将数据写入InfluxDB |
标志
| 标志 | 描述 | |
|---|---|---|
-h | --help | 关于 influx 命令的帮助 |
标志模式和约定
influx CLI 使用以下模式和约定:
映射的环境变量
influx CLI 标志映射到环境变量的列表在每个命令文档的 映射到 列的标志表中。映射标志继承环境变量的值。要覆盖环境变量,请在您的命令中显式设置标志。
简写和长写标志
许多 influx CLI 标志支持简写和全名形式。
- 速记: 一个速记标志以一个单一的连字符开头,后面跟着一个字母(例如:
-c)。 - 长形式: 长形式标志以两个连字符开头,后跟一个多个字母的,
以连字符分隔的标志名称(例如:
--active-config)。
命令可以在单次执行中同时使用简写和长写标志。
标志输入类型
influx CLI 标志输入类型在每个命令的标志表中列出。
标志支持以下输入类型:
字符串
文本字符串,但标志只能在每次命令执行中使用一次。
字符串数组
单个文本字符串,但标记可以在每次命令执行中 多次使用.
整数
表示整数值的数字序列。
持续时间
由整数和持续时间单位表示的时间长度 (1ns, 1us, 1µs, 1ms, 1s, 1m, 1h, 1d, 1w).