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

MySQL 接口

ClickHouse 支持 MySQL 线协议。这使得某些没有原生 ClickHouse 连接器的客户端可以利用 MySQL 协议，该协议已与以下 BI 工具进行验证：

如果您正在尝试其他未测试的客户端或集成，请注意可能存在以下限制：

  • SSL 实现可能不完全兼容；可能存在潜在的 TLS SNI 问题。
  • 特定工具可能需要尚未实现的方言特性（例如，特定于 MySQL 的函数或设置）。

如果有原生驱动程序可用（例如， DBeaver），建议使用它而不是 MySQL 接口。此外，虽然大多数 MySQL 语言客户端应该能够正常工作，但 MySQL 接口并不能保证可以直接替代已有 MySQL 查询的代码库。

如果您的用例涉及没有原生 ClickHouse 驱动程序的特定工具，并且您希望通过 MySQL 接口使用它，并且发现某些不兼容的问题 - 请在 ClickHouse 仓库中 创建一个问题。

备注

为了更好地支持上述 BI 工具的 SQL 方言，ClickHouse 的 MySQL 接口隐式地运行使用设置 prefer_column_name_to_alias = 1 的 SELECT 查询。 这不能关闭，并且在极少数边缘情况下，可能导致发送到 ClickHouse 的普通查询接口和 MySQL 查询接口之间的行为不同。

在 ClickHouse Cloud 上启用 MySQL 接口​

  1. 创建 ClickHouse Cloud 服务后，点击 Connect 按钮。

凭据屏幕 - 提示
  1. 将 Connect with 下拉菜单更改为 MySQL。

凭据屏幕 - 选择 MySQL
  1. 切换开关以启用此特定服务的 MySQL 接口。这将为该服务开放端口 3306，并提示您查看包含您唯一 MySQL 用户名的 MySQL 连接屏幕。密码将与服务的默认用户密码相同。

凭据屏幕 - 已启用 MySQL

复制显示的 MySQL 连接字符串。

凭据屏幕 - 连接字符串

在 ClickHouse Cloud 中创建多个 MySQL 用户​

默认情况下，存在一个内置的 mysql4<subdomain> 用户，其密码与 default 用户相同。<subdomain> 部分是您 ClickHouse Cloud 主机名的第一个部分。此格式对于实现安全连接的工具是必要的，但这些工具在其 TLS 握手中并未提供 SNI 信息，这使得在没有用户名中的额外提示的情况下无法进行内部路由（MySQL 控制台客户端就是其中一种工具）。

因此，我们 强烈推荐 在创建新用户时遵循 mysql4<subdomain>_<username> 格式，此处 <subdomain> 是识别您的 Cloud 服务的提示，<username> 是您选择的任意后缀。

提示

对于 ClickHouse Cloud 主机名为 foobar.us-east1.aws.clickhouse.cloud 的情况，<subdomain> 部分等于 foobar，一个自定义 MySQL 用户名可以为 mysql4foobar_team1。

如果您需要应用额外设置，可以创建额外用户以供 MySQL 接口使用。

  1. 可选 - 创建一个 设置配置文件 以应用于您的自定义用户。例如，my_custom_profile 带有额外设置，当我们连接后面创建的用户时，默认应用：
CREATE SETTINGS PROFILE my_custom_profile SETTINGS prefer_column_name_to_alias=1;

prefer_column_name_to_alias 仅用作示例，您可以在此使用其他设置。 2. 创建用户 ，使用以下格式：mysql4<subdomain>_<username> (参见上面)。密码必须采用双 SHA1 格式。例如：

CREATE USER mysql4foobar_team1 IDENTIFIED WITH double_sha1_password BY 'YourPassword42$';

或者，如果您希望此用户使用自定义配置文件：

CREATE USER mysql4foobar_team1 IDENTIFIED WITH double_sha1_password BY 'YourPassword42$' SETTINGS PROFILE 'my_custom_profile';

其中 my_custom_profile 是您之前创建的配置文件的名称。 3. 授予 新用户与所需的表或数据库交互的必要权限。例如，如果您只想授予访问 system.query_log 的权限：

GRANT SELECT ON system.query_log TO mysql4foobar_team1;
  1. 使用创建的用户通过 MySQL 接口连接到您的 ClickHouse Cloud 服务。

故障排除 ClickHouse Cloud 中的多个 MySQL 用户​

如果您创建了新的 MySQL 用户，并且在使用 MySQL CLI 客户端连接时看到以下错误：

ERROR 2013 (HY000): Lost connection to MySQL server at 'reading authorization packet', system error: 54

在这种情况下，请确保用户名遵循 mysql4<subdomain>_<username> 格式，如（上面）所述。

在自管理 ClickHouse 上启用 MySQL 接口​

将 mysql_port 设置添加到服务器的配置文件中。例如，您可以在 config.d/ 文件夹 中定义一个新 XML 文件来指定端口：

<clickhouse>
    <mysql_port>9004</mysql_port>
</clickhouse>

启动您的 ClickHouse 服务器，并查找类似以下的日志消息，提到监听 MySQL 兼容协议：

{} <Information> Application: Listening for MySQL compatibility protocol: 127.0.0.1:9004

将 MySQL 连接到 ClickHouse​

以下命令演示了如何将 MySQL 客户端 mysql 连接到 ClickHouse：

mysql --protocol tcp -h [hostname] -u [username] -P [port_number] [database_name]

例如：

$ mysql --protocol tcp -h 127.0.0.1 -u default -P 9004 default

如果连接成功，输出将为：

Welcome to the MySQL monitor.  Commands end with ; or \g.
Your MySQL connection id is 4
Server version: 20.2.1.1-ClickHouse

Copyright (c) 2000, 2019, Oracle and/or its affiliates. All rights reserved.

Oracle is a registered trademark of Oracle Corporation and/or its
affiliates. Other names may be trademarks of their respective
owners.

Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.

mysql>

为了与所有 MySQL 客户端兼容，建议在配置文件中使用 双 SHA1 指定用户密码。 如果用户密码使用 SHA256 指定，则某些客户端将无法进行身份验证（mysqljs 和旧版本的命令行工具 MySQL 和 MariaDB）。

限制：

  • 不支持预处理查询

  • 某些数据类型以字符串形式发送

要取消长查询，请使用 KILL QUERY connection_id 语句（在执行时会替换为 KILL QUERY WHERE query_id = connection_id）。例如：

$ mysql --protocol tcp -h mysql_server -P 9004 default -u default --password=123 -e "KILL QUERY 123456;"