注释 COMMENT

给一个数据目录（CATALOG）添加或者复写注释。

支持对表TABLE，查找表LOOKUP TABLE，视图VIEW，物化视图MATERIALIZED VIEW，函数FUNCTION添加注释。

会在数据目录被删除时同时删除注释

语意 SYNTAX

// 对于已存在的catalog添加注释
COMMENT ON <catalog_type> <catalog_key> IS ['<string_literal>' | NULL]

// 在添加catalog的同时添加注释
[CREATE | CREATE OR REPLACE] <catalog_type> <catalog_key> (COMMENT = '<string_literal>')? ...

现在支持用COMMENT ON改变的数据类型<catalog_type>：VIEW, TABLE, FUNCTION, LOOKUP TABLE, MATERIALZIE VIEW.

示例

对于表创建时添加注释

-- 创建表并同时添加注释
CREATE TABLE comment_table COMMENT='this is a description' 
-- 更新注释 
COMMENT ON TABLE comment_table IS 'update the description'
-- 删除注释
COMMENT ON TABLE comment_table IS NULL
-- 同时可以通过更新表的方式更新注释
CREATE OR REPLACE TABLE comment_table COMMENT='this is a description'
-- 可以通过show full语句来获得注释信息
SHOW FULL TABLES
-- 删除表同时也会删除注释
DROP TABLE comment_table 

对于其他数据目录的改动示例

-- 视图
CREATE OR REPLACE VIEW view_0 COMMENT = 'desc' as select 1
COMMENT ON VIEW view_0 IS 'updated desc'
-- sql 函数
CREATE OR REPLACE FUNCTION func(@key INT) COMMENT = 'desc' as select 1
COMMENT ON FUNCTION func(INT) IS 'updated desc'
-- 查找表
CREATE LOOKUP TABLE code_lookup COMMENT = 'desc' WITH(KEYS='request_method')
AS SELECT request_method, code FROM load_csv('path/to/csv/file')
COMMENT ON LOOKUP TABLE code_lookup IS 'updated desc'
-- 物化视图
CREATE OR REPLACE MATERIALIZED VIEW view_1 COMMENT = 'desc' as select 1
COMMENT ON MATERIALIZED VIEW view_1 IS 'updated desc'

caution

注意：

• 因为non-sql表函数会有多个签名，所以无法在创建non-sql表函数并添加注释，即下列语句是非法的

CREATE OR REPLACE func COMMENT = 'desc' LANGUAGE PYTHON
PACKAGE '<package_path>'