ClickHouse/docs/en/sql-reference/statements/attach.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

134 lines
4.3 KiB
Markdown
Raw Normal View History

2020-07-11 11:05:49 +00:00
---
2022-08-28 14:53:34 +00:00
slug: /en/sql-reference/statements/attach
sidebar_position: 40
sidebar_label: ATTACH
2022-08-29 16:19:50 +00:00
title: "ATTACH Statement"
2020-07-11 11:05:49 +00:00
---
2021-08-01 13:02:35 +00:00
Attaches a table or a dictionary, for example, when moving a database to another server.
**Syntax**
``` sql
2023-11-03 00:21:11 +00:00
ATTACH TABLE|DICTIONARY|DATABASE [IF NOT EXISTS] [db.]name [ON CLUSTER cluster] ...
2021-08-01 13:02:35 +00:00
```
2020-07-11 11:05:49 +00:00
2023-11-03 00:34:07 +00:00
The query does not create data on the disk, but assumes that data is already in the appropriate places, and just adds information about the specified table, dictionary or database to the server. After executing the `ATTACH` query, the server will know about the existence of the table, dictionary or database.
2020-07-11 11:05:49 +00:00
2021-08-01 16:17:50 +00:00
If a table was previously detached ([DETACH](../../sql-reference/statements/detach.md) query), meaning that its structure is known, you can use shorthand without defining the structure.
2021-08-01 13:02:35 +00:00
2022-06-02 10:55:18 +00:00
## Attach Existing Table
2021-04-04 12:14:09 +00:00
2021-08-01 13:02:35 +00:00
**Syntax**
2020-07-11 11:05:49 +00:00
``` sql
ATTACH TABLE [IF NOT EXISTS] [db.]name [ON CLUSTER cluster]
```
2021-03-12 16:28:04 +00:00
This query is used when starting the server. The server stores table metadata as files with `ATTACH` queries, which it simply runs at launch (with the exception of some system tables, which are explicitly created on the server).
If the table was detached permanently, it won't be reattached at the server start, so you need to use `ATTACH` query explicitly.
2022-06-02 10:55:18 +00:00
## Create New Table And Attach Data
2021-04-04 12:14:09 +00:00
2022-06-02 10:55:18 +00:00
### With Specified Path to Table Data
2021-04-04 12:14:09 +00:00
2021-08-03 20:47:09 +00:00
The query creates a new table with provided structure and attaches table data from the provided directory in `user_files`.
2021-08-01 13:02:35 +00:00
**Syntax**
2021-04-04 12:14:09 +00:00
```sql
ATTACH TABLE name FROM 'path/to/data/' (col1 Type1, ...)
```
**Example**
Query:
```sql
DROP TABLE IF EXISTS test;
INSERT INTO TABLE FUNCTION file('01188_attach/test/data.TSV', 'TSV', 's String, n UInt8') VALUES ('test', 42);
ATTACH TABLE test FROM '01188_attach/test' (s String, n UInt8) ENGINE = File(TSV);
SELECT * FROM test;
```
Result:
```sql
┌─s────┬──n─┐
│ test │ 42 │
└──────┴────┘
```
2022-06-02 10:55:18 +00:00
### With Specified Table UUID
2021-08-03 20:47:09 +00:00
This query creates a new table with provided structure and attaches data from the table with the specified UUID.
It is supported by the [Atomic](../../engines/database-engines/atomic.md) database engine.
**Syntax**
2021-04-04 12:14:09 +00:00
```sql
ATTACH TABLE name UUID '<uuid>' (col1 Type1, ...)
```
2024-06-17 23:01:07 +00:00
## Attach MergeTree table as ReplicatedMergeTree
Allows to attach non-replicated MergeTree table as ReplicatedMergeTree. ReplicatedMergeTree table will be created with values of `default_replica_path` and `default_replica_name` settings. It is also possible to attach a replicated table as a regular MergeTree.
Note that table's data in ZooKeeper is not affected in this query. This means you have to add metadata in ZooKeeper using `SYSTEM RESTORE REPLICA` or clear it with `SYSTEM DROP REPLICA ... FROM ZKPATH ...` after attach.
If you are trying to add a replica to an existing ReplicatedMergeTree table, keep in mind that all the data in converted MergeTree table will be replicated as well.
**Syntax**
```sql
ATTACH TABLE [db.]name AS [NOT] REPLICATED
```
**Сonvert table to replicated**
```sql
DETACH TABLE test;
ATTACH TABLE test AS REPLICATED;
SYSTEM RESTORE REPLICA test;
```
**Сonvert table to not replicated**
Get ZooKeeper path and replica name for table:
```sql
SELECT replica_name, zookeeper_path FROM system.replicas WHERE table='test';
```
Result:
```
┌─replica_name─┬─zookeeper_path─────────────────────────────────────────────┐
│ r1 │ /clickhouse/tables/401e6a1f-9bf2-41a3-a900-abb7e94dff98/s1 │
└──────────────┴────────────────────────────────────────────────────────────┘
```
Attach table as not replicated and delete replica's data from ZooKeeper:
```sql
DETACH TABLE test;
ATTACH TABLE test AS NOT REPLICATED;
SYSTEM DROP REPLICA 'r1' FROM ZKPATH '/clickhouse/tables/401e6a1f-9bf2-41a3-a900-abb7e94dff98/s1';
```
2022-06-02 10:55:18 +00:00
## Attach Existing Dictionary
2021-08-01 13:02:35 +00:00
2021-08-03 20:47:09 +00:00
Attaches a previously detached dictionary.
2021-08-01 13:02:35 +00:00
**Syntax**
``` sql
ATTACH DICTIONARY [IF NOT EXISTS] [db.]name [ON CLUSTER cluster]
```
2023-11-03 00:21:11 +00:00
## Attach Existing Database
Attaches a previously detached database.
**Syntax**
``` sql
ATTACH DATABASE [IF NOT EXISTS] name [ENGINE=<database engine>] [ON CLUSTER cluster]
```