跳到主要内容
跳到主要内容

ClickHouse 客户端

ClickHouse 提供了一个原生的命令行客户端,可以直接在 ClickHouse 服务器上执行 SQL 查询。它支持交互模式(用于实时查询执行)和批处理模式(用于脚本和自动化)。查询结果可以在终端中显示或导出到文件,并支持所有 ClickHouse 输出 格式,如 Pretty、CSV、JSON 等等。

该客户端提供了关于查询执行的实时反馈,包括进度条、读取的行数、处理的字节数和查询执行时间。它支持 命令行选项配置文件

安装

要下载 ClickHouse,请运行:

要同时安装它,请运行:

有关更多安装选项,请参见 安装 ClickHouse

不同的客户端和服务器版本彼此之间是兼容的,但某些功能可能在旧的客户端中不可用。我们建议客户端和服务器使用相同版本。

运行

备注

如果你只是下载了 ClickHouse,但没有安装,请使用 ./clickhouse client 而不是 clickhouse-client

要连接到 ClickHouse 服务器,请运行:

根据需要指定其他连接细节:

--port <port> - ClickHouse 服务器接受连接的端口。默认端口为 9440 (TLS) 和 9000 (无 TLS)。注意,ClickHouse 客户端使用的是原生协议而不是 HTTP(S)。

-s [ --secure ] - 是否使用 TLS(通常自动检测)。

-u [ --user ] <username> - 作为哪个数据库用户进行连接。默认以 default 用户连接。

--password <password> - 数据库用户的密码。你也可以在配置文件中指定连接的密码。如果不指定密码,客户端会要求输入。

-c [ --config ] <path-to-file> - ClickHouse 客户端配置文件的路径,如果它不在默认位置之一。请参见 配置文件

--connection <name> - 来自配置文件的预配置连接详情的名称。

有关命令行选项的完整列表,请参见 命令行选项

连接 ClickHouse Cloud

您的 ClickHouse Cloud 服务的详细信息可以在 ClickHouse Cloud 控制台中找到。选择要连接的服务,然后单击 连接



选择 Native,详细信息将显示,并带有示例 clickhouse-client 命令:

将连接存储在配置文件中

你可以在一个 配置文件 中存储一个或多个 ClickHouse 服务器的连接详情。

格式如下:

有关更多信息,请参见 配置文件部分

备注

为了集中注意力于查询语法,其他示例省略了连接细节(--host--port 等)。记得在使用命令时添加它们。

批处理模式

你可以在批处理模式下运行 ClickHouse 客户端,而不是交互模式。

你可以这样指定一个单一查询:

你还可以使用 --query 命令行选项:

你可以在 stdin 上提供查询:

插入数据:

当指定了 --query 时,用户输入的任何内容都会在换行后附加到请求中。

将 CSV 文件插入远程 ClickHouse 服务

此示例将样本数据集 CSV 文件 cell_towers.csv 插入到 default 数据库中的现有表 cell_towers 中:

更多插入数据的示例

注意事项

在交互模式下,默认输出格式为 PrettyCompact。你可以在查询的 FORMAT 子句中更改格式或通过指定 --format 命令行选项进行更改。要使用垂直格式,可以使用 --vertical 或在查询末尾指定 \G。在此格式中,每个值都会打印在单独的一行上,适合显示宽表。

在批处理模式下,默认数据 格式TabSeparated。你可以在查询的 FORMAT 子句中设置格式。

在交互模式下,默认情况下,按下 Enter 键会运行输入的内容。在查询末尾不需要分号。

你可以使用 -m, --multiline 参数来启动客户端。要输入多行查询,在换行符之前输入反斜杠 \。按下 Enter 后,系统会要求你输入查询的下一行。要运行查询,请在结束时加上分号并按 Enter

ClickHouse 客户端基于 replxx(类似于 readline),因此它使用熟悉的键盘快捷方式并保持历史记录。历史记录默认写入 ~/.clickhouse-client-history

要退出客户端,按 Ctrl+D,或者输入以下任意内容代替查询:exitquitlogoutexit;quit;logout;qQ:q

在处理查询时,客户端显示:

  1. 进度,默认情况下每秒更新不超过 10 次。对于快速查询,进度可能没有时间显示。
  2. 解析后的格式化查询,供调试使用。
  3. 以指定格式显示结果。
  4. 结果中的行数、经过的时间以及查询处理的平均速度。所有数据量均指未压缩的数据。

你可以通过按 Ctrl+C 取消长查询。然而,你仍需稍等才能让服务器中止请求。在某些阶段无法取消查询。如果你不等待并第二次按下 Ctrl+C,客户端将退出。

ClickHouse 客户端允许传递外部数据(外部临时表)进行查询。有关更多信息,请参见 查询处理的外部数据 部分。

带参数的查询

你可以在查询中指定参数,并通过命令行选项传递值。这避免了在客户端侧用特定动态值格式化查询。例如:

也可以在交互会话中设置参数:

查询语法

在查询中,将想要用命令行参数填充的值放在大括号内,格式如下:

  • name — 占位符标识符。对应的命令行选项为 --param_<name> = value
  • data type数据类型 的参数。例如,像 (integer, ('string', integer)) 这样的数据结构可以具有 Tuple(UInt8, Tuple(String, UInt8)) 数据类型(你也可以使用其他 integer 类型)。也可以作为参数传递表名、数据库名和列名,在这种情况下,你需要使用 Identifier 作为数据类型。

示例

别名

  • \l - SHOW DATABASES
  • \d - SHOW TABLES
  • \c <DATABASE> - USE DATABASE
  • . - 重复上一个查询

键盘快捷方式

  • Alt (Option) + Shift + e - 打开带有当前查询的编辑器。可以使用环境变量 EDITOR 指定要使用的编辑器。默认情况下使用 vim
  • Alt (Option) + # - 注释行。
  • Ctrl + r - 模糊历史搜索。

可用快捷键的完整列表可以在 replxx 查看。

提示

要配置在 MacOS 上的元键(Option)正确工作:

iTerm2:前往偏好设置 -> 文件 -> 键 -> 左 Option 键,点击 Esc+

连接字符串

ClickHouse 客户端可以通过类似 MongoDBPostgreSQLMySQL 的连接字符串连接到 ClickHouse 服务器。它的语法如下:

组件

  • user - (可选)数据库用户名。默认值:default
  • password - (可选)数据库用户密码。如果指定了 : 并且密码为空,客户端将提示输入用户的密码。
  • hosts_and_ports - (可选)主机和可选端口的列表 host[:port] [, host:[port]], ...。默认值:localhost:9000
  • database - (可选)数据库名称。默认值:default
  • query_parameters - (可选)键值对列表 param1=value1[,&param2=value2], ...。对于某些参数,不需要值。参数名称和值区分大小写。

如果在连接字符串中指定了用户名、密码或数据库,则不能使用 --user--password--database(反之亦然)进行指定。

主机组件可以是主机名或 IPv4 或 IPv6 地址。IPv6 地址应放在方括号中:

连接字符串可以包含多个主机。ClickHouse 客户端将按顺序尝试连接这些主机(从左到右)。建立连接后,不会尝试连接剩余的主机。

连接字符串必须作为 clickHouse-client 的第一个参数指定。连接字符串可以与其他任意 命令行选项 结合使用,但不包括 --host--port

允许以下键用于 query_parameters

  • secure 或简写 s。如果指定,则客户端将通过安全连接(TLS)连接到服务器。请参见 命令行选项 中的 --secure

百分比编码

userpasswordhostsdatabasequery parameters 中的非美国 ASCII 字符、空格和特殊字符必须 进行百分比编码

示例

连接到 localhost 的 9000 端口并执行查询 SELECT 1

连接到 localhost,作为用户 john,密码为 secret,主机为 127.0.0.1,端口为 9000

作为 default 用户连接到 localhost,主机为 IPV6 地址 [::1],端口为 9000

在多行模式下连接到 localhost 的 9000 端口。

作为用户 default 连接到 localhost,使用 9000 端口。

连接到 localhost 的 9000 端口,并默认使用连接字符串中指定的 my_database 数据库。

连接到 localhost 的 9000 端口,默认使用连接字符串中指定的 my_database 数据库,并使用简写的 s 参数进行安全连接。

使用默认主机、默认端口、默认用户和默认数据库连接。

使用默认主机、默认端口,以用户 my_user 连接且密码为空。

使用电子邮件作为用户名连接到 localhost@ 符号将被百分比编码为 %40

连接到两个主机中的一个:192.168.1.15192.168.1.25

查询 ID 格式

在交互模式下,ClickHouse 客户端为每个查询显示查询 ID。默认情况下,ID 格式如下:

可以在配置文件中使用 query_id_formats 标签指定自定义格式。格式字符串中的 {query_id} 占位符会被查询 ID 替换。该标签内允许多个格式字符串。这一功能可用于生成 URL,以便利查询的分析。

示例

根据上述配置,查询的 ID 以以下格式显示:

配置文件

ClickHouse 客户端使用以下第一个存在的文件:

  • 使用 -c [ -C, --config, --config-file ] <path-to-file> 参数定义的文件。
  • ./clickhouse-client.[xml|yaml|yml]
  • ~/.clickhouse-client/config.[xml|yaml|yml]
  • /etc/clickhouse-client/config.[xml|yaml|yml]

在 ClickHouse 仓库中查看示例配置文件:clickhouse-client.xml

示例 XML 语法:

相同的配置在 YAML 格式中:

命令行选项

所有命令行选项可以直接在命令行中指定,也可以作为默认值在 配置文件 中指定。

通用选项

-c [ -C, --config, --config-file ] <path-to-file>

如果配置文件不在默认位置之一,则客户端配置文件的位置。请参见 配置文件

--help

打印用法摘要并退出。与 --verbose 结合使用以显示所有可能的选项,包括查询设置。

--history_file <path-to-file>

历史记录文件的路径。

--history_max_entries

历史文件中条目的最大数量。

默认值:1000000(100 万)

--prompt <prompt>

指定自定义提示符。

默认值:服务器的 display_name

--verbose

增加输出详细程度。

-V [ --version ]

打印版本并退出。

连接选项

--connection <name>

来自配置文件的预配置连接详情的名称。请参见 连接凭据

-d [ --database ] <database>

选择此连接的默认数据库。

默认值:来自服务器设置的当前数据库(默认值为 default)。

-h [ --host ] <host>

要连接的 ClickHouse 服务器的主机名。可以是主机名或 IPv4 或 IPv6 地址。可以通过多个参数传递多个主机。

默认值:localhost

--jwt <value>

使用 JSON Web 令牌 (JWT) 进行身份验证。

服务器 JWT 授权仅在 ClickHouse Cloud 中可用。

--no-warnings

禁用在客户端连接到服务器时从 system.warnings 显示警告。

--password <password>

数据库用户的密码。你也可以在配置文件中指定连接的密码。如果不指定密码,客户端会要求输入。

--port <port>

服务器接受连接的端口。默认端口为 9440(TLS)和 9000(无 TLS)。

注意:客户端使用原生协议而不是 HTTP(S)。

默认值:如果指定了 --secure 则为 9440,否则为 9000。如果主机名以 .clickhouse.cloud 结尾,则始终默认为 9440。

-s [ --secure ]

是否使用 TLS。

当连接到 9440 端口(默认安全端口)或 ClickHouse Cloud 时,自动启用。

你可能需要在 配置文件 中配置 CA 证书。可用的配置设置与 服务器端 TLS 配置 的设置相同。

--ssh-key-file <path-to-file>

包含SSH私钥的文件,用于与服务器进行身份验证。

--ssh-key-passphrase <value>

指定的 --ssh-key-file 的 SSH 私钥密码。

-u [ --user ] <username>

要连接的数据库用户。

默认值:default

除了 --host--port--user--password 选项外,客户端还支持 连接字符串

查询选项

--param_<name>=<value>

带参数的查询 的参数的替代值。

-q [ --query ] <query>

要在批处理模式下运行的查询。可以多次指定(--query "SELECT 1" --query "SELECT 2")或者一次指定多个分号分隔的查询(--query "SELECT 1; SELECT 2;")。在后一种情况下,格式为 VALUESINSERT 查询必须由空行分隔。

也可以指定不带参数的单个查询:

不能与 --queries-file 一起使用。

--queries-file <path-to-file>

包含查询的文件的路径。可以多次指定 --queries-file,例如 --queries-file queries1.sql --queries-file queries2.sql

不能与 --query 一起使用。

-m [ --multiline ]

如果指定,允许多行查询(不在 Enter 时发送查询)。查询将仅在以分号结束时发送。

查询设置

查询设置可以在客户端中作为命令行选项指定,例如:

有关设置的列表,请参见 设置

格式选项

-f [ --format ] <format>

使用指定的格式输出结果。

有关支持格式的列表,请参见 输入和输出数据的格式

默认值:TabSeparated

--pager <command>

将所有输出通过此命令传递。通常为 less(例如,less -S 用于显示宽结果集)或类似命令。

-E [ --vertical ]

使用 垂直格式 输出结果。这与 --format Vertical 相同。在此格式中,每个值都会打印在单独的一行上,这在显示宽表时非常有用。

执行细节

--enable-progress-table-toggle

通过按控制键(空格)启用切换进度表。仅适用于启用进度表打印的交互模式。

默认值:启用

--hardware-utilization

在进度条中打印硬件利用率信息。

--memory-usage

如果指定,在非交互模式下将内存使用情况打印到 stderr

可能值:

  • none - 不打印内存使用情况
  • default - 打印字节数
  • readable - 以人类可读的格式打印内存使用情况

--print-profile-events

打印 ProfileEvents 数据包。

--progress

打印查询执行的进度。

可能值:

  • tty|on|1|true|yes - 在交互模式下输出到终端
  • err - 在非交互模式下输出到 stderr
  • off|0|false|no - 禁用进度打印

默认值:在交互模式下为 tty,在非交互(批处理)模式下为 off

--progress-table

打印在查询执行期间变化的度量进度表。

可能值:

  • tty|on|1|true|yes - 在交互模式下输出到终端
  • err - 在非交互模式下输出到 stderr
  • off|0|false|no - 禁用进度表

默认值:在交互模式下为 tty,在非交互(批处理)模式下为 off

--stacktrace

打印异常的堆栈跟踪。

-t [ --time ]

在非交互模式下将查询执行时间打印到 stderr(用于基准测试)。