文档文档

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

手动下载并安装

  1. 下载 influx CLI 包。

    influx CLI v2.7.5 (macOS)

  2. 解包下载的包。

    执行以下操作之一

    • Finder 中双击下载的包文件。

    • 在 macOS 命令提示符应用程序(例如 终端iTerm2)中运行以下命令

      # Unpackage contents to the current working directory
      tar zxvf ~/Downloads/influxdb2-client-2.7.5-darwin-amd64.tar.gz
      
  3. (可选)将二进制文件放在您的 $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 中,请在可执行文件 ./ 前面加上前缀以就地运行它。

  4. (macOS Catalina 及更高版本)授权 influx 二进制文件。

    macOS 要求下载的二进制文件由注册的 Apple 开发者签名。 当您首次尝试运行 influx 时,macOS 将阻止它运行。 要授权 influx 二进制文件

    1. 尝试运行 influx 命令。
    2. 打开系统偏好设置,然后单击安全性与隐私
    3. 通用选项卡下,会显示一条关于 influx 被阻止的消息。 单击仍然打开
  1. 下载 influx CLI 包。

    从您的浏览器命令行下载 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 \
    
  2. 解包下载的包。

    注意:以下命令是示例。 如果需要,请调整文件名、路径和实用程序。

    # amd64
    tar xvzf influxdb2-client-2.7.5-linux-amd64.tar.gz
    
    # arm
    tar xvzf influxdb2-client-2.7.5-linux-arm64.tar.gz
    
  3. (可选)将解包的 influx 可执行文件放在您的系统 $PATH 中。

    sudo cp ./influx /usr/local/bin/
    

    如果您不将 influx 二进制文件移动到您的 $PATH 中,请在可执行文件 ./ 前面加上前缀以就地运行它。

对 Windows 使用 Powershell

使用 Powershell 运行 influx CLI 命令。 命令提示符不完全兼容。

  1. 下载 influx CLI 包。

    influx CLI v2.7.5 (Windows)

  2. 展开下载的存档。

    将下载的存档展开到 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'
    
  3. 授予 influx CLI 网络访问权限。

    首次使用 influx CLI 时,Windows Defender 会显示以下消息

    Windows Defender 防火墙阻止了此应用的某些功能。

    要授予 influx CLI 所需的访问权限,请执行以下操作

    1. 选择专用网络,例如我的家庭或工作网络
    2. 单击允许访问

提供所需的身份验证凭据

为了避免每次命令都传递您的 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 在检索凭据时使用以下优先级

  1. 命令行标志 (--host, --org -o, --token -t)
  2. 环境变量 (INFLUX_HOST, INFLUX_ORG, INFLUX_TOKEN)
  3. CLI 配置文件

命令行标志覆盖环境变量,环境变量覆盖配置文件值。

用法

influx [flags]
influx [command]

命令

命令描述
apply应用 InfluxDB 模板
authAPI 令牌管理命令
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任务管理命令
telegrafsTelegraf 配置管理命令
template汇总和验证 InfluxDB 模板
user用户管理命令
v1使用 v1 兼容性 API
version打印 influx CLI 版本
write将点写入 InfluxDB

标志

标志描述
-h--helpinflux 命令的帮助

标志模式和约定

influx CLI 使用以下模式和约定

映射的环境变量

映射到环境变量的 influx CLI 标志在每个命令文档的映射到列中列出。 映射的标志继承环境变量的值。 要覆盖环境变量,请在您的命令中显式设置标志。

查看映射的环境变量

缩写和全写标志

许多 influx CLI 标志都支持缩写和全写形式。

  • 缩写: 缩写标志以单个连字符开头,后跟单个字母(例如:-c)。
  • 全写: 全写标志以两个连字符开头,后跟一个多字母、连字符分隔的标志名称(例如:--active-config)。

命令可以在单次执行中使用缩写和全写标志。

标志输入类型

influx CLI 标志输入类型在每个命令的标志表中列出。 标志支持以下输入类型

字符串

文本字符串,但每个命令执行只能使用一次标志。

字符串数组

单个文本字符串,但每个命令执行可以多次使用标志。

整数

表示整数值的数字序列。

持续时间

由整数和持续时间单位表示的时间长度(1ns1us1µs1ms1s1m1h1d1w)。


此页面是否对您有帮助?

感谢您的反馈!


Flux 的未来

Flux 即将进入维护模式。 您可以继续像目前一样使用它,而无需对您的代码进行任何更改。

阅读更多

现已正式发布

InfluxDB 3 Core 和 Enterprise

快速启动。 更快扩展。

获取更新

InfluxDB 3 Core 是一个开源、高速、近实时数据引擎,可实时收集和处理数据,并将其持久化到本地磁盘或对象存储。 InfluxDB 3 Enterprise 构建在 Core 的基础上,增加了高可用性、读取副本、增强的安全性以及数据压缩,以实现更快的查询和优化的存储。 InfluxDB 3 Enterprise 的免费层可供非商业家庭或业余爱好者使用。

有关更多信息,请查看