setSchemaComment

首发版本：3.00.6

语法

setSchemaComment(catalog, schema, comment)

详情

为指定 catalog 下的 schema 设置或更新描述信息。描述信息的长度不能超过 4096 字节。传入空字符串可以清空描述信息。

注意：调用该函数后，不支持将节点回退到旧版本。回退可能导致节点启动失败，或后续 ACL 日志被截断。

参数

catalog 字符串标量，表示 catalog 名称。指定的 catalog 必须存在。

schema 字符串标量，表示 schema 名称。指定的 schema 必须存在于 catalog 中。

comment 字符串标量，表示 schema 的描述信息。

返回值

无。

例子

catalogName = "securitiesMarketCatalog"
schemaName = "equityMarket"

if (existsCatalog(catalog=catalogName)) {
    dropCatalog(catalog=catalogName)
}

createCatalog(catalog=catalogName)
go
create database securitiesMarketCatalog.equityMarket partitioned by VALUE(1..3)
setSchemaComment(catalog=catalogName, schema=schemaName, comment="沪深股票行情库")

getSchemaComment(catalog=catalogName, schema=schemaName)
// output: 沪深股票行情库

相关函数：getSchemaComment, getSchemaByCatalog, createSchema