ClickHouse/docs/en/engines/database-engines/atomic.md

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

63 lines
3.5 KiB
Markdown
Raw Permalink Normal View History

2021-02-15 20:46:13 +00:00
---
2022-08-28 14:53:34 +00:00
slug: /en/engines/database-engines/atomic
sidebar_label: Atomic
sidebar_position: 10
2021-02-15 20:46:13 +00:00
---
# Atomic
2021-02-15 20:46:13 +00:00
It supports non-blocking [DROP TABLE](#drop-detach-table) and [RENAME TABLE](#rename-table) queries and atomic [EXCHANGE TABLES](#exchange-tables) queries. `Atomic` database engine is used by default.
2021-03-11 10:06:32 +00:00
2021-02-15 20:46:13 +00:00
## Creating a Database {#creating-a-database}
2021-03-21 21:22:51 +00:00
2021-02-15 20:46:13 +00:00
``` sql
CREATE DATABASE test [ENGINE = Atomic];
2021-02-15 20:46:13 +00:00
```
2021-03-22 21:08:08 +00:00
## Specifics and recommendations {#specifics-and-recommendations}
2021-02-15 20:46:13 +00:00
2021-04-01 12:50:47 +00:00
### Table UUID {#table-uuid}
2021-02-15 20:46:13 +00:00
2021-07-29 15:20:55 +00:00
All tables in database `Atomic` have persistent [UUID](../../sql-reference/data-types/uuid.md) and store data in directory `/clickhouse_path/store/xxx/xxxyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy/`, where `xxxyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy` is UUID of the table.
Usually, the UUID is generated automatically, but the user can also explicitly specify the UUID in the same way when creating the table (this is not recommended).
For example:
2021-02-15 20:46:13 +00:00
2021-04-01 12:50:47 +00:00
```sql
CREATE TABLE name UUID '28f1c61c-2970-457a-bffe-454156ddcfef' (n UInt64) ENGINE = ...;
```
:::note
You can use the [show_table_uuid_in_table_create_query_if_not_nil](../../operations/settings/settings.md#show_table_uuid_in_table_create_query_if_not_nil) setting to display the UUID with the `SHOW CREATE` query.
:::
2021-04-01 12:50:47 +00:00
### RENAME TABLE {#rename-table}
2021-02-15 20:46:13 +00:00
[RENAME](../../sql-reference/statements/rename.md) queries are performed without changing the UUID or moving table data. These queries do not wait for the completion of queries using the table and are executed instantly.
2021-04-01 12:50:47 +00:00
2021-04-02 19:16:48 +00:00
### DROP/DETACH TABLE {#drop-detach-table}
2021-02-15 20:46:13 +00:00
On `DROP TABLE` no data is removed, database `Atomic` just marks table as dropped by moving metadata to `/clickhouse_path/metadata_dropped/` and notifies background thread. Delay before final table data deletion is specified by the [database_atomic_delay_before_drop_table_sec](../../operations/server-configuration-parameters/settings.md#database_atomic_delay_before_drop_table_sec) setting.
2021-04-02 11:43:13 +00:00
You can specify synchronous mode using `SYNC` modifier. Use the [database_atomic_wait_for_drop_and_detach_synchronously](../../operations/settings/settings.md#database_atomic_wait_for_drop_and_detach_synchronously) setting to do this. In this case `DROP` waits for running `SELECT`, `INSERT` and other queries which are using the table to finish. Table will be actually removed when it's not in use.
2021-03-22 21:08:08 +00:00
### EXCHANGE TABLES/DICTIONARIES {#exchange-tables}
2021-02-15 20:46:13 +00:00
[EXCHANGE](../../sql-reference/statements/exchange.md) query swaps tables or dictionaries atomically. For instance, instead of this non-atomic operation:
2021-02-15 20:46:13 +00:00
2021-04-01 12:50:47 +00:00
```sql
RENAME TABLE new_table TO tmp, old_table TO new_table, tmp TO old_table;
2021-02-15 20:46:13 +00:00
```
2021-04-01 12:50:47 +00:00
you can use one atomic query:
2021-02-15 20:46:13 +00:00
``` sql
2021-04-01 12:50:47 +00:00
EXCHANGE TABLES new_table AND old_table;
2021-02-15 20:46:13 +00:00
```
2021-04-01 12:50:47 +00:00
### ReplicatedMergeTree in Atomic Database {#replicatedmergetree-in-atomic-database}
2021-02-15 20:46:13 +00:00
For [ReplicatedMergeTree](../table-engines/mergetree-family/replication.md#table_engines-replication) tables, it is recommended not to specify engine parameters - path in ZooKeeper and replica name. In this case, configuration parameters [default_replica_path](../../operations/server-configuration-parameters/settings.md#default_replica_path) and [default_replica_name](../../operations/server-configuration-parameters/settings.md#default_replica_name) will be used. If you want to specify engine parameters explicitly, it is recommended to use `{uuid}` macros. This is useful so that unique paths are automatically generated for each table in ZooKeeper.
2021-02-15 20:46:13 +00:00
2021-03-22 21:08:08 +00:00
## See Also
- [system.databases](../../operations/system-tables/databases.md) system table