> ## 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.

> リモートの MySQLサーバーに保存されているデータに対して、`SELECT` および `INSERT` クエリを実行できます。

# mysql

リモートの MySQLサーバーに保存されているデータに対して、`SELECT` および `INSERT` クエリを実行できます。

<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` | `INSERT` クエリに追加される `ON DUPLICATE KEY on_duplicate_clause` 式。指定できるのは `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 KEY` 句で使用できる `on_duplicate_clause` については、MySQL のドキュメントを参照してください。 |

引数は [名前付きコレクション](/docs/ja/concepts/features/configuration/server-config/named-collections) を使用して渡すこともできます。この場合、`host` と `port` は別々に指定する必要があります。本番環境ではこの方法を推奨します。

`=, !=, >, >=, <, <=` のような単純な `WHERE` 句は、現在 MySQLサーバー上で実行されます。

それ以外の条件と `LIMIT` のサンプリング制約は、MySQL へのクエリの完了後にのみ ClickHouse で実行されます。

<div id="passing-a-query">
  ## テーブル名の代わりにクエリを渡す
</div>

テーブル名の代わりに、3 番目の引数には、そのまま MySQL に渡される `SELECT` クエリを指定できます。結果として得られるテーブルの構造は、クエリ結果から推論されます。クエリは、サブクエリとして記述することも、`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/ja/reference/engines/table-engines/integrations/mysql) テーブルエンジンでもサポートされています。

<Note>
  サブクエリ形式 `(SELECT ...)` は ClickHouse で解析され、サーバーに送信される前に MySQL の SQL方言 (Identifier をバッククォートで囲む形式) で再シリアライズされます。そのため、有効な ClickHouse SQL である必要があります。ClickHouse が解析しない MySQL 固有の構文を渡すには、`query('...')` 形式を使用してください。この形式では、テキストがそのまま MySQL に送信されます。

  渡したクエリに対して、外側の ClickHouse クエリにある `WHERE`、`LIMIT`、集計などが**プッシュダウンされることはありません**。これらは完全なクエリ結果を取得した後に ClickHouse 側で適用されます。MySQL から読み取るデータを絞り込むには、フィルターを渡すクエリの中に記述してください。[`external_table_strict_query = 1`](/docs/ja/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>

元の MySQL テーブルと同じカラムを持つテーブルオブジェクトです。

<Note>
  MySQL の一部のデータ型は、複数の ClickHouse の型にマッピングされる場合があります。これはクエリレベルの設定 [mysql\_datatypes\_support\_level](/docs/ja/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/ja/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');
```

または、現在の最大 ID を基準に MySQL から増分バッチのみをコピーする場合:

```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/ja/reference/engines/table-engines/integrations/mysql)
* [MySQL を Dictionary ソースとして使用する](/docs/ja/reference/statements/create/dictionary/sources/mysql)
* [mysql\_datatypes\_support\_level](/docs/ja/reference/settings/session-settings#mysql_datatypes_support_level)
* [mysql\_map\_fixed\_string\_to\_text\_in\_show\_columns](/docs/ja/reference/settings/session-settings#mysql_map_fixed_string_to_text_in_show_columns)
* [mysql\_map\_string\_to\_text\_in\_show\_columns](/docs/ja/reference/settings/session-settings#mysql_map_string_to_text_in_show_columns)
* [mysql\_max\_rows\_to\_insert](/docs/ja/reference/settings/session-settings#mysql_max_rows_to_insert)