[Doc] Doc for Modifying Column Comment (backport #62951) (#62955)

Signed-off-by: 絵空事スピリット <wanglichen@starrocks.com>
Co-authored-by: 絵空事スピリット <wanglichen@starrocks.com>
This commit is contained in:
mergify[bot] 2025-09-10 16:45:06 -04:00 committed by GitHub
parent 35ae03962e
commit 15827a307c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 43 additions and 47 deletions

View File

@ -4,13 +4,15 @@ displayed_sidebar: docs
# ALTER TABLE
import Beta from '../../../_assets/commonMarkdown/_beta.mdx'
ALTER TABLE Modifies an existing table, including:
- [Rename table, partition, rollup, or column](#rename)
- [Modify table comment](#alter-table-comment-from-v31)
- [Modify partitions (add/delete partitions and modify partition attributes)](#modify-partition)
- [Modify the bucketing method and number of buckets](#modify-the-bucketing-method-and-number-of-buckets-from-v32)
- [Modify columns (add/delete columns and change the order of columns)](#modify-columns-adddelete-columns-change-the-order-of-columns)
- [Modify columns (add/delete columns, change column order, and modify column comment)](#modify-columns-adddelete-columns-change-column-order-modify-column-comment)
- [Create/delete rollup](#modify-rollup)
- [Create/delete index](#modify-indexes)
- [Modify table properties](#modify-table-properties)
@ -35,7 +37,7 @@ alter_clause1[, alter_clause2, ...]
- comment: modifies the table comment (supported from **v3.1 onwards**).
- partition: modifies partition properties, drops a partition, or adds a partition.
- bucket: modifies the bucketing method and number of buckets.
- column: adds, drops, or reorders columns, or modifies column type.
- column: adds, drops, or reorders columns, modifies column type or comment
- rollup: creates or drops a rollup.
- index: modifies indexes.
- swap: atomic exchange of two tables.
@ -44,8 +46,7 @@ alter_clause1[, alter_clause2, ...]
## Limits and usage notes
- Operations on partition, column, and rollup cannot be performed in one ALTER TABLE statement.
- Column comments cannot be modified.
- Operations on partition, column, and rollup index cannot be performed in one ALTER TABLE statement.
- One table can have only one ongoing schema change operation at a time. You cannot run two schema change commands on a table at the same time.
- Operations on bucket, column and rollup are asynchronous operations. A success message is return immediately after the task is submitted. You can run the [SHOW ALTER TABLE](SHOW_ALTER.md) command to check the progress, and run the [CANCEL ALTER TABLE](CANCEL_ALTER_TABLE.md) command to cancel the operation.
- Operations on rename, comment, partition, index and swap are synchronous operations, and a command return indicates that the execution is finished.
@ -98,10 +99,6 @@ Syntax:
ALTER TABLE [<db_name>.]<tbl_name> COMMENT = "<new table comment>";
```
:::tip
Currently, column comments cannot be modified.
:::
### Modify partition
#### ADD PARTITION(S)
@ -434,7 +431,7 @@ INSERT INTO details (event_time, event_type, user_id, device_code, channel) VALU
ALTER TABLE details DISTRIBUTED BY HASH(user_id, event_time) BUCKETS 10;
``
### Modify columns (add/delete columns, change the order of columns)
### Modify columns (add/delete columns, change column order, modify column comment)
#### Add a column to the specified location of the specified index
@ -512,16 +509,18 @@ Note:
1. You cannot drop partition column.
2. If the column is dropped from the base index, it will also be dropped if it is included in the rollup.
#### Modify the column type and column position of specified index
#### Modify the column type, position, comment, and other properties
Syntax:
```sql
ALTER TABLE [<db_name>.]<tbl_name>
MODIFY COLUMN column_name column_type [KEY | agg_type] [NULL | NOT NULL] [DEFAULT "default_value"]
[AFTER column_name|FIRST]
[FROM rollup_index_name]
[PROPERTIES ("key"="value", ...)]
MODIFY COLUMN <column_name>
[ column_type [ KEY | agg_type ] ] [ NULL | NOT NULL ]
[ DEFAULT "<default_value>"] [ COMMENT "<new_column_comment>" ]
[ AFTER <column_name> | FIRST ]
[ FROM rollup_index_name ]
[ PROPERTIES ("key"="value", ...) ]
```
Note:
@ -542,6 +541,7 @@ Note:
- Convert INT to DATE (If the INT data fails to convert, the original data remains the same)
6. Conversion from NULL to NOT NULL is not supported.
7. You can modify several properties in a single MODIFY COLUMN clause. However, some combination of properties are not supported.
#### Reorder the columns of specified index
@ -602,8 +602,6 @@ Decouple the sort key from the primary key, and modify the sort key to `dt, reve
ALTER TABLE orders ORDER BY (dt, revenue, state);
```
import Beta from '../../../_assets/commonMarkdown/_beta.mdx'
#### Modify a STRUCT column to add or drop a field
<Beta />

View File

@ -4,13 +4,17 @@ displayed_sidebar: docs
# ALTER TABLE
import Beta from '../../../_assets/commonMarkdown/_beta.mdx'
## 説明
ALTER TABLE は既存のテーブルを修正します。以下を含みます:
- [テーブル、パーティション、ロールアップ、または列の名前変更](#rename)
- [テーブルコメントの修正](#alter-table-comment-from-v31)
- [パーティションの修正(パーティションの追加/削除とパーティション属性の修正)](#modify-partition)
- [バケッティング方法とバケット数の修正](#modify-the-bucketing-method-and-number-of-buckets-from-v32)
- [列の修正(列の追加/削除と列の順序変更)](#modify-columns-adddelete-columns-change-the-order-of-columns)
- [列の変更(列の追加/削除、列順の変更、列コメントの変更)](#modify-columns-adddelete-columns-change-the-order-of-columns)
- [ロールアップの作成/削除](#modify-rollup)
- [インデックスの作成/削除](#modify-indexes)
- [テーブルプロパティの修正](#modify-table-properties)
@ -35,7 +39,7 @@ alter_clause1[, alter_clause2, ...]
- コメント: テーブルコメントを修正します(**v3.1 以降でサポート**)。
- パーティション: パーティションプロパティを修正、パーティションを削除、またはパーティションを追加します。
- バケット: バケッティング方法とバケット数を修正します。
- 列: 列を追加、削除、再配置、または列タイプを修正します。
- 列: 列の追加、削除、並び替え、列のタイプの変更、コメントの変更
- ロールアップ: ロールアップを作成または削除します。
- インデックス: インデックスを修正します。
- スワップ: 2つのテーブルをアトミックに交換します。
@ -45,7 +49,6 @@ alter_clause1[, alter_clause2, ...]
## 制限と使用上の注意
- パーティション、列、ロールアップに対する操作は、1つの ALTER TABLE ステートメントで実行できません。
- 列コメントは修正できません。
- 1つのテーブルには、同時に1つのスキーマ変更操作しか実行できません。1つのテーブルに対して同時に2つのスキーマ変更コマンドを実行することはできません。
- バケット、列、ロールアップに対する操作は非同期操作です。タスクが送信された後、成功メッセージが即座に返されます。進捗を確認するには [SHOW ALTER TABLE](SHOW_ALTER.md) コマンドを実行し、操作をキャンセルするには [CANCEL ALTER TABLE](CANCEL_ALTER_TABLE.md) コマンドを実行できます。
- 名前変更、コメント、パーティション、インデックス、スワップに対する操作は同期操作であり、コマンドの返り値は実行が完了したことを示します。
@ -98,11 +101,7 @@ RENAME COLUMN <old_col_name> [ TO ] <new_col_name>
ALTER TABLE [<db_name>.]<tbl_name> COMMENT = "<new table comment>";
```
:::tip
現在、列コメントは修正できません。
:::
### パーティションの修正
### パーティションの変更
#### パーティションの追加
@ -434,7 +433,7 @@ INSERT INTO details (event_time, event_type, user_id, device_code, channel) VALU
ALTER TABLE details DISTRIBUTED BY HASH(user_id, event_time) BUCKETS 10;
```
### 列の修正(列の追加/削除、列の順序変更)
### 列の変更(列の追加/削除、列順の変更、列コメントの変更)
#### 指定されたインデックスの指定された位置に列を追加する
@ -512,16 +511,18 @@ DROP COLUMN column_name
1. パーティション列を削除することはできません。
2. 列が基本インデックスから削除された場合、ロールアップに含まれている場合も削除されます。
#### 指定されたインデックスの列タイプと列位置を修正する
#### 列の型、位置、コメント、その他のプロパティを変更する
構文:
```sql
ALTER TABLE [<db_name>.]<tbl_name>
MODIFY COLUMN column_name column_type [KEY | agg_type] [NULL | NOT NULL] [DEFAULT "default_value"]
[AFTER column_name|FIRST]
[FROM rollup_index_name]
[PROPERTIES ("key"="value", ...)]
MODIFY COLUMN <column_name>
[ column_type [ KEY | agg_type ] ] [ NULL | NOT NULL ]
[ DEFAULT "<default_value>"] [ COMMENT "<new_column_comment>" ]
[ AFTER <column_name> | FIRST ]
[ FROM rollup_index_name ]
[ PROPERTIES ("key"="value", ...) ]
```
注意:
@ -542,6 +543,7 @@ MODIFY COLUMN column_name column_type [KEY | agg_type] [NULL | NOT NULL] [DEFAUL
- INT を DATE に変換しますINT データの変換に失敗した場合、元のデータはそのままです)。
6. NULL から NOT NULL への変換はサポートされていません。
7. 単一のMODIFY COLUMN句で複数のプロパティを変更できます。ただし、一部のプロパティの組み合わせはサポートされていません。
#### 指定されたインデックスの列を再配置する
@ -602,8 +604,6 @@ DISTRIBUTED BY HASH(order_id);
ALTER TABLE orders ORDER BY (dt, revenue, state);
```
import Beta from '../../../_assets/commonMarkdown/_beta.mdx'
#### STRUCT 列を修正してフィールドを追加または削除する
<Beta />

View File

@ -4,6 +4,8 @@ displayed_sidebar: docs
# ALTER TABLE
import Beta from '../../../_assets/commonMarkdown/_beta.mdx'
## 描述
修改现有表,包括:
@ -12,7 +14,7 @@ displayed_sidebar: docs
- [修改表注释](#修改表的注释31-版本起)
- [修改分区(增删分区和修改分区属性)](#操作-partition-相关语法)
- [修改分桶方式和分桶数量](#修改分桶方式和分桶数量自-32-版本起)
- [修改列(增删列和修改列顺序](#修改列增删列和修改列顺序)
- [修改列(增删列和修改列顺序和注释)](#修改列添加删除列改变列的顺序或注释)
- [创建或删除 rollup index](#操作-rollup-index-语法)
- [修改 bitmap index](#bitmap-index-修改)
- [修改表的属性](#修改表的属性)
@ -37,7 +39,7 @@ alter_clause1[, alter_clause2, ...]
- comment: 修改表的注释。**从 3.1 版本开始支持。**
- partition: 修改分区属性,删除分区,增加分区。
- bucket修改分桶方式和分桶数量。
- column: 增加列,删除列,调整列顺序,修改列类型。*
- column: 增加列,删除列,调整列顺序,修改列类型以及注释
- rollup: 创建或删除 Rollup。
- index: 修改索引。
- swap: 原子替换两张表。
@ -47,7 +49,6 @@ alter_clause1[, alter_clause2, ...]
## 限制和使用注意事项
- 在一个ALTER TABLE语句中不能同时对分区、列和 Rollup 进行操作。
- 列注释不能被修改。
- 一个表一次只能有一个正在进行的schema change操作。不能同时在一个表上运行两个schema change命令。
- 对分桶、列和 Rollup 的操作是异步操作。任务提交后会立即返回成功消息。可以运行[SHOW ALTER TABLE](SHOW_ALTER.md)命令检查进度,并运行[CANCEL ALTER TABLE](CANCEL_ALTER_TABLE.md)命令取消操作。
- 对重命名、注释、分区、索引和原子替换的操作是同步操作,命令返回表示执行已完成。
@ -100,10 +101,6 @@ RENAME COLUMN <old_col_name> [ TO ] <new_col_name>
ALTER TABLE [<db_name>.]<tbl_name> COMMENT = "<new table comment>";
```
:::tip
目前,列注释不能被修改。
:::
### 修改分区
#### 添加分区
@ -436,7 +433,7 @@ INSERT INTO details (event_time, event_type, user_id, device_code, channel) VALU
ALTER TABLE details DISTRIBUTED BY HASH(user_id, event_time) BUCKETS 10;
```
### 修改列(添加/删除列,改变列的顺序)
### 修改列(添加/删除列,改变列的顺序或注释
#### 在指定索引的指定位置添加列
@ -514,16 +511,18 @@ DROP COLUMN column_name
1. 不能删除分区列。
2. 如果从基础索引中删除列,并且该列包含在 Rollup 中,也会被删除。
#### 修改指定索引的列类型和列位置
#### 修改列类型、位置、注释和其他属性
语法:
```sql
ALTER TABLE [<db_name>.]<tbl_name>
MODIFY COLUMN column_name column_type [KEY | agg_type] [NULL | NOT NULL] [DEFAULT "default_value"]
[AFTER column_name|FIRST]
[FROM rollup_index_name]
[PROPERTIES ("key"="value", ...)]
MODIFY COLUMN <column_name>
[ column_type [ KEY | agg_type ] ] [ NULL | NOT NULL ]
[ DEFAULT "<default_value>"] [ COMMENT "<new_column_comment>" ]
[ AFTER <column_name> | FIRST ]
[ FROM rollup_index_name ]
[ PROPERTIES ("key"="value", ...) ]
```
注意:
@ -544,6 +543,7 @@ MODIFY COLUMN column_name column_type [KEY | agg_type] [NULL | NOT NULL] [DEFAUL
- 将INT转换为DATE如果INT数据转换失败原始数据保持不变
6. 不支持从NULL转换为NOT NULL。
7. 您可以在单个 MODIFY COLUMN 子句中修改多个属性。但某些属性的组合不支持。
#### 重新排序指定索引的列
@ -604,8 +604,6 @@ DISTRIBUTED BY HASH(order_id);
ALTER TABLE orders ORDER BY (dt, revenue, state);
```
import Beta from '../../../_assets/commonMarkdown/_beta.mdx'
#### 修改STRUCT列以添加或删除字段
<Beta />