Saltar al contenido principal
Permite realizar consultas SELECT e INSERT sobre datos almacenados en un servidor MySQL remoto.

Sintaxis

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

Argumentos

ArgumentoDescripción
host:portDirección del servidor MySQL.
databaseNombre de la base de datos remota.
tableNombre de la tabla remota.
userUsuario de MySQL.
passwordContraseña del usuario.
replace_queryIndicador que convierte las consultas INSERT INTO en REPLACE INTO. Posibles valores:
- 0 - La consulta se ejecuta como INSERT INTO.
- 1 - La consulta se ejecuta como REPLACE INTO.
on_duplicate_clauseLa expresión ON DUPLICATE KEY on_duplicate_clause que se añade a la consulta INSERT. Solo puede especificarse con replace_query = 0 (si se pasan simultáneamente replace_query = 1 y on_duplicate_clause, ClickHouse genera una excepción).
Ejemplo: INSERT INTO t (c1,c2) VALUES ('a', 2) ON DUPLICATE KEY UPDATE c2 = c2 + 1;
Aquí, on_duplicate_clause es UPDATE c2 = c2 + 1. Consulta la documentación de MySQL para ver qué on_duplicate_clause puedes usar con la cláusula ON DUPLICATE KEY.
Los argumentos también pueden pasarse mediante colecciones con nombre. En este caso, host y port deben especificarse por separado. Este enfoque se recomienda para entornos de producción. Las cláusulas WHERE simples, como =, !=, >, >=, <, <=, se ejecutan actualmente en el servidor MySQL. El resto de las condiciones y la restricción de muestreo LIMIT se ejecutan en ClickHouse solo después de que termina la consulta a MySQL. Admite varias réplicas, que deben indicarse con |. Por ejemplo:
SELECT name FROM mysql(`mysql{1|2|3}:3306`, 'mysql_database', 'mysql_table', 'user', 'password');
o
SELECT name FROM mysql(`mysql1:3306|mysql2:3306|mysql3:3306`, 'mysql_database', 'mysql_table', 'user', 'password');

Valor devuelto

Un objeto de tabla con las mismas columnas que la tabla original de MySQL.
Algunos tipos de datos de MySQL pueden asignarse a distintos tipos de ClickHouse; esto se resuelve mediante la configuración a nivel de consulta mysql_datatypes_support_level
En la consulta INSERT, para distinguir la función de tabla mysql(...) del nombre de tabla con la lista de nombres de columnas, debe usar las palabras clave FUNCTION o TABLE FUNCTION. Vea los ejemplos a continuación.

Ejemplos

Tabla en 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 |
+--------+-------+
Selección de datos de ClickHouse:
SELECT * FROM mysql('localhost:3306', 'test', 'test', 'bayonet', '123');
O bien, usando colecciones con nombre:
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 │
└────────┴───────┘
Reemplazo e inserción:
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 │
└────────┴───────┘
Copiar datos desde una tabla de MySQL a una tabla de 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');
O, si copias solo un lote incremental desde MySQL tomando como referencia el id máximo actual:
INSERT INTO mysql_copy
SELECT * FROM mysql('host:port', 'database', 'table', 'user', 'password')
WHERE id > (SELECT max(id) FROM mysql_copy);
Última modificación el 10 de junio de 2026