[
https://issues.apache.org/jira/browse/FLINK-34917?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Yubin Li updated FLINK-34917:
-----------------------------
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.
{{IF NOT EXISTS}} clause: If the catalog already exists, nothing happens.
{{COMMENT}} clause: An optional string literal. The description for the catalog.
NOTICE: we just need to introduce the '[IF NOT EXISTS]' and '[COMMENT]' clause
to the 'create catalog' statement.
!image-2024-03-22-18-31-59-632.png|width=795,height=87!
was:
{{IF NOT EXISTS}} clause: If the catalog already exists, nothing happens.
{{COMMENT}} clause: An optional string literal. The description for the catalog.
NOTICE: we just need to introduce the '[IF NOT EXISTS]' and '[COMMENT]' clause
to the 'create catalog' statement.
!image-2024-03-22-18-31-59-632.png|width=795,height=87!
> Introduce comment for CatalogStore & Support enhanced `CREATE CATALOG` syntax
> -----------------------------------------------------------------------------
>
> Key: FLINK-34917
> URL: https://issues.apache.org/jira/browse/FLINK-34917
> Project: Flink
> Issue Type: Sub-task
> Components: Table SQL / API
> Affects Versions: 1.20.0
> Reporter: Yubin Li
> Assignee: Yubin Li
> Priority: Major
> Attachments: image-2024-03-22-18-31-59-632.png
>
>
> 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.
>
> {{IF NOT EXISTS}} clause: If the catalog already exists, nothing happens.
> {{COMMENT}} clause: An optional string literal. The description for the
> catalog.
> NOTICE: we just need to introduce the '[IF NOT EXISTS]' and '[COMMENT]'
> clause to the 'create catalog' statement.
> !image-2024-03-22-18-31-59-632.png|width=795,height=87!
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
