> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-parallel-read-in-order-multi-part.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

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

# mysql

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

## Синтаксис

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

## Аргументы

| Аргумент | Описание |
| - | - |
| `host:port` | Адрес сервера MySQL. |
| `database` | Имя удалённой базы данных. |
| `table` | Имя удалённой таблицы или запрос, передаваемый в MySQL как есть (см. [Передача запроса вместо имени таблицы](#passing-a-query)). |
| `user` | Имя пользователя MySQL. |
| `password` | Пароль пользователя. |
| `replace_query` | Флаг, который преобразует запросы `INSERT INTO` в `REPLACE INTO`. Возможные значения:<br />    - `0` — запрос выполняется как `INSERT INTO`.<br />    - `1` — запрос выполняется как `REPLACE INTO`. |
| `on_duplicate_clause` | Выражение `ON DUPLICATE KEY on_duplicate_clause`, добавляемое к запросу `INSERT`. Можно указывать только вместе с `replace_query = 0` (если одновременно передать `replace_query = 1` и `on_duplicate_clause`, ClickHouse выдаст исключение).<br />    Пример: `INSERT INTO t (c1,c2) VALUES ('a', 2) ON DUPLICATE KEY UPDATE c2 = c2 + 1;`<br />    Здесь `on_duplicate_clause` — это `UPDATE c2 = c2 + 1`. Сведения о том, какие `on_duplicate_clause` можно использовать с секцией `ON DUPLICATE KEY`, см. в документации MySQL. |

Аргументы также можно передавать с помощью [именованных коллекций](/ru/concepts/features/configuration/server-config/named-collections). В этом случае `host` и `port` нужно указывать отдельно. Такой подход рекомендуется для продакшн-среды.

Простые секции `WHERE`, такие как `=, !=, >, >=, <, <=`, в настоящее время выполняются на сервере MySQL.

Остальные условия и ограничение выборки `LIMIT` выполняются в ClickHouse только после завершения запроса к MySQL.

## TLS/SSL

Учётные данные для зашифрованного подключения к MySQL передаются как ключи именованной коллекции (или как аргументы типа ключ-значение):

| Параметр | Описание |
| - | - |
| `ssl_ca_pem` | Содержимое CA‑сертификата, по которому проверяется сертификат сервера MySQL. |
| `ssl_cert_pem` | Содержимое клиентского сертификата для аутентификации на основе сертификата. |
| `ssl_key_pem` | Содержимое закрытого ключа, соответствующего `ssl_cert_pem`. |

Значениями служит содержимое соответствующих PEM-файлов, которое можно скопировать в именованную коллекцию или запрос. Они маскируются в журналах и в запросах `SHOW` так же, как пароли.

Эти же учётные данные можно также указать как пути к файлам на сервере в `ssl_ca`, `ssl_cert` и `ssl_key` — но **только в именованной коллекции, определённой в файле конфигурации сервера**; такое значение нельзя переопределить в запросе. Сервер открывает эти файлы со своими привилегиями, поэтому приём пути из SQL позволил бы любому пользователю, способному определить источник MySQL, исследовать локальную файловую систему и проходить аутентификацию с сертификатом и ключом, к которым у него нет доступа на чтение.

## Передача запроса вместо имени таблицы

Вместо имени таблицы в качестве третьего аргумента можно указать запрос `SELECT`, который передаётся в MySQL как есть. Структура результирующей таблицы определяется по результату запроса. Запрос можно записать либо как подзапрос, либо обернуть в функцию `query`:

```sql theme={null}
SELECT * FROM mysql('localhost:3306', 'test', (SELECT a, b FROM t1 JOIN t2 USING (id) WHERE a > 0), 'user', 'password');
SELECT * FROM mysql('localhost:3306', 'test', query('SELECT a, b FROM t1 JOIN t2 USING (id) WHERE a > 0'), 'user', 'password');
```

Это позволяет проталкивать JOIN, агрегации и любую другую обработку в MySQL. Такая таблица доступна только для чтения: `INSERT` в неё не поддерживается. Тот же синтаксис поддерживает движок таблицы [`MySQL`](/ru/reference/engines/table-engines/integrations/mysql).

<Note>
  Форма подзапроса `(SELECT ...)` разбирается ClickHouse и перед отправкой на сервер повторно сериализуется в диалекте MySQL (с экранированием идентификаторов обратными кавычками). Поэтому она должна быть корректным ClickHouse SQL. Чтобы передать синтаксис, специфичный для MySQL, который ClickHouse не разбирает, используйте форму `query('...')`, текст которой отправляется в MySQL без изменений.

  Любой внешний `WHERE`, `LIMIT`, агрегация и т. д. из окружающего запроса к ClickHouse **не** проталкиваются в переданный запрос — они применяются в ClickHouse после получения полного результата запроса. Чтобы ограничить объём данных, считываемых из MySQL, поместите фильтр внутрь передаваемого запроса. При [`external_table_strict_query = 1`](/ru/reference/settings/session-settings/external-table#external_table_strict_query) внешний фильтр по столбцам табличной функции вызывает исключение вместо локального применения, поскольку его нельзя протолкнуть в переданный запрос. Проверка охватывает предикат `WHERE` верхнего уровня и каждую конъюнкцию `AND` верхнего уровня. `PREWHERE` по столбцам этой таблицы не относится к данной настройке: этот движок таблицы не поддерживает `PREWHERE`, и такой запрос отклоняется с `ILLEGAL_PREWHERE` независимо от настройки. Проверка выполняется только там, где фильтр вообще может быть протолкнут: когда эта таблица — единственная таблица запроса, на любой стороне `INNER JOIN` или на сохраняющей стороне внешнего JOIN (левой стороне `LEFT JOIN`, правой стороне `RIGHT JOIN`). На несохраняющей стороне `LEFT`/`RIGHT JOIN` и на любой стороне `FULL JOIN` ничего не проталкивается и не проверяется, поэтому фильтр по столбцам этой таблицы применяется локально после JOIN даже в строгом режиме. Там, где выполняется проверка, предикат, ссылающийся на другие таблицы, присоединённые в окружающем запросе, не проталкивается и исключается из проверки, независимо от того, ссылается ли он только на присоединённую сторону или объединяет её с этой таблицей в одном выражении, не содержащем `AND` (например, `OR`); такой предикат сохраняет обычную точку вычисления в ClickHouse (`WHERE` после JOIN, `PREWHERE` перед ним) и не отклоняется.
</Note>

Поддерживается несколько реплик, которые должны быть перечислены через `|`. Например:

```sql theme={null}
SELECT name FROM mysql(`mysql{1|2|3}:3306`, 'mysql_database', 'mysql_table', 'user', 'password');
```

или

```sql theme={null}
SELECT name FROM mysql(`mysql1:3306|mysql2:3306|mysql3:3306`, 'mysql_database', 'mysql_table', 'user', 'password');
```

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

Объект таблицы с теми же столбцами, что и исходная таблица MySQL.

<Note>
  Некоторые типы данных MySQL могут сопоставляться с разными типами ClickHouse — это регулируется настройкой уровня запроса [mysql\_datatypes\_support\_level](/ru/reference/settings/session-settings/mysql#mysql_datatypes_support_level)
</Note>

<Note>
  В запросе `INSERT`, чтобы отличить табличную функцию `mysql(...)` от имени таблицы со списком имён столбцов, необходимо использовать ключевые слова `FUNCTION` или `TABLE FUNCTION`. См. примеры ниже.
</Note>

## Примеры

Таблица в MySQL:

```text theme={null}
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:

```sql theme={null}
SELECT * FROM mysql('localhost:3306', 'test', 'test', 'bayonet', '123');
```

Или с помощью [именованных коллекций](/ru/concepts/features/configuration/server-config/named-collections):

```sql theme={null}
CREATE NAMED COLLECTION creds AS
        host = 'localhost',
        port = 3306,
        database = 'test',
        user = 'bayonet',
        password = '123';
SELECT * FROM mysql(creds, table='test');
```

```text theme={null}
┌─int_id─┬─float─┐
│      1 │     2 │
└────────┴───────┘
```

### `enable_compression`

Включает сжатие для подключения по протоколу MySQL.

Значение по умолчанию: `false`.

Этот параметр применяется к:

* табличной функции `mysql`;
* движку таблицы `MySQL`;
* движку базы данных `MySQL`;
* именованным коллекциям, используемым в интеграциях MySQL.

Когда параметр включен, ClickHouse запрашивает сжатие для соединения.

Пример:

```sql theme={null}
SELECT *
FROM mysql(
    'mysql80:3306',
    'clickhouse',
    'test_table',
    'root',
    'password',
    SETTINGS enable_compression = 1
);
```

Замена и вставка данных:

```sql theme={null}
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');
```

```text theme={null}
┌─int_id─┬─float─┐
│      1 │     3 │
│      2 │     4 │
└────────┴───────┘
```

Копирование данных из таблицы MySQL в таблицу ClickHouse:

```sql theme={null}
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:

```sql theme={null}
INSERT INTO mysql_copy
SELECT * FROM mysql('host:port', 'database', 'table', 'user', 'password')
WHERE id > (SELECT max(id) FROM mysql_copy);
```

## См. также

* [Движок таблицы 'MySQL'](/ru/reference/engines/table-engines/integrations/mysql)
* [Использование MySQL в качестве источника для словаря](/ru/reference/statements/create/dictionary/sources/mysql)
* [mysql\_datatypes\_support\_level](/ru/reference/settings/session-settings/mysql#mysql_datatypes_support_level)
* [mysql\_map\_fixed\_string\_to\_text\_in\_show\_columns](/ru/reference/settings/session-settings/mysql-map#mysql_map_fixed_string_to_text_in_show_columns)
* [mysql\_map\_string\_to\_text\_in\_show\_columns](/ru/reference/settings/session-settings/mysql-map#mysql_map_string_to_text_in_show_columns)
* [mysql\_max\_rows\_to\_insert](/ru/reference/settings/session-settings/mysql#mysql_max_rows_to_insert)