getSchemaComment

First introduced in version: 3.00.6

Syntax

getSchemaComment(catalog, schema)

Details

Returns the comment for a schema in the specified catalog.

Parameters

catalog is a STRING scalar specifying an existing catalog.

schema is a STRING scalar specifying an existing schema in catalog.

Returns

A STRING scalar.

Examples

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="China A-share market data")

getSchemaComment(catalog=catalogName, schema=schemaName)
// output: China A-share market data

Related functions: setSchemaComment, getSchemaByCatalog