[FLINK-34918] Introduce comment for Catalog

• Type: Sub-task
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Affects Version/s: 1.20.0
• Component/s: Table SQL / API
• Assignee: Yubin Li
• Reporter: Yubin Li
• Created: 22/Mar/24 10:44
• Updated: 20/Apr/24 03:11

Description

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.

Issue Links

• is required by: FLINK-34917 Support enhanced `CREATE CATALOG` syntax