2020-04-03 13:23:32 +00:00
---
2022-08-28 14:53:34 +00:00
slug: /en/engines/table-engines/special/join
2022-04-09 13:29:05 +00:00
sidebar_position: 70
sidebar_label: Join
2020-04-03 13:23:32 +00:00
---
2022-06-02 10:55:18 +00:00
# Join Table Engine
2017-04-03 19:49:50 +00:00
2022-11-09 00:17:58 +00:00
Optional prepared data structure for usage in [JOIN ](/docs/en/sql-reference/statements/select/join.md/#select-join ) operations.
2020-06-10 20:14:00 +00:00
2022-04-09 13:29:05 +00:00
:::note
2022-11-09 00:17:58 +00:00
This is not an article about the [JOIN clause ](/docs/en/sql-reference/statements/select/join.md/#select-join ) itself.
2022-04-09 13:29:05 +00:00
:::
2019-06-21 07:58:15 +00:00
2020-03-18 18:43:51 +00:00
## Creating a Table {#creating-a-table}
2017-06-13 20:35:07 +00:00
2020-03-20 10:10:48 +00:00
``` sql
2019-06-21 07:58:15 +00:00
CREATE TABLE [IF NOT EXISTS] [db.]table_name [ON CLUSTER cluster]
(
name1 [type1] [DEFAULT|MATERIALIZED|ALIAS expr1] [TTL expr1],
name2 [type2] [DEFAULT|MATERIALIZED|ALIAS expr2] [TTL expr2],
) ENGINE = Join(join_strictness, join_type, k1[, k2, ...])
```
2022-11-09 00:17:58 +00:00
See the detailed description of the [CREATE TABLE ](/docs/en/sql-reference/statements/create/table.md/#create-table-query ) query.
2019-06-21 07:58:15 +00:00
2022-06-24 16:16:20 +00:00
## Engine Parameters
2019-06-21 07:58:15 +00:00
2022-06-24 16:16:20 +00:00
### join_strictness
2022-11-09 00:17:58 +00:00
`join_strictness` – [JOIN strictness ](/docs/en/sql-reference/statements/select/join.md/#select-join-types ).
2022-06-24 16:16:20 +00:00
### join_type
2022-11-09 00:17:58 +00:00
`join_type` – [JOIN type ](/docs/en/sql-reference/statements/select/join.md/#select-join-types ).
2022-06-24 16:16:20 +00:00
### Key columns
`k1[, k2, ...]` – Key columns from the `USING` clause that the `JOIN` operation is made with.
2019-06-21 07:58:15 +00:00
2021-05-27 19:44:11 +00:00
Enter `join_strictness` and `join_type` parameters without quotes, for example, `Join(ANY, LEFT, col1)` . They must match the `JOIN` operation that the table will be used for. If the parameters do not match, ClickHouse does not throw an exception and may return incorrect data.
2019-06-21 07:58:15 +00:00
2021-08-01 05:29:29 +00:00
## Specifics and Recommendations {#specifics-and-recommendations}
2019-06-21 07:58:15 +00:00
2021-08-01 05:29:29 +00:00
### Data Storage {#data-storage}
`Join` table data is always located in the RAM. When inserting rows into a table, ClickHouse writes data blocks to the directory on the disk so that they can be restored when the server restarts.
If the server restarts incorrectly, the data block on the disk might get lost or damaged. In this case, you may need to manually delete the file with damaged data.
### Selecting and Inserting Data {#selecting-and-inserting-data}
You can use `INSERT` queries to add data to the `Join` -engine tables. If the table was created with the `ANY` strictness, data for duplicate keys are ignored. With the `ALL` strictness, all rows are added.
2021-08-09 07:52:04 +00:00
Main use-cases for `Join` -engine tables are following:
2021-08-01 05:29:29 +00:00
2023-04-19 15:55:29 +00:00
- Place the table to the right side in a `JOIN` clause.
- Call the [joinGet ](/docs/en/sql-reference/functions/other-functions.md/#joinget ) function, which lets you extract data from the table the same way as from a dictionary.
2021-08-01 05:29:29 +00:00
### Deleting Data {#deleting-data}
2022-11-16 02:32:44 +00:00
`ALTER DELETE` queries for `Join` -engine tables are implemented as [mutations ](/docs/en/sql-reference/statements/alter/index.md#mutations ). `DELETE` mutation reads filtered data and overwrites data of memory and disk.
2021-08-01 05:29:29 +00:00
### Limitations and Settings {#join-limitations-and-settings}
When creating a table, the following settings are applied:
2022-06-24 16:16:20 +00:00
#### join_use_nulls
2022-11-09 00:17:58 +00:00
[join_use_nulls ](/docs/en/operations/settings/settings.md/#join_use_nulls )
2022-06-24 16:16:20 +00:00
#### max_rows_in_join
2022-11-09 00:17:58 +00:00
[max_rows_in_join ](/docs/en/operations/settings/query-complexity.md/#settings-max_rows_in_join )
2022-06-24 16:16:20 +00:00
#### max_bytes_in_join
2022-11-09 00:17:58 +00:00
[max_bytes_in_join ](/docs/en/operations/settings/query-complexity.md/#settings-max_bytes_in_join )
2022-06-24 16:16:20 +00:00
#### join_overflow_mode
2022-11-09 00:17:58 +00:00
[join_overflow_mode ](/docs/en/operations/settings/query-complexity.md/#settings-join_overflow_mode )
2022-06-24 16:16:20 +00:00
#### join_any_take_last_row
2022-11-09 00:17:58 +00:00
[join_any_take_last_row ](/docs/en/operations/settings/settings.md/#settings-join_any_take_last_row )
2022-06-24 16:16:20 +00:00
#### join_use_nulls
2023-01-06 22:01:28 +00:00
#### persistent
Disables persistency for the Join and [Set ](/docs/en/engines/table-engines/special/set.md ) table engines.
Reduces the I/O overhead. Suitable for scenarios that pursue performance and do not require persistence.
Possible values:
- 1 — Enabled.
- 0 — Disabled.
Default value: `1` .
2021-08-01 05:29:29 +00:00
The `Join` -engine tables can’ t be used in `GLOBAL JOIN` operations.
2022-11-09 00:17:58 +00:00
The `Join` -engine allows to specify [join_use_nulls ](/docs/en/operations/settings/settings.md/#join_use_nulls ) setting in the `CREATE TABLE` statement. [SELECT ](/docs/en/sql-reference/statements/select/index.md ) query should have the same `join_use_nulls` value.
2021-08-01 05:29:29 +00:00
## Usage Examples {#example}
2019-06-21 07:58:15 +00:00
Creating the left-side table:
2020-03-20 10:10:48 +00:00
``` sql
2021-08-01 05:29:29 +00:00
CREATE TABLE id_val(`id` UInt32, `val` UInt32) ENGINE = TinyLog;
2019-07-31 14:49:16 +00:00
```
2020-03-20 10:10:48 +00:00
``` sql
2021-08-01 05:29:29 +00:00
INSERT INTO id_val VALUES (1,11)(2,12)(3,13);
2017-12-28 15:13:23 +00:00
```
2017-06-13 04:15:47 +00:00
2019-06-21 07:58:15 +00:00
Creating the right-side `Join` table:
2017-04-03 19:49:50 +00:00
2020-03-20 10:10:48 +00:00
``` sql
2021-08-01 05:29:29 +00:00
CREATE TABLE id_val_join(`id` UInt32, `val` UInt8) ENGINE = Join(ANY, LEFT, id);
2019-07-31 14:49:16 +00:00
```
2020-03-20 10:10:48 +00:00
``` sql
2021-08-01 05:29:29 +00:00
INSERT INTO id_val_join VALUES (1,21)(1,22)(3,23);
2019-06-21 07:58:15 +00:00
```
2017-04-03 19:49:50 +00:00
2019-06-21 07:58:15 +00:00
Joining the tables:
2019-05-27 19:34:04 +00:00
2020-03-20 10:10:48 +00:00
``` sql
2021-08-01 05:29:29 +00:00
SELECT * FROM id_val ANY LEFT JOIN id_val_join USING (id);
2019-06-21 07:58:15 +00:00
```
2020-03-20 10:10:48 +00:00
``` text
2019-06-21 07:58:15 +00:00
┌─id─┬─val─┬─id_val_join.val─┐
│ 1 │ 11 │ 21 │
2021-08-01 05:29:29 +00:00
│ 2 │ 12 │ 0 │
2019-06-21 07:58:15 +00:00
│ 3 │ 13 │ 23 │
└────┴─────┴─────────────────┘
```
2017-04-03 19:49:50 +00:00
2019-07-31 14:49:16 +00:00
As an alternative, you can retrieve data from the `Join` table, specifying the join key value:
2017-12-28 15:13:23 +00:00
2020-03-20 10:10:48 +00:00
``` sql
2021-08-01 05:29:29 +00:00
SELECT joinGet('id_val_join', 'val', toUInt32(1));
2019-05-27 19:34:04 +00:00
```
2020-03-20 10:10:48 +00:00
``` text
2019-06-21 07:58:15 +00:00
┌─joinGet('id_val_join', 'val', toUInt32(1))─┐
│ 21 │
└────────────────────────────────────────────┘
2019-05-27 19:34:04 +00:00
```
2021-08-01 05:29:29 +00:00
Deleting a row from the `Join` table:
2019-06-21 07:58:15 +00:00
2021-08-01 05:29:29 +00:00
```sql
ALTER TABLE id_val_join DELETE WHERE id = 3;
```
2018-10-16 10:47:17 +00:00
2021-08-01 05:29:29 +00:00
```text
┌─id─┬─val─┐
│ 1 │ 21 │
└────┴─────┘
```