Pular para o conteúdo principal
Permite executar consultas SELECT e INSERT em dados armazenados em um servidor MySQL remoto.

Sintaxe

mysql({host:port, database, table, user, password[, replace_query, on_duplicate_clause] | named_collection[, option=value [,..]]})

Argumentos

ArgumentoDescrição
host:portEndereço do servidor MySQL.
databaseNome do banco de dados remoto.
tableNome da tabela remota.
userUsuário do MySQL.
passwordSenha do usuário.
replace_querySinalizador que converte consultas INSERT INTO em REPLACE INTO. Valores possíveis:
- 0 - A consulta é executada como INSERT INTO.
- 1 - A consulta é executada como REPLACE INTO.
on_duplicate_clauseA expressão ON DUPLICATE KEY on_duplicate_clause adicionada à consulta INSERT. Ela só pode ser especificada com replace_query = 0 (se você passar replace_query = 1 e on_duplicate_clause ao mesmo tempo, o ClickHouse gerará uma exceção).
Exemplo: INSERT INTO t (c1,c2) VALUES ('a', 2) ON DUPLICATE KEY UPDATE c2 = c2 + 1;
Aqui, on_duplicate_clause é UPDATE c2 = c2 + 1. Consulte a documentação do MySQL para ver quais valores de on_duplicate_clause podem ser usados com a cláusula ON DUPLICATE KEY.
Os argumentos também podem ser passados usando coleções nomeadas. Nesse caso, host e port devem ser especificados separadamente. Essa abordagem é recomendada para ambientes de produção. Cláusulas WHERE simples, como =, !=, >, >=, <, <=, atualmente são executadas no servidor MySQL. O restante das condições e a restrição de amostragem LIMIT são executados no ClickHouse somente após a conclusão da consulta ao MySQL. Há suporte a múltiplas réplicas, que devem ser listadas com |. Por exemplo:
SELECT name FROM mysql(`mysql{1|2|3}:3306`, 'mysql_database', 'mysql_table', 'user', 'password');
ou
SELECT name FROM mysql(`mysql1:3306|mysql2:3306|mysql3:3306`, 'mysql_database', 'mysql_table', 'user', 'password');

Valor retornado

Um objeto de tabela com as mesmas colunas da tabela MySQL original.
Alguns tipos de dados do MySQL podem ser mapeados para diferentes tipos do ClickHouse — isso é controlado pela configuração em nível de consulta mysql_datatypes_support_level
Na consulta INSERT, para distinguir a função de tabela mysql(...) do nome da tabela com uma lista de nomes de colunas, você deve usar as palavras-chave FUNCTION ou TABLE FUNCTION. Veja os exemplos abaixo.

Exemplos

Tabela no MySQL:
mysql> CREATE TABLE `test`.`test` (
    ->   `int_id` INT NOT NULL AUTO_INCREMENT,
    ->   `float` FLOAT NOT NULL,
    ->   PRIMARY KEY (`int_id`));

mysql> INSERT INTO test (`int_id`, `float`) VALUES (1,2);

mysql> SELECT * FROM test;
+--------+-------+
| int_id | float |
+--------+-------+
|      1 |     2 |
+--------+-------+
Selecionar dados do ClickHouse:
SELECT * FROM mysql('localhost:3306', 'test', 'test', 'bayonet', '123');
Ou usando coleções nomeadas:
CREATE NAMED COLLECTION creds AS
        host = 'localhost',
        port = 3306,
        database = 'test',
        user = 'bayonet',
        password = '123';
SELECT * FROM mysql(creds, table='test');
┌─int_id─┬─float─┐
│      1 │     2 │
└────────┴───────┘
Substituição e inserção:
INSERT INTO FUNCTION mysql('localhost:3306', 'test', 'test', 'bayonet', '123', 1) (int_id, float) VALUES (1, 3);
INSERT INTO TABLE FUNCTION mysql('localhost:3306', 'test', 'test', 'bayonet', '123', 0, 'UPDATE int_id = int_id + 1') (int_id, float) VALUES (1, 4);
SELECT * FROM mysql('localhost:3306', 'test', 'test', 'bayonet', '123');
┌─int_id─┬─float─┐
│      1 │     3 │
│      2 │     4 │
└────────┴───────┘
Copiando dados da tabela do MySQL para a tabela do ClickHouse:
CREATE TABLE mysql_copy
(
   `id` UInt64,
   `datetime` DateTime('UTC'),
   `description` String,
)
ENGINE = MergeTree
ORDER BY (id,datetime);

INSERT INTO mysql_copy
SELECT * FROM mysql('host:port', 'database', 'table', 'user', 'password');
Ou, se estiver copiando apenas um lote incremental do MySQL com base no ID máximo atual:
INSERT INTO mysql_copy
SELECT * FROM mysql('host:port', 'database', 'table', 'user', 'password')
WHERE id > (SELECT max(id) FROM mysql_copy);
Última modificação em 10 de junho de 2026