Tableau Online

Tableau Online может подключаться к ClickHouse Cloud или локальному развертыванию ClickHouse через интерфейс MySQL, используя официальный источник данных MySQL.

Настройка ClickHouse Cloud

Выберите Connect your app

После создания сервиса ClickHouse Cloud на экране Connect your app выберите MySQL из выпадающего списка.

Включите интерфейс MySQL

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

Или, чтобы включить интерфейс MySQL для уже существующего сервиса:

Выберите Connect

Убедитесь, что ваш сервис находится в состоянии Running, затем выберите сервис, для которого вы хотите включить интерфейс MySQL. Выберите Connect в левом меню:

Выберите MySQL

Выберите MySQL из выпадающего списка Connect With.

Включите интерфейс MySQL

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

Создание readonly-пользователя MySQL в ClickHouse Cloud

ClickHouse Cloud автоматически создает пользователя mysql4<subdomain>, который использует тот же пароль, что и пользователь по умолчанию. Часть <subdomain> соответствует первой части имени хоста вашего кластера ClickHouse Cloud.

Такой формат имени пользователя необходим для совместимости с инструментами, которые устанавливают защищенные соединения, но не включают данные SNI (Server Name Indication) в TLS-рукопожатие. Без информации SNI система не может выполнить корректную внутреннюю маршрутизацию, поэтому подсказка с поддоменом, встроенная в имя пользователя, предоставляет необходимую информацию для маршрутизации. Консольный клиент MySQL — пример инструмента, которому это требуется.

Совет

Рекомендуется создать нового readonly-пользователя MySQL.

Примечание

Для имени хоста ClickHouse Cloud вида foobar.us-east1.aws.clickhouse.cloud часть <subdomain> равна foobar, и произвольное имя пользователя MySQL может выглядеть как mysql4foobar_team1.

Создайте профиль настроек readonly

Создайте профиль настроек, который будет применяться к вашему readonly-пользователю, установив параметр readonly в значение 1:

CREATE SETTINGS PROFILE readonly_profile SETTINGS readonly = 1

Создайте нового readonly-пользователя MySQL

Создайте пользователя с именем в следующем формате:

mysql4<subdomain>_<username>

Примените readonly_profile к новому пользователю и убедитесь, что пароль задан в формате double SHA1. Например:

CREATE USER mysql4foobar_readonly
IDENTIFIED WITH double_sha1_password BY 'YourPassword42$'
SETTINGS PROFILE 'readonly_profile';

Выдайте новому пользователю права доступа к нужным таблицам

Выдайте новому пользователю необходимые права для работы с нужными таблицами или базами данных. Например, если вы хотите предоставить доступ только к system.query_log:

GRANT SELECT ON system.query_log TO mysql4foobar_readonly;

Примечание

Для readonly-пользователя убедитесь, что вы выдаете только права SELECT к таблицам, к которым хотите предоставить доступ.

Созданного пользователя можно использовать для подключения к вашему сервису ClickHouse Cloud через интерфейс MySQL.

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

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

ОШИБКА 2013 (HY000): Потеряно соединение с сервером MySQL при чтении пакета авторизации, системная ошибка: 54

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

Настройка сервера ClickHouse в локальной инфраструктуре

Обратитесь к официальной документации по настройке сервера ClickHouse с включенным интерфейсом MySQL.

Помимо добавления записи в конфигурационный файл сервера config.xml

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

также обязательно следует использовать Double SHA1 password encryption для пользователя, который будет работать через интерфейс MySQL.

Генерация случайного пароля с применением Double SHA1 в командной оболочке:

PASSWORD=$(base64 < /dev/urandom | head -c16); echo "$PASSWORD"; echo -n "$PASSWORD" | sha1sum | tr -d '-' | xxd -r -p | sha1sum | tr -d '-'

Результат должен выглядеть следующим образом:

LZOQYnqQN4L/T6L0
fbc958cc745a82188a51f30de69eebfc67c40ee4

Первая строка — сгенерированный пароль, а вторая строка — хеш, который можно использовать для настройки ClickHouse.

Ниже приведен пример конфигурации для mysql_user, использующей сгенерированный хеш:

/etc/clickhouse-server/users.d/mysql_user.xml

<users>
    <mysql_user>
        <password_double_sha1_hex>fbc958cc745a82188a51f30de69eebfc67c40ee4</password_double_sha1_hex>
        <networks>
            <ip>::/0</ip>
        </networks>
        <profile>default</profile>
        <quota>default</quota>
    </mysql_user>
</users>

Замените значение password_double_sha1_hex на сгенерированный вами двойной SHA1-хэш.

Также рекомендуется использовать use_mysql_types_in_show_columns, чтобы выводить исходные типы MySQL вместо типов ClickHouse в результатах запроса SHOW [FULL] COLUMNS, что позволяет BI-инструментам корректно анализировать схему базы данных при использовании MySQL-коннекторов.

Например:

/etc/clickhouse-server/users.d/mysql_user.xml

<profiles>
    <default>
        <use_mysql_types_in_show_columns>1</use_mysql_types_in_show_columns>
    </default>
</profiles>

или назначить его другому профилю вместо профиля по умолчанию.

Если у вас установлен клиент mysql, вы можете протестировать подключение из командной строки. Используя пример имени пользователя (mysql_user) и пароля (LZOQYnqQN4L/T6L0) из приведённого выше примера, команда в терминале будет следующей:

mysql --protocol tcp -h localhost -u mysql_user -P 9004 --password=LZOQYnqQN4L/T6L0

mysql> show databases;
+--------------------+
| name               |
+--------------------+
| INFORMATION_SCHEMA |
| default            |
| information_schema |
| system             |
+--------------------+
4 rows in set (0.00 sec)
Read 4 rows, 603.00 B in 0.00156 sec., 2564 rows/sec., 377.48 KiB/sec.

Наконец, настройте сервер ClickHouse на прослушивание нужных IP-адресов. Например, в config.xml раскомментируйте следующий фрагмент, чтобы сервер прослушивал все адреса:

<listen_host>::</listen_host> 

Подключение Tableau Online к ClickHouse (on-premise, без SSL)

Войдите в свою учетную запись Tableau Cloud и добавьте новый источник данных (Published Data Source).

Выберите «MySQL» из списка доступных коннекторов.

Укажите параметры подключения, собранные при настройке ClickHouse.

Tableau Online проанализирует базу данных и предоставит список доступных таблиц. Перетащите нужную таблицу на рабочую область справа. Дополнительно вы можете нажать «Update Now», чтобы просмотреть данные, а также при необходимости скорректировать определенные при анализе типы полей или их имена.

После этого останется лишь нажать «Publish As» в правом верхнем углу, и вы сможете использовать созданный набор данных в Tableau Online как обычно.

NB: если вы хотите использовать Tableau Online в сочетании с Tableau Desktop и делиться наборами данных ClickHouse между ними, убедитесь, что вы используете Tableau Desktop с тем же стандартным коннектором MySQL, следуя руководству по настройке, которое отображается здесь, если выбрать MySQL в выпадающем списке Data Source. Если у вас Mac на процессоре M1, ознакомьтесь с этой темой по устранению неполадок для обходного варианта установки драйвера.

Подключение Tableau Online к ClickHouse (облачное или локальное развертывание с SSL)

Так как невозможно указать SSL-сертификаты через мастер настройки подключения MySQL в Tableau Online, единственный способ — использовать Tableau Desktop для настройки подключения, а затем опубликовать его в Tableau Online. Однако этот процесс довольно простой.

Запустите Tableau Desktop на компьютере под управлением Windows или macOS и выберите "Connect" -> "To a Server" -> "MySQL". Скорее всего, сначала потребуется установить драйвер MySQL на ваш компьютер. Вы можете сделать это, следуя инструкции по установке, которая отображается здесь, если выбрать MySQL в выпадающем списке источников данных (Data Source). Если у вас Mac на базе M1, посмотрите эту тему по устранению неполадок для обходного решения по установке драйвера.

Примечание

В интерфейсе настройки подключения MySQL убедитесь, что опция "SSL" включена. SSL-сертификат ClickHouse Cloud подписан центром сертификации Let's Encrypt. Вы можете скачать этот корневой сертификат здесь.

Укажите учетные данные пользователя MySQL для вашего экземпляра ClickHouse Cloud и путь к скачанному корневому сертификату.

Выберите нужные таблицы как обычно (аналогично Tableau Online) и выберите "Server" -> "Publish Data Source" -> Tableau Cloud.

ВАЖНО: в параметрах "Authentication" необходимо выбрать "Embedded password".

Дополнительно включите опцию "Update workbook to use the published data source".

Наконец, нажмите "Publish", и ваш источник данных со встроенными учетными данными будет автоматически открыт в Tableau Online.

Известные ограничения (ClickHouse 23.11)

Все известные ограничения были устранены в ClickHouse 23.11. Если вы столкнётесь с другими проблемами совместимости, пожалуйста, свяжитесь с нами или создайте новый issue.