Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs
49.6kGet Started

mysql

View as MarkdownEdit this pageReport an issueSet up docs MCP

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

構文

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

引数

引数 説明
host:port MySQLサーバーのアドレス。
database リモートデータベース名。
table リモートテーブル名、またはそのまま MySQL に渡されるクエリ (テーブル名の代わりにクエリを渡す を参照)。
user MySQLユーザー。
password ユーザーのパスワード。
replace_query INSERT INTO クエリを REPLACE INTO に変換するフラグ。設定可能な値:
- 0 - クエリは INSERT INTO として実行されます。
- 1 - クエリは REPLACE INTO として実行されます。
on_duplicate_clause INSERT クエリに追加される ON DUPLICATE KEY on_duplicate_clause 式。指定できるのは 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 です。ON DUPLICATE KEY 句で使用できる on_duplicate_clause については、MySQL のドキュメントを参照してください。

引数は 名前付きコレクション を使用して渡すこともできます。この場合、host と port は別々に指定する必要があります。本番環境ではこの方法を推奨します。

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

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

TLS/SSL

MySQL への暗号化接続の認証情報は、名前付きコレクションのキー (またはキー・バリュー引数) として渡されます。

パラメータ 説明
ssl_ca_pem MySQL サーバー証明書の検証に使用する CA 証明書の内容。
ssl_cert_pem 証明書ベース認証に使用するクライアント証明書の内容。
ssl_key_pem ssl_cert_pem に対応する秘密鍵の内容。

値には、対応する PEM ファイルの内容を指定します。これらは名前付きコレクションまたはクエリにコピーできます。パスワードと同様に、ログおよび SHOW クエリではマスクされます。

同じ認証情報は、サーバー上のファイルへのパスとして ssl_ca、ssl_cert、ssl_key に指定することもできます。ただし、サーバー設定ファイルで定義された名前付きコレクション内でのみ指定可能であり、このような値はクエリでオーバーライドできません。サーバーは自身の権限でこれらのファイルを開くため、SQL からパスを受け入れると、MySQL ログソースを定義できるすべてのユーザーがローカルファイルシステムを調査し、自身には読み取り権限のない証明書と秘密鍵を使って認証できてしまいます。

テーブル名の代わりにクエリを渡す

テーブル名の代わりに、3 番目の引数には、そのまま MySQL に渡される SELECT クエリを指定できます。結果として得られるテーブルの構造は、クエリ結果から推論されます。クエリは、サブクエリとして記述することも、query 関数でラップすることもできます。

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 テーブルエンジンでもサポートされています。

複数のレプリカをサポートしており、| で区切って指定する必要があります。例えば:

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のテーブル:

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 │
└────────┴───────┘

enable_compression

MySQLプロトコル接続の圧縮を有効にします。

デフォルト値: false。

この設定は次に適用されます:

  • mysql テーブル関数
  • MySQL テーブルエンジン
  • MySQL データベースエンジン
  • MySQLインテグレーションで使用される名前付きコレクション

有効にすると、ClickHouse は接続に対して圧縮を要求します。

例:

SELECT *
FROM mysql(
    'mysql80:3306',
    'clickhouse',
    'test_table',
    'root',
    'password',
    SETTINGS enable_compression = 1
);

置換と挿入:

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');

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

INSERT INTO mysql_copy
SELECT * FROM mysql('host:port', 'database', 'table', 'user', 'password')
WHERE id > (SELECT max(id) FROM mysql_copy);
Navigation