Перейти к основному содержанию
Позволяет выполнять запросы SELECT и INSERT к данным, хранящимся на удаленном сервере MySQL.

Синтаксис

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

Аргументы

АргументОписание
host:portАдрес сервера MySQL.
databaseИмя удалённой базы данных.
tableИмя удалённой таблицы.
userИмя пользователя MySQL.
passwordПароль пользователя.
replace_queryФлаг, который преобразует запросы INSERT INTO в REPLACE INTO. Возможные значения:
- 0 — запрос выполняется как INSERT INTO.
- 1 — запрос выполняется как REPLACE INTO.
on_duplicate_clauseВыражение ON DUPLICATE KEY on_duplicate_clause, добавляемое к запросу INSERT. Можно указывать только вместе с replace_query = 0 (если одновременно передать replace_query = 1 и on_duplicate_clause, ClickHouse выдаст исключение).
Пример: INSERT INTO t (c1,c2) VALUES ('a', 2) ON DUPLICATE KEY UPDATE c2 = c2 + 1;
Здесь on_duplicate_clause — это UPDATE c2 = c2 + 1. Сведения о том, какие on_duplicate_clause можно использовать с секцией ON DUPLICATE KEY, см. в документации MySQL.
Аргументы также можно передавать с помощью именованных коллекций. В этом случае host и port нужно указывать отдельно. Такой подход рекомендуется для продакшн-среды. Простые секции WHERE, такие как =, !=, >, >=, <, <=, в настоящее время выполняются на сервере MySQL. Остальные условия и ограничение выборки LIMIT выполняются в ClickHouse только после завершения запроса к MySQL. Поддерживается несколько реплик, которые должны быть перечислены через |. Например:
SELECT name FROM mysql(`mysql{1|2|3}:3306`, 'mysql_database', 'mysql_table', 'user', 'password');
или
SELECT name FROM mysql(`mysql1:3306|mysql2:3306|mysql3:3306`, 'mysql_database', 'mysql_table', 'user', 'password');

Возвращаемое значение

Объект table с теми же столбцами, что и исходная таблица MySQL.
Некоторые типы данных MySQL могут сопоставляться с разными типами ClickHouse — это регулируется настройкой уровня запроса mysql_datatypes_support_level
В запросе INSERT, чтобы отличить табличную функцию mysql(...) от имени таблицы со списком имён столбцов, необходимо использовать ключевые слова FUNCTION или TABLE FUNCTION. См. примеры ниже.

Примеры

Таблица в 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 |
+--------+-------+
Выборка данных из ClickHouse:
SELECT * FROM mysql('localhost:3306', 'test', 'test', 'bayonet', '123');
Или с помощью именованных коллекций:
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 │
└────────┴───────┘
Замена и вставка данных:
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 │
└────────┴───────┘
Копирование данных из таблицы MySQL в таблицу 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');
Или, если копируете только инкрементный батч из MySQL на основе текущего максимального значения id:
INSERT INTO mysql_copy
SELECT * FROM mysql('host:port', 'database', 'table', 'user', 'password')
WHERE id > (SELECT max(id) FROM mysql_copy);
Последнее изменение 10 июня 2026 г.