mirror of
https://github.com/ClickHouse/ClickHouse.git
synced 2024-11-10 17:44:23 +00:00
Merge pull request #18584 from olgarev/revolg-DOCSUP-4434-MySQL_table_function_supports_INSERTS
DOCSUP-4434: Docs for the INSERT support in mysql function
This commit is contained in:
commit
e525da87ce
@ -5,10 +5,12 @@ toc_title: mysql
|
|||||||
|
|
||||||
# mysql {#mysql}
|
# mysql {#mysql}
|
||||||
|
|
||||||
Allows `SELECT` queries to be performed on data that is stored on a remote MySQL server.
|
Allows `SELECT` and `INSERT` queries to be performed on data that is stored on a remote MySQL server.
|
||||||
|
|
||||||
|
**Syntax**
|
||||||
|
|
||||||
``` sql
|
``` sql
|
||||||
mysql('host:port', 'database', 'table', 'user', 'password'[, replace_query, 'on_duplicate_clause']);
|
mysql('host:port', 'database', 'table', 'user', 'password'[, replace_query, 'on_duplicate_clause'])
|
||||||
```
|
```
|
||||||
|
|
||||||
**Parameters**
|
**Parameters**
|
||||||
@ -23,13 +25,15 @@ mysql('host:port', 'database', 'table', 'user', 'password'[, replace_query, 'on_
|
|||||||
|
|
||||||
- `password` — User password.
|
- `password` — User password.
|
||||||
|
|
||||||
- `replace_query` — Flag that converts `INSERT INTO` queries to `REPLACE INTO`. If `replace_query=1`, the query is replaced.
|
- `replace_query` — Flag that converts `INSERT INTO` queries to `REPLACE INTO`. Possible values:
|
||||||
|
- `0` - The query is executed as `INSERT INTO`.
|
||||||
|
- `1` - The query is executed as `REPLACE INTO`.
|
||||||
|
|
||||||
- `on_duplicate_clause` — The `ON DUPLICATE KEY on_duplicate_clause` expression that is added to the `INSERT` query.
|
- `on_duplicate_clause` — The `ON DUPLICATE KEY on_duplicate_clause` expression that is added to the `INSERT` query. Can be specified only with `replace_query = 0` (if you simultaneously pass `replace_query = 1` and `on_duplicate_clause`, ClickHouse generates an exception).
|
||||||
|
|
||||||
Example: `INSERT INTO t (c1,c2) VALUES ('a', 2) ON DUPLICATE KEY UPDATE c2 = c2 + 1`, where `on_duplicate_clause` is `UPDATE c2 = c2 + 1`. See the MySQL documentation to find which `on_duplicate_clause` you can use with the `ON DUPLICATE KEY` clause.
|
Example: `INSERT INTO t (c1,c2) VALUES ('a', 2) ON DUPLICATE KEY UPDATE c2 = c2 + 1;`
|
||||||
|
|
||||||
To specify `on_duplicate_clause` you need to pass `0` to the `replace_query` parameter. If you simultaneously pass `replace_query = 1` and `on_duplicate_clause`, ClickHouse generates an exception.
|
`on_duplicate_clause` here is `UPDATE c2 = c2 + 1`. See the MySQL documentation to find which `on_duplicate_clause` you can use with the `ON DUPLICATE KEY` clause.
|
||||||
|
|
||||||
Simple `WHERE` clauses such as `=, !=, >, >=, <, <=` are currently executed on the MySQL server.
|
Simple `WHERE` clauses such as `=, !=, >, >=, <, <=` are currently executed on the MySQL server.
|
||||||
|
|
||||||
@ -39,46 +43,59 @@ The rest of the conditions and the `LIMIT` sampling constraint are executed in C
|
|||||||
|
|
||||||
A table object with the same columns as the original MySQL table.
|
A table object with the same columns as the original MySQL table.
|
||||||
|
|
||||||
## Usage Example {#usage-example}
|
!!! info "Note"
|
||||||
|
In the `INSERT` query to distinguish table function `mysql(...)` from table name with column names list you must use keywords `FUNCTION` or `TABLE FUNCTION`. See examples below.
|
||||||
|
|
||||||
|
**Examples**
|
||||||
|
|
||||||
Table in MySQL:
|
Table in MySQL:
|
||||||
|
|
||||||
``` text
|
``` text
|
||||||
mysql> CREATE TABLE `test`.`test` (
|
mysql> CREATE TABLE `test`.`test` (
|
||||||
-> `int_id` INT NOT NULL AUTO_INCREMENT,
|
-> `int_id` INT NOT NULL AUTO_INCREMENT,
|
||||||
-> `int_nullable` INT NULL DEFAULT NULL,
|
|
||||||
-> `float` FLOAT NOT NULL,
|
-> `float` FLOAT NOT NULL,
|
||||||
-> `float_nullable` FLOAT NULL DEFAULT NULL,
|
|
||||||
-> PRIMARY KEY (`int_id`));
|
-> PRIMARY KEY (`int_id`));
|
||||||
Query OK, 0 rows affected (0,09 sec)
|
|
||||||
|
|
||||||
mysql> insert into test (`int_id`, `float`) VALUES (1,2);
|
mysql> INSERT INTO test (`int_id`, `float`) VALUES (1,2);
|
||||||
Query OK, 1 row affected (0,00 sec)
|
|
||||||
|
|
||||||
mysql> select * from test;
|
mysql> SELECT * FROM test;
|
||||||
+------+----------+-----+----------+
|
+--------+-------+
|
||||||
| int_id | int_nullable | float | float_nullable |
|
| int_id | float |
|
||||||
+------+----------+-----+----------+
|
+--------+-------+
|
||||||
| 1 | NULL | 2 | NULL |
|
| 1 | 2 |
|
||||||
+------+----------+-----+----------+
|
+--------+-------+
|
||||||
1 row in set (0,00 sec)
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Selecting data from ClickHouse:
|
Selecting data from ClickHouse:
|
||||||
|
|
||||||
``` sql
|
``` sql
|
||||||
SELECT * FROM mysql('localhost:3306', 'test', 'test', 'bayonet', '123')
|
SELECT * FROM mysql('localhost:3306', 'test', 'test', 'bayonet', '123');
|
||||||
```
|
```
|
||||||
|
|
||||||
``` text
|
``` text
|
||||||
┌─int_id─┬─int_nullable─┬─float─┬─float_nullable─┐
|
┌─int_id─┬─float─┐
|
||||||
│ 1 │ ᴺᵁᴸᴸ │ 2 │ ᴺᵁᴸᴸ │
|
│ 1 │ 2 │
|
||||||
└────────┴──────────────┴───────┴────────────────┘
|
└────────┴───────┘
|
||||||
```
|
```
|
||||||
|
|
||||||
## See Also {#see-also}
|
Replacing and inserting:
|
||||||
|
|
||||||
|
```sql
|
||||||
|
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
|
||||||
|
┌─int_id─┬─float─┐
|
||||||
|
│ 1 │ 3 │
|
||||||
|
│ 2 │ 4 │
|
||||||
|
└────────┴───────┘
|
||||||
|
```
|
||||||
|
|
||||||
|
**See Also**
|
||||||
|
|
||||||
- [The ‘MySQL’ table engine](../../engines/table-engines/integrations/mysql.md)
|
- [The ‘MySQL’ table engine](../../engines/table-engines/integrations/mysql.md)
|
||||||
- [Using MySQL as a source of external dictionary](../../sql-reference/dictionaries/external-dictionaries/external-dicts-dict-sources.md#dicts-external_dicts_dict_sources-mysql)
|
- [Using MySQL as a source of external dictionary](../../sql-reference/dictionaries/external-dictionaries/external-dicts-dict-sources.md#dicts-external_dicts_dict_sources-mysql)
|
||||||
|
|
||||||
[Original article](https://clickhouse.tech/docs/en/query_language/table_functions/mysql/) <!--hide-->
|
[Original article](https://clickhouse.tech/docs/en/sql-reference/table_functions/mysql/) <!--hide-->
|
||||||
|
Loading…
Reference in New Issue
Block a user