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

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 按钮。

Credentials screen - Prompt
  1. 将 Connect with 下拉菜单更改为 MySQL。

Credentials screen - MySQL selected
  1. 切换开关以为该特定服务启用 MySQL 接口。这将为该服务暴露端口 3306 并提示你输入包含唯一 MySQL 用户名的 MySQL 连接屏幕。密码将与服务的默认用户密码相同。

Credentials screen - Enabled MySQL

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

Credentials screen - Connection String

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

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

因此，我们 强烈建议 在创建用于 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 并且添加一个将在我们稍后与创建的用户连接时默认应用的额外设置：

    prefer_column_name_to_alias 仅作为示例，你可以在那里使用其他设置。

  2. 创建用户 使用以下格式：mysql4<subdomain>_<username> (见上文)。密码必须采用双 SHA1 格式。例如：

    或者如果你想为此用户使用自定义配置文件：

    其中 my_custom_profile 是你之前创建的配置文件的名称。

  3. 授予 新用户访问所需表或数据库的必要权限。例如，如果你只想授予访问 system.query_log 的权限：

  4. 使用创建的用户连接到你的 ClickHouse Cloud 服务通过 MySQL 接口。

解决 ClickHouse Cloud 中的多个 MySQL 用户问题​

如果你创建了一个新的 MySQL 用户，并且在通过 MySQL CLI 客户端连接时看到以下错误：

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

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

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

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

将 MySQL 连接到 ClickHouse​

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

例如：

连接成功时的输出：

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

限制：

  • 不支持预编译查询

  • 某些数据类型将作为字符串发送

要取消长查询，请使用 KILL QUERY connection_id 语句（在处理中被替换为 KILL QUERY WHERE query_id = connection_id）。例如：