跳转到主要内容
允许对存储在远程 MySQL 服务器中的数据执行 SELECT 和 INSERT 查询。

​
语法

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

​
参数

参数描述
host:portMySQL 服务器地址。
database远程数据库名称。
table远程表名。
userMySQL 用户。
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。请参阅 MySQL 文档，了解 ON DUPLICATE KEY 子句支持哪些 on_duplicate_clause。
参数也可以通过命名集合传递。在这种情况下，需要分别指定 host 和 port。这种方式推荐在生产环境中使用。 目前，诸如 =, !=, >, >=, <, <= 这样的简单 WHERE 子句会在 MySQL 服务器上执行。 其余条件以及 LIMIT 采样约束，只会在对 MySQL 的查询完成后由 ClickHouse 执行。 支持多个副本，必须使用 | 列出。例如： 
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 的某些数据类型可映射为不同的 ClickHouse 类型——可通过查询级设置 mysql_datatypes_support_level 来处理这一点。
在 INSERT 查询中，为了将表函数 mysql(...) 与带列名列表的表名区分开来，必须使用关键字 FUNCTION 或 TABLE FUNCTION。请参见下面的示例。

​
示例

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 │
└────────┴───────┘
替换与插入： 
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);
最后修改于 2026年6月10日