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

> Documentação do mecanismo de tabela MySQL

# Mecanismo de tabela MySQL

O mecanismo MySQL permite executar consultas `SELECT` e `INSERT` em dados armazenados em um servidor MySQL remoto.

<div id="creating-a-table">
  ## Criando uma tabela
</div>

```sql theme={null}
CREATE TABLE [IF NOT EXISTS] [db.]table_name [ON CLUSTER cluster]
(
    name1 [type1] [DEFAULT|MATERIALIZED|ALIAS expr1],
    name2 [type2] [DEFAULT|MATERIALIZED|ALIAS expr2],
    ...
) ENGINE = MySQL({host:port, database, table, user, password[, replace_query, on_duplicate_clause] | named_collection[, option=value [,..]]})
SETTINGS
    [ connection_pool_size=16, ]
    [ connection_max_tries=3, ]
    [ connection_wait_timeout=5, ]
    [ connection_auto_close=true, ]
    [ connect_timeout=10, ]
    [ read_write_timeout=300, ]
    [ enable_compression=false ]
;
```

Veja uma descrição detalhada da consulta [CREATE TABLE](/pt-BR/reference/statements/create/table).

A estrutura da tabela pode ser diferente da estrutura da tabela MySQL original:

* Os nomes das colunas devem ser os mesmos da tabela MySQL original, mas você pode usar apenas algumas delas e em qualquer ordem.
* Os tipos das colunas podem ser diferentes dos da tabela MySQL original. O ClickHouse tenta [converter](/pt-BR/reference/engines/database-engines/mysql#data_types-support) os valores para os tipos de dados do ClickHouse.
* A configuração [external\_table\_functions\_use\_nulls](/pt-BR/reference/settings/session-settings#external_table_functions_use_nulls) define como lidar com colunas Nullable. Valor padrão: 1. Se for 0, a função de tabela não cria colunas Nullable e insere valores padrão em vez de nulos. Isso também se aplica a valores NULL dentro de arrays.

**Parâmetros do mecanismo**

* `host:port` — Endereço do servidor MySQL.
* `database` — nome do banco de dados remoto.
* `table` — Nome da tabela remota.
* `user` — usuário MySQL.
* `password` — Senha do usuário.
* `replace_query` — Sinalizador que converte consultas `INSERT INTO` em `REPLACE INTO`. Se `replace_query=1`, a consulta é substituída.
* `on_duplicate_clause` — A expressão `ON DUPLICATE KEY on_duplicate_clause` adicionada à consulta `INSERT`.
  Exemplo: `INSERT INTO t (c1,c2) VALUES ('a', 2) ON DUPLICATE KEY UPDATE c2 = c2 + 1`, em que `on_duplicate_clause` é `UPDATE c2 = c2 + 1`. Consulte a [documentação do MySQL](https://dev.mysql.com/doc/refman/8.0/en/insert-on-duplicate.html) para ver qual `on_duplicate_clause` você pode usar com a cláusula `ON DUPLICATE KEY`.
  Para especificar `on_duplicate_clause`, você precisa passar `0` para o parâmetro `replace_query`. Se passar `replace_query = 1` e `on_duplicate_clause` ao mesmo tempo, o ClickHouse gera uma exceção.

Os argumentos também podem ser passados usando [coleções nomeadas](/pt-BR/concepts/features/configuration/server-config/named-collections). Nesse caso, `host` e `port` devem ser especificados separadamente. Essa abordagem é recomendada para o ambiente de produção.

Cláusulas `WHERE` simples, como `=, !=, >, >=, <, <=`, 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 o término da consulta ao MySQL.

Há suporte para várias réplicas, que devem ser listadas com `|`. Por exemplo:

```sql theme={null}
CREATE TABLE test_replicas (id UInt32, name String, age UInt32, money UInt32) ENGINE = MySQL(`mysql{2|3|4}:3306`, 'clickhouse', 'test_replicas', 'root', 'clickhouse');
```

<div id="usage-example">
  ## Exemplo de uso
</div>

Criar tabela no MySQL:

```text theme={null}
mysql> CREATE TABLE `test`.`test` (
    ->   `int_id` INT NOT NULL AUTO_INCREMENT,
    ->   `int_nullable` INT NULL DEFAULT NULL,
    ->   `float` FLOAT NOT NULL,
    ->   `float_nullable` FLOAT NULL DEFAULT NULL,
    ->   PRIMARY KEY (`int_id`));
Query OK, 0 rows affected (0,09 sec)

mysql> insert into test (`int_id`, `float`) VALUES (1,2);
Query OK, 1 row affected (0,00 sec)

mysql> select * from test;
+------+----------+-----+----------+
| int_id | int_nullable | float | float_nullable |
+------+----------+-----+----------+
|      1 |         NULL |     2 |           NULL |
+------+----------+-----+----------+
1 row in set (0,00 sec)
```

Crie uma tabela no ClickHouse usando argumentos simples:

```sql theme={null}
CREATE TABLE mysql_table
(
    `float_nullable` Nullable(Float32),
    `int_id` Int32
)
ENGINE = MySQL('localhost:3306', 'test', 'test', 'bayonet', '123')
```

Ou use [coleções nomeadas](/pt-BR/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';
CREATE TABLE mysql_table
(
    `float_nullable` Nullable(Float32),
    `int_id` Int32
)
ENGINE = MySQL(creds, table='test')
```

Recuperando dados da tabela do MySQL:

```sql theme={null}
SELECT * FROM mysql_table
```

```text theme={null}
┌─float_nullable─┬─int_id─┐
│           ᴺᵁᴸᴸ │      1 │
└────────────────┴────────┘
```

<div id="mysql-settings">
  ## Configurações
</div>

As configurações padrão não são muito eficientes, pois nem sequer reutilizam as conexões. Essas configurações permitem aumentar o número de consultas que o servidor executa por segundo.

<div id="connection-auto-close">
  ### `connection_auto_close`
</div>

Permite fechar automaticamente a conexão após a execução da consulta, ou seja, desativa a reutilização da conexão.

Valores possíveis:

* 1 — O fechamento automático da conexão é permitido, portanto a reutilização da conexão fica desativada
* 0 — O fechamento automático da conexão não é permitido, portanto a reutilização da conexão fica ativada

Valor padrão: `1`.

<div id="connection-max-tries">
  ### `connection_max_tries`
</div>

Define o número de novas tentativas para o pool com failover.

Valores possíveis:

* Inteiro positivo.
* 0 — Não há novas tentativas para o pool com failover.

Valor padrão: `3`.

<div id="connection-pool-size">
  ### `connection_pool_size`
</div>

Tamanho do pool de conexões (se todas as conexões estiverem em uso, a consulta aguardará até que alguma seja liberada).

Valores possíveis:

* Inteiro positivo.

Valor padrão: `16`.

<div id="connection-wait-timeout">
  ### `connection_wait_timeout`
</div>

Tempo limite (em segundos) para aguardar uma conexão livre (caso já haja `connection_pool_size` conexões ativas); 0 - não aguardar.

Valores possíveis:

* Inteiro positivo.

Valor padrão: `5`.

<div id="connect-timeout">
  ### `connect_timeout`
</div>

Tempo limite de conexão (em segundos).

Valores possíveis:

* Inteiro positivo.

Valor padrão: `10`.

<div id="read-write-timeout">
  ### `read_write_timeout`
</div>

Tempo limite de leitura e gravação (em segundos).

Valores possíveis:

* Inteiro positivo.

Valor padrão: `300`.

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

Habilita a compressão para a conexão do protocolo MySQL.

Valor padrão: `false`.

Esta configuração se aplica a:

* o mecanismo de tabela `MySQL`;
* o mecanismo de banco de dados `MySQL`;
* a função de tabela `mysql`;
* coleções nomeadas usadas por integrações do MySQL.

Quando habilitada, o ClickHouse solicita compressão para a conexão.

Exemplo:

```sql theme={null}
CREATE TABLE mysql_engine_compression
(
    id UInt32,
    name String,
    age UInt32,
    money UInt32
)
ENGINE = MySQL('mysql80:3306', 'clickhouse', 'test_table', 'root', 'password')
SETTINGS enable_compression = 1;
```

<div id="see-also">
  ## Veja também
</div>

* [A função de tabela do MySQL](/pt-BR/reference/functions/table-functions/mysql)
* [Usando o MySQL como fonte de dicionário](/pt-BR/reference/statements/create/dictionary/sources/mysql)