Yubin Li created FLINK-34918:
--------------------------------

             Summary: Introduce the support of catalog for comments
                 Key: FLINK-34918
                 URL: https://issues.apache.org/jira/browse/FLINK-34918
             Project: Flink
          Issue Type: Sub-task
          Components: Table SQL / API
    Affects Versions: 1.20.0
            Reporter: Yubin Li


We propose to introduce `getComment()` method in `CatalogDescriptor`, and the 
reasons are as follows.

1. For the sake of design consistency, follow the design of FLIP-295 [1] which 
introduced `CatalogStore` component, `CatalogDescriptor` includes names and 
attributes, both of which are used to describe the catalog, and `comment` can 
be added smoothly.

2. Extending the existing class rather than add new method to the existing 
interface, Especially, the `Catalog` interface, as a core interface, is used by 
a series of important components such as `CatalogFactory`, `CatalogManager` and 
`FactoryUtil`, and is implemented by a large number of connectors such as JDBC, 
Paimon, and Hive. Adding methods to it will greatly increase the implementation 
complexity, and more importantly, increase the cost of iteration, maintenance, 
and verification.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

Reply via email to