> ## Documentation Index
> Fetch the complete documentation index at: https://clickhouse.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

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

# mysql

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

<div id="syntax">
  ## Синтаксис
</div>

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

<div id="arguments">
  ## Аргументы
</div>

| Аргумент              | Описание                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `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. |

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

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

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

<div id="passing-a-query">
  ## Передача запроса вместо имени таблицы
</div>

Вместо имени таблицы в качестве третьего аргумента можно указать запрос `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`](/docs/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`](/docs/ru/reference/settings/session-settings#external_table_strict_query) внешний фильтр, который нельзя протолкнуть, вызывает исключение вместо локального применения.
</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');
```

<div id="returned_value">
  ## Возвращаемое значение
</div>

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

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

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

<div id="examples">
  ## Примеры
</div>

Таблица в 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');
```

Или с помощью [именованных коллекций](/docs/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 │
└────────┴───────┘
```

<div id="enable-compression">
  ### `enable_compression`
</div>

Включает сжатие для подключения по протоколу 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);
```

<div id="related">
  ## См. также
</div>

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