Перейти к основному содержимому
Перейти к основному содержимому

Интерфейс MySQL

ClickHouse поддерживает протокол MySQL. Это позволяет определенным клиентам, которые не имеют нативных соединителей ClickHouse, использовать протокол MySQL вместо этого, и он был проверен с помощью следующих BI инструментов:

Если вы используете другие непроверенные клиенты или интеграции, имейте в виду, что могут быть следующие ограничения:

  • Реализация SSL может быть не полностью совместима; могут возникнуть потенциальные проблемы с TLS SNI.
  • Определенный инструмент может требовать функций диалекта (например, специфичных для MySQL функций или настроек), которые еще не реализованы.

Если доступен нативный драйвер (например, DBeaver), всегда предпочтительно использовать его вместо интерфейса MySQL. Кроме того, хотя большинство клиентов языка MySQL должны работать нормально, интерфейс MySQL не гарантирует, что он будет полностью совместим с кодовой базой, в которой уже существуют запросы MySQL.

Если ваш сценарий использования включает определенный инструмент, у которого нет нативного драйвера ClickHouse, и вы хотите использовать его через интерфейс MySQL и обнаружили определенные несовместимости - пожалуйста, создайте задачу в репозитории ClickHouse.

примечание

Чтобы лучше поддерживать SQL диалект вышеуказанных BI инструментов, интерфейс MySQL ClickHouse неявно выполняет SELECT запросы с настройкой prefer_column_name_to_alias = 1. Эту настройку нельзя отключить, и это может привести в редких случаях к различному поведению между запросами, отправляемыми в обычный интерфейс запросов ClickHouse и интерфейс запросов MySQL.

Включение интерфейса MySQL в ClickHouse Cloud​

  1. После создания вашего сервиса ClickHouse Cloud нажмите кнопку Connect.

Экран учетных данных - Подсказка
  1. Измените выпадающий список Connect with на MySQL.

Экран учетных данных - Выбран MySQL
  1. Переключите переключатель, чтобы включить интерфейс MySQL для этого конкретного сервиса. Это откроет порт 3306 для этого сервиса и предложит вам экран подключения MySQL, который включает ваше уникальное имя пользователя MySQL. Пароль будет таким же, как и пароль по умолчанию для сервиса.

Экран учетных данных - Включен MySQL

Скопируйте строку подключения MySQL, показанную ниже.

Экран учетных данных - Строка подключения

Создание нескольких пользователей MySQL в ClickHouse Cloud​

По умолчанию существует встроенный пользователь mysql4<subdomain>, который использует тот же пароль, что и default. Часть <subdomain> - это первый сегмент вашего имени хоста ClickHouse Cloud. Этот формат необходим для работы с инструментами, которые реализуют защищенное соединение, но не предоставляют информацию SNI в своих TLS рукопожатиях, что делает невозможным внутреннюю маршрутизацию без дополнительного указания в имени пользователя (клиент MySQL консоли - один из таких инструментов).

Из-за этого мы настоятельно рекомендуем следовать формату mysql4<subdomain>_<username> при создании нового пользователя, предназначенного для использования с интерфейсом MySQL, где <subdomain> является подсказкой для идентификации вашего облачного сервиса, а <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. Используйте созданного пользователя для подключения к вашему сервису ClickHouse Cloud с помощью интерфейса MySQL.

Устранение неполадок с несколькими пользователями MySQL в ClickHouse Cloud​

Если вы создали нового пользователя MySQL и видите следующую ошибку при попытке подключения через клиент MySQL CLI:

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

В этом случае убедитесь, что имя пользователя соответствует формату mysql4<subdomain>_<username>, как описано (выше).

Включение интерфейса MySQL на самоуправляемом ClickHouse​

Добавьте настройку mysql_port в файл конфигурации вашего сервера. Например, вы можете определить порт в новом XML файле в вашей папке config.d/:

<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;"