influx - InfluxDB 命令行界面
influx
命令行界面 (CLI) 包含用于管理 InfluxDB 许多方面的命令,包括存储桶、组织、用户、任务等。
InfluxDB OSS v2 和 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
手动下载并安装
下载
influx
CLI 包。解包下载的包。
执行以下操作之一
在 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
二进制文件- 尝试运行
influx
命令。 - 打开系统偏好设置,然后单击安全性与隐私。
- 在通用选项卡下,会显示一条关于
influx
被阻止的消息。 单击仍然打开。
- 尝试运行
下载 influx CLI 包。
从您的浏览器下载
influx CLI v2.7.5 (amd64) influx CLI v2.7.5 (arm)
从命令行下载
# amd64 curl -O \ https://dl.influxdata.com/influxdb/releases/influxdb2-client-2.7.5-linux-amd64.tar.gz
# arm curl -O \ https://dl.influxdata.com/influxdb/releases/influxdb2-client-2.7.5-linux-arm64.tar.gz \
解包下载的包。
注意:以下命令是示例。 如果需要,请调整文件名、路径和实用程序。
# amd64 tar xvzf influxdb2-client-2.7.5-linux-amd64.tar.gz
# arm tar xvzf influxdb2-client-2.7.5-linux-arm64.tar.gz
(可选)将解包的
influx
可执行文件放在您的系统$PATH
中。sudo cp ./influx /usr/local/bin/
如果您不将
influx
二进制文件移动到您的$PATH
中,请在可执行文件./
前面加上前缀以就地运行它。
对 Windows 使用 Powershell
使用 Powershell 运行 influx
CLI 命令。 命令提示符不完全兼容。
下载
influx
CLI 包。展开下载的存档。
将下载的存档展开到
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'
授予
influx
CLI 网络访问权限。首次使用
influx
CLI 时,Windows Defender 会显示以下消息Windows Defender 防火墙阻止了此应用的某些功能。
要授予
influx
CLI 所需的访问权限,请执行以下操作- 选择专用网络,例如我的家庭或工作网络。
- 单击允许访问。
提供所需的身份验证凭据
为了避免每次命令都传递您的 InfluxDB 主机、API 令牌和组织,请将它们存储在 influx
CLI 配置(config)中。 需要这些凭据的 influx
命令会自动从活动配置中检索这些凭据。
使用 influx config create
命令 创建 influx
CLI 配置并将其设置为活动状态
influx config create --config-name CONFIG_NAME \
--host-url http://localhost:8086 \
--org ORG_NAME \
--token API_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
)。
此页面是否对您有帮助?
感谢您的反馈!
支持和反馈
感谢您成为我们社区的一份子! 我们欢迎并鼓励您提供关于 InfluxDB 和此文档的反馈和错误报告。 要获得支持,请使用以下资源
拥有年度合同或支持合同的客户可以联系 InfluxData 支持。