文档中心

ByteHouse云数仓版

使用 CLI 工具

ClickHouse Client

ClickHouse Client 是 ClickHouse 开源社区提供的命令行客户端，可以和 ByteHouse 云数仓版数据库进行完整的命令行交互。本文将介绍如何使用 ClickHouse Client 连接到 ByteHouse 云数仓版数据库。

前提条件

已创建 ByteHouse 云数仓版数据库。
已设置并获取 ByteHouse 云数仓版集群密码，操作详情请参见获取账号与密码。
下载并安装 ClickHouse Client 工具：您可参考 ClickHouse 社区提供的安装方式，详情请参见安装 ClickHouse Client。
网络已打通：安装 ClickHouse Client 工具的机器必须能访问 ByteHouse 网关地址及对应 TCP 端口。

操作步骤

执行连接命令群。
连接语句基本语法说明如下：

clickhouse-client \
  --host <BYTEHOUSE_HOST> \  # ByteHouse 云数仓版连接地址
  --port <BYTEHOUSE_PORT> \  # ByteHouse 云数仓版连接端口
  --user <BYTEHOUSE_USER> \  # ByteHouse 云数仓版用户名
  --password \  
  --database <DATABASE_NAME>  #数据库名称

执行命令后根据提示输入密码。

参数说明

ClickHouse Client 使用的主要参数如下表，其他参数可参考官方文档 ClickHouse 客户端。

参数	说明
-C，--config-file	指定客户端使用的配置文件。需填写完整理解，如：`/etc/clickhouse-client/config.xml`。
-h，--host	指定 ByteHouse 服务端的 IP 地址。
--port	指定 ByteHouse 服务端的端口地址。
-u，--user	指定登录 ByteHouse 服务端的用户名。
--password	指定登录用户名对应的密码。
-d，--database	指定链接后默认使用的数据库名称。若不指定，默认进入 default 数据库。
-V，--version	查看当前 ByteHouse 客户端的版本信息。
-E，--vertical	将查询结果按照垂直格式显示。
-q，--query	非交互模式下传入的 SQL 语句。非交互模式下直接执行指定的 SQL 语句（示例：`clickhouse-client -q "SELECT * FROM test_table LIMIT 10"`）。
-t，--time	非交互模式下执行 SQL 后，显示语句的执行耗时。
--log-level	设置客户端日志的级别。
--send_logs_level	指定服务端返回日志数据的级别。
--server_logs_file	指定服务端日志保存路径，例如：`/tmp/server.log`。

最近更新时间：2026.06.16 17:22:22

这个页面对您有帮助吗？

有用

无用