setCatalogComment

Syntax

setCatalogComment(catalog, comment)

Details

Sets or updates the comment for the specified catalog. The comment cannot exceed 4096 bytes. Specify an empty string to clear the comment.

Note: After this function is called, the node cannot be downgraded to an earlier version. A downgrade may prevent the node from starting or truncate subsequent ACL logs.

Parameters

catalog is a STRING scalar specifying an existing catalog.

comment is a STRING scalar specifying the catalog comment.

Returns

None.

Examples

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

createCatalog(catalog=catalogName)
setCatalogComment(catalog=catalogName, comment="Securities market data")

getCatalogComment(catalog=catalogName)
// output: Securities market data

Related functions: getCatalogComment, createCatalog