setCatalogComment

首发版本:3.00.6

语法

setCatalogComment(catalog, comment)

详情

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

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

参数

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

comment 字符串标量,表示 catalog 的描述信息。

返回值

无。

例子

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

createCatalog(catalog=catalogName)
setCatalogComment(catalog=catalogName, comment="证券行情数据")

getCatalogComment(catalog=catalogName)
// output: 证券行情数据

相关函数:getCatalogComment, createCatalog