title_wip

[Edit this page](https://github.com/ClickHouse/ClickHouse/tree/master/docs/en/engines/table-engines/special/join.md)

Optional prepared data structure for usage in [JOIN](/docs/sql-reference/statements/select/join) operations.

Note

In ClickHouse Cloud, if your service was created with a version earlier than 25.4, you will need to set the compatibility to at least 25.4 using `SET compatibility=25.4`.

## Creating a table[​](#creating-a-table "Direct link to Creating a table")

```
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, ...])
```

See the detailed description of the [CREATE TABLE](/docs/sql-reference/statements/create/table) query.

## Engine parameters[​](#engine-parameters "Direct link to Engine parameters")

### `join_strictness`[​](#join_strictness "Direct link to join_strictness")

`join_strictness` – [JOIN strictness](/docs/sql-reference/statements/select/join#supported-types-of-join).

### `join_type`[​](#join_type "Direct link to join_type")

`join_type` – [JOIN type](/docs/sql-reference/statements/select/join#supported-types-of-join).

### Key columns[​](#key-columns "Direct link to Key columns")

`k1[, k2, ...]` – Key columns from the `USING` clause that the `JOIN` operation is made with.

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.

## Specifics and recommendations[​](#specifics-and-recommendations "Direct link to Specifics and recommendations")

### Data storage[​](#data-storage "Direct link to 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 "Direct link to 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.

Main use-cases for `Join`-engine tables are following:

- Place the table to the right side in a `JOIN` clause.
- Call the [joinGet](/docs/sql-reference/functions/other-functions#joinGet) function, which lets you extract data from the table the same way as from a dictionary.

### Deleting data[​](#deleting-data "Direct link to Deleting data")

`ALTER DELETE` queries for `Join`-engine tables are implemented as [mutations](/docs/sql-reference/statements/alter#mutations). `DELETE` mutation reads filtered data and overwrites data of memory and disk.

### Limitations and settings[​](#join-limitations-and-settings "Direct link to Limitations and settings")

When creating a table, the following settings are applied:

#### `join_use_nulls`[​](#join_use_nulls "Direct link to join_use_nulls")

[join\_use\_nulls](/docs/operations/settings/settings#join_use_nulls)

#### `max_rows_in_join`[​](#max_rows_in_join "Direct link to max_rows_in_join")

[max\_rows\_in\_join](/docs/operations/settings/settings#max_rows_in_join)

#### `max_bytes_in_join`[​](#max_bytes_in_join "Direct link to max_bytes_in_join")

[max\_bytes\_in\_join](/docs/operations/settings/settings#max_bytes_in_join)

#### `join_overflow_mode`[​](#join_overflow_mode "Direct link to join_overflow_mode")

[join\_overflow\_mode](/docs/operations/settings/settings#join_overflow_mode)

#### `join_any_take_last_row`[​](#join_any_take_last_row "Direct link to join_any_take_last_row")

[join\_any\_take\_last\_row](/docs/operations/settings/settings#join_any_take_last_row)

#### `join_use_nulls`[​](#join_use_nulls-1 "Direct link to join_use_nulls-1")

#### Persistent[​](#persistent "Direct link to Persistent")

Disables persistency for the Join and [Set](/docs/engines/table-engines/special/set) 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`.

The `Join`-engine tables can't be used in `GLOBAL JOIN` operations.

The `Join`-engine allows to specify [join\_use\_nulls](/docs/operations/settings/settings#join_use_nulls) setting in the `CREATE TABLE` statement. [SELECT](/docs/sql-reference/statements/select) query should have the same `join_use_nulls` value.

## Usage examples[​](#example "Direct link to Usage examples")

Creating the left-side table:

```
CREATE TABLE id_val(`id` UInt32, `val` UInt32) ENGINE = TinyLog;
```

```
INSERT INTO id_val VALUES (1,11)(2,12)(3,13);
```

Creating the right-side `Join` table:

```
CREATE TABLE id_val_join(`id` UInt32, `val` UInt8) ENGINE = Join(ANY, LEFT, id);
```

```
INSERT INTO id_val_join VALUES (1,21)(1,22)(3,23);
```

Joining the tables:

```
SELECT * FROM id_val ANY LEFT JOIN id_val_join USING (id);
```

```
┌─id─┬─val─┬─id_val_join.val─┐
│  1 │  11 │              21 │
│  2 │  12 │               0 │
│  3 │  13 │              23 │
└────┴─────┴─────────────────┘
```

As an alternative, you can retrieve data from the `Join` table, specifying the join key value:

```
SELECT joinGet('id_val_join', 'val', toUInt32(1));
```

```
┌─joinGet('id_val_join', 'val', toUInt32(1))─┐
│                                         21 │
└────────────────────────────────────────────┘
```

Deleting a row from the `Join` table:

```
ALTER TABLE id_val_join DELETE WHERE id = 3;
```

```
┌─id─┬─val─┐
│  1 │  21 │
└────┴─────┘
```

- [Creating a table](#creating-a-table)- [Engine parameters](#engine-parameters)
    - [`join_strictness`](#join_strictness)- [`join_type`](#join_type)- [Key columns](#key-columns)- [Specifics and recommendations](#specifics-and-recommendations)
      - [Data storage](#data-storage)- [Selecting and Inserting Data](#selecting-and-inserting-data)- [Deleting data](#deleting-data)- [Limitations and settings](#join-limitations-and-settings)- [Usage examples](#example)

Was this page helpful?