mirror of
https://github.com/ClickHouse/ClickHouse.git
synced 2024-12-15 10:52:30 +00:00
72 lines
5.8 KiB
Markdown
72 lines
5.8 KiB
Markdown
---
|
|
slug: /en/sql-reference/statements/alter/
|
|
sidebar_position: 35
|
|
sidebar_label: ALTER
|
|
---
|
|
|
|
# ALTER
|
|
|
|
Most `ALTER TABLE` queries modify table settings or data:
|
|
|
|
- [COLUMN](/docs/en/sql-reference/statements/alter/column.md)
|
|
- [PARTITION](/docs/en/sql-reference/statements/alter/partition.md)
|
|
- [DELETE](/docs/en/sql-reference/statements/alter/delete.md)
|
|
- [UPDATE](/docs/en/sql-reference/statements/alter/update.md)
|
|
- [ORDER BY](/docs/en/sql-reference/statements/alter/order-by.md)
|
|
- [INDEX](/docs/en/sql-reference/statements/alter/skipping-index.md)
|
|
- [CONSTRAINT](/docs/en/sql-reference/statements/alter/constraint.md)
|
|
- [TTL](/docs/en/sql-reference/statements/alter/ttl.md)
|
|
- [STATISTICS](/docs/en/sql-reference/statements/alter/statistics.md)
|
|
- [APPLY DELETED MASK](/docs/en/sql-reference/statements/alter/apply-deleted-mask.md)
|
|
|
|
:::note
|
|
Most `ALTER TABLE` queries are supported only for [\*MergeTree](/docs/en/engines/table-engines/mergetree-family/index.md) tables, as well as [Merge](/docs/en/engines/table-engines/special/merge.md) and [Distributed](/docs/en/engines/table-engines/special/distributed.md).
|
|
:::
|
|
|
|
These `ALTER` statements manipulate views:
|
|
|
|
- [ALTER TABLE ... MODIFY QUERY](/docs/en/sql-reference/statements/alter/view.md) — Modifies a [Materialized view](/docs/en/sql-reference/statements/create/view.md/#materialized) structure.
|
|
- [ALTER LIVE VIEW](/docs/en/sql-reference/statements/alter/view.md/#alter-live-view) — Refreshes a [Live view](/docs/en/sql-reference/statements/create/view.md/#live-view).
|
|
|
|
These `ALTER` statements modify entities related to role-based access control:
|
|
|
|
- [USER](/docs/en/sql-reference/statements/alter/user.md)
|
|
- [ROLE](/docs/en/sql-reference/statements/alter/role.md)
|
|
- [QUOTA](/docs/en/sql-reference/statements/alter/quota.md)
|
|
- [ROW POLICY](/docs/en/sql-reference/statements/alter/row-policy.md)
|
|
- [SETTINGS PROFILE](/docs/en/sql-reference/statements/alter/settings-profile.md)
|
|
|
|
[ALTER TABLE ... MODIFY COMMENT](/docs/en/sql-reference/statements/alter/comment.md) statement adds, modifies, or removes comments to the table, regardless if it was set before or not.
|
|
|
|
[ALTER NAMED COLLECTION](/docs/en/sql-reference/statements/alter/named-collection.md) statement modifies [Named Collections](/docs/en/operations/named-collections.md).
|
|
|
|
## Mutations
|
|
|
|
`ALTER` queries that are intended to manipulate table data are implemented with a mechanism called “mutations”, most notably [ALTER TABLE ... DELETE](/docs/en/sql-reference/statements/alter/delete.md) and [ALTER TABLE ... UPDATE](/docs/en/sql-reference/statements/alter/update.md). They are asynchronous background processes similar to merges in [MergeTree](/docs/en/engines/table-engines/mergetree-family/index.md) tables that to produce new “mutated” versions of parts.
|
|
|
|
For `*MergeTree` tables mutations execute by **rewriting whole data parts**. There is no atomicity - parts are substituted for mutated parts as soon as they are ready and a `SELECT` query that started executing during a mutation will see data from parts that have already been mutated along with data from parts that have not been mutated yet.
|
|
|
|
Mutations are totally ordered by their creation order and are applied to each part in that order. Mutations are also partially ordered with `INSERT INTO` queries: data that was inserted into the table before the mutation was submitted will be mutated and data that was inserted after that will not be mutated. Note that mutations do not block inserts in any way.
|
|
|
|
A mutation query returns immediately after the mutation entry is added (in case of replicated tables to ZooKeeper, for non-replicated tables - to the filesystem). The mutation itself executes asynchronously using the system profile settings. To track the progress of mutations you can use the [`system.mutations`](/docs/en/operations/system-tables/mutations.md/#system_tables-mutations) table. A mutation that was successfully submitted will continue to execute even if ClickHouse servers are restarted. There is no way to roll back the mutation once it is submitted, but if the mutation is stuck for some reason it can be cancelled with the [`KILL MUTATION`](/docs/en/sql-reference/statements/kill.md/#kill-mutation) query.
|
|
|
|
Entries for finished mutations are not deleted right away (the number of preserved entries is determined by the `finished_mutations_to_keep` storage engine parameter). Older mutation entries are deleted.
|
|
|
|
## Synchronicity of ALTER Queries
|
|
|
|
For non-replicated tables, all `ALTER` queries are performed synchronously. For replicated tables, the query just adds instructions for the appropriate actions to `ZooKeeper`, and the actions themselves are performed as soon as possible. However, the query can wait for these actions to be completed on all the replicas.
|
|
|
|
For `ALTER` queries that creates mutations (e.g.: including, but not limited to `UPDATE`, `DELETE`, `MATERIALIZE INDEX`, `MATERIALIZE PROJECTION`, `MATERIALIZE COLUMN`, `APPLY DELETED MASK`, `CLEAR STATISTIC`, `MATERIALIZE STATISTIC`) the synchronicity is defined by the [mutations_sync](/docs/en/operations/settings/settings.md/#mutations_sync) setting.
|
|
|
|
For other `ALTER` queries which only modify the metadata, you can use the [alter_sync](/docs/en/operations/settings/settings.md/#alter-sync) setting to set up waiting.
|
|
|
|
You can specify how long (in seconds) to wait for inactive replicas to execute all `ALTER` queries with the [replication_wait_for_inactive_replica_timeout](/docs/en/operations/settings/settings.md/#replication-wait-for-inactive-replica-timeout) setting.
|
|
|
|
:::note
|
|
For all `ALTER` queries, if `alter_sync = 2` and some replicas are not active for more than the time, specified in the `replication_wait_for_inactive_replica_timeout` setting, then an exception `UNFINISHED` is thrown.
|
|
:::
|
|
|
|
## Related content
|
|
|
|
- Blog: [Handling Updates and Deletes in ClickHouse](https://clickhouse.com/blog/handling-updates-and-deletes-in-clickhouse)
|