修改列注释
功能描述
修改非分区表或分区表的列注释信息。Spark 4.0推荐使用ALTER COLUMN语法,同时兼容CHANGE COLUMN语法。
语法格式
- 语法一(推荐,Spark 4.0):
ALTER TABLE [db_name.]table_name ALTER COLUMN col_name COMMENT 'col_comment';
- 语法二(兼容):
ALTER TABLE [db_name.]table_name CHANGE COLUMN col_name col_name col_type COMMENT 'col_comment';
关键字
- ALTER COLUMN:修改列属性(Spark 4.0推荐语法)。
- CHANGE COLUMN:修改列(兼容语法,需同时指定列名和类型)。
- COMMENT:列描述。
参数说明
| 参数 | 是否必选 | 描述 |
|---|---|---|
| db_name | 否 | Database名称,由字母、数字和下划线(_)组成。不能是纯数字,且不能以下划线开头。 |
| table_name | 是 | 表名称。 |
| col_name | 是 | 列字段名称。必须是已存在的列。 |
| col_type | 仅CHANGE COLUMN语法必选 | 列数据类型。CHANGE COLUMN语法不支持修改列数据类型,此处指定的是创建表时的列数据类型。ALTER COLUMN语法无需指定。 |
| col_comment | 是 | 修改后的列注释信息。注释内容为长度不超过1024字节的有效字符串。 |
注意事项
- Spark 4.0推荐使用ALTER COLUMN语法修改列注释,该语法更简洁,无需重复指定列数据类型。
- CHANGE COLUMN语法为兼容语法,使用时必须指定与建表时一致的列数据类型。
示例1:使用ALTER COLUMN修改注释(推荐)
使用Spark 4.0推荐的ALTER COLUMN语法修改表t1中c1列的注释。
ALTER TABLE t1 ALTER COLUMN c1 COMMENT 'the new comment';
示例2:使用CHANGE COLUMN修改注释(兼容)
ALTER TABLE t1 CHANGE COLUMN c1 c1 STRING COMMENT 'the new comment';
示例3:指定数据库修改列注释
修改数据库mydb中表employee的name列注释。
ALTER TABLE mydb.employee ALTER COLUMN name COMMENT '员工姓名';
示例4:修改多列注释
分别修改表t1中多个列的注释。
ALTER TABLE t1 ALTER COLUMN c1 COMMENT '第一列说明'; ALTER TABLE t1 ALTER COLUMN c2 COMMENT '第二列说明';