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

Табличная функция mysql

Позволяет выполнять запросы 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. См. документацию MySQL, чтобы узнать, какие on_duplicate_clause можно использовать с предложением ON DUPLICATE KEY.

Аргументы также можно передавать с использованием именованных коллекций. В этом случае 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');

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

Объект таблицы с теми же столбцами, что и исходная таблица 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);