跳到主要内容
跳到主要内容
编辑此页

MySQL 接口

ClickHouse 支持 MySQL 线协议。这允许某些没有原生 ClickHouse 连接器的客户端利用 MySQL 协议，并且已通过以下 BI 工具验证

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

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

如果有可用的原生驱动程序（例如，DBeaver），则始终首选使用它而不是 MySQL 接口。此外，虽然大多数 MySQL 语言客户端应该可以正常工作，但 MySQL 接口不能保证完全替代具有现有 MySQL 查询的代码库。

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

注意

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

在 ClickHouse Cloud 上启用 MySQL 接口​

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

Credentials screen - Prompt

  1. 将 Connect with 下拉菜单更改为 MySQL。

Credentials screen - Prompt

  1. 切换开关以为此特定服务启用 MySQL 接口。这将为此服务公开端口 3306，并提示您显示 MySQL 连接屏幕，其中包含您唯一的 MySQL 用户名。密码将与服务的默认用户密码相同。

Credentials screen - Enabled MySQL

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

Credentials screen - Connection String

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

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

因此，我们强烈建议在创建旨在与 MySQL 接口一起使用的新用户时，遵循 mysql4<子域名>_<用户名> 格式，其中 <子域名> 是用于标识您的 Cloud 服务的提示，而 <用户名> 是您选择的任意后缀。

提示

对于像 foobar.us-east1.aws.clickhouse.cloud 这样的 ClickHouse Cloud 主机名，<子域名> 部分等于 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<子域名>_<用户名>（见上文）。密码必须采用双 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;

  4. 使用创建的用户通过 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<子域名>_<用户名> 格式，如上文（上文）所述。

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

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

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

启动您的 ClickHouse 服务器，并查找类似于以下内容的日志消息，其中提到 Listening for MySQL compatibility protocol

{} <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 客户端兼容，建议在配置文件中使用 double 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;"