O ClickHouse oferece suporte ao MySQL wire protocol. Isso permite que determinados clientes que não têm conectores nativos do ClickHouse usem o protocolo MySQL, e essa compatibilidade foi validada com as seguintes ferramentas de BI:
Se você estiver tentando usar outros clientes ou integrações ainda não testados, tenha em mente que pode haver as seguintes limitações:
- A implementação de SSL talvez não seja totalmente compatível; pode haver problemas com TLS SNI.
- Uma ferramenta específica pode exigir recursos do dialeto (por exemplo, funções ou configurações específicas do MySQL) que ainda não foram implementados.
Se houver um driver nativo disponível (por exemplo, DBeaver), é sempre preferível usá-lo em vez da interface MySQL. Além disso, embora a maioria dos clientes MySQL para linguagens de programação deva funcionar bem, não há garantia de que a interface MySQL seja uma substituição direta para uma base de código com consultas MySQL existentes.
Se o seu caso de uso envolver uma ferramenta específica que não tenha um driver nativo do ClickHouse, e você quiser usá-la por meio da interface MySQL e tiver encontrado incompatibilidades, crie uma issue no repositório do ClickHouse.
::::note
Para oferecer melhor suporte ao dialeto SQL das ferramentas de BI acima, a interface MySQL do ClickHouse executa implicitamente consultas SELECT com a configuração prefer_column_name_to_alias = 1.
Isso não pode ser desativado e, em raros casos de borda, pode levar a um comportamento diferente entre as consultas enviadas às interfaces de consulta padrão e MySQL do ClickHouse.
::::
Habilitando a interface MySQL no ClickHouse Cloud
- Depois de criar seu serviço no ClickHouse Cloud, clique no botão
Connect.
- Altere o menu suspenso
Connect with para MySQL.
- Ative o botão para habilitar a interface MySQL para este serviço específico. Isso vai expor a porta
3306 para esse serviço e exibir a tela de conexão MySQL, que inclui seu nome de usuário MySQL exclusivo. A senha será a mesma do usuário padrão do serviço.
Copie a string de conexão MySQL exibida.
Criando vários usuários MySQL no ClickHouse Cloud
mysql4<subdomain>, que usa a mesma senha do usuário default. A parte <subdomain> é o primeiro segmento do hostname do seu ClickHouse Cloud. Esse formato é necessário para funcionar com ferramentas que implementam conexão segura, mas não fornecem informações de SNI durante o handshake TLS, o que torna impossível fazer o roteamento interno sem uma indicação extra no nome de usuário (o cliente de linha de comando do MySQL é uma dessas ferramentas).
Por isso, recomendamos fortemente seguir o formato mysql4<subdomain>_<username> ao criar um novo usuário para uso com a interface MySQL, em que <subdomain> é uma indicação para identificar seu serviço Cloud, e <username> é um sufixo arbitrário à sua escolha.
Para um hostname do ClickHouse Cloud como foobar.us-east1.aws.clickhouse.cloud, a parte <subdomain> equivale a foobar, e um nome de usuário MySQL personalizado poderia ser algo como mysql4foobar_team1.
-
Opcional: crie um perfil de configurações para aplicar ao seu usuário personalizado. Por exemplo,
my_custom_profile com uma configuração extra que será aplicada por padrão ao se conectar com o usuário que criaremos depois:
CREATE SETTINGS PROFILE my_custom_profile SETTINGS prefer_column_name_to_alias=1;
prefer_column_name_to_alias é usado apenas como exemplo; você pode usar outras configurações ali.
-
Crie um usuário usando o seguinte formato:
mysql4<subdomain>_<username> (veja acima). A senha deve estar no formato double SHA1. Por exemplo:
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 é o nome do perfil que você criou anteriormente.
-
Conceda ao novo usuário as permissões necessárias para interagir com as tabelas ou bancos de dados desejados. Por exemplo, se quiser conceder acesso apenas a
system.query_log:
GRANT SELECT ON system.query_log TO mysql4foobar_team1;
-
Use o usuário criado para se conectar ao seu serviço do ClickHouse Cloud com a interface MySQL.
Se você criou um novo usuário do MySQL e vê o seguinte erro ao se conectar usando o cliente de linha de comando do MySQL:
ERROR 2013 (HY000): Lost connection to MySQL server at 'reading authorization packet', system error: 54
mysql4<subdomain>_<username>, conforme descrito (mais acima).
Ativando a interface MySQL no ClickHouse autogerenciado
config.d/:
<clickhouse>
<mysql_port>9004</mysql_port>
</clickhouse>
{} <Information> Application: Listening for MySQL compatibility protocol: 127.0.0.1:9004
Conecte o MySQL ao ClickHouse
mysql ao 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>
-
consultas preparadas não são compatíveis
-
alguns tipos de dados são enviados como strings
Para cancelar uma consulta longa, use a instrução KILL QUERY connection_id (ela é substituída por KILL QUERY WHERE query_id = connection_id durante o processamento). Por exemplo:
$ mysql --protocol tcp -h mysql_server -P 9004 default -u default --password=123 -e "KILL QUERY 123456;"
