文档化档

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

手动下载和安装

  1. 下载influx CLI软件包。

    influx CLI v2.7.5 (macOS)

  2. 解包下载的软件包。

    执行以下操作之一

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

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

      # 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
    wget https://download.influxdata.com/influxdb/releases/influxdb2-client-2.7.5-linux-amd64.tar.gz
    
    # arm
    wget https://download.influxdata.com/influxdb/releases/influxdb2-client-2.7.5-linux-arm64.tar.gz
    
  2. 解包下载的软件包。

    注意:以下命令是示例。如有必要,请调整文件名、路径和实用工具。

    # 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
    
  3. (可选)将未解包的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命令。命令提示符不兼容。

  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 https://127.0.0.1:8086 \
  --org <your-org> \
  --token <your-auth-token> \
  --active

有关管理CLI配置的更多信息,请参阅 influx config 文档

凭据优先级

有三种方法向 influx CLI 提供必要的凭据,当检索凭据时,使用以下优先级

  1. 命令行标志(--host--org -o--token -t
  2. 环境变量(INFLUX_HOSTINFLUX_ORGINFLUX_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 命令行界面标志同时支持简写和长写形式。

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

命令可以在单个执行中使用简写和长写标志。

标志输入类型

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

字符串

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

字符串数组

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

整数

表示整数值的数字序列。

持续时间

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


这个页面有帮助吗?

感谢您的反馈!


Flux 的未来

Flux 将进入维护模式。您可以在不更改代码的情况下继续按当前方式使用它。

阅读更多

InfluxDB v3 增强功能和 InfluxDB 集群版现已全面上市

新功能包括更快的查询性能和管理工具,推动了 InfluxDB v3 产品线的进步。InfluxDB 集群版现已全面上市。

InfluxDB v3 性能和功能

InfluxDB v3 产品线在查询性能方面取得了显著提升,并提供了新的管理工具。这些增强功能包括一个操作仪表板,用于监控您的 InfluxDB 集群的健康状况,InfluxDB 云专用环境中的单点登录 (SSO) 支持,以及用于令牌和数据库的新管理 API。

了解 v3 的新增强功能


InfluxDB 集群版全面上市

InfluxDB 集群版现已全面上市,并为您提供了在自管理堆栈中使用 InfluxDB v3 的能力。

与我们讨论 InfluxDB 集群版