[FLINK-34915][table] Complete DESCRIBE CATALOG syntax

[liyubin117]

What is the purpose of the change

Describe the metadata of an existing catalog. The metadata information includes the catalog’s name, type, and comment. If the optional EXTENDED option is specified, catalog properties are also returned.

Brief change log

• { DESCRIBE | DESC } CATALOG [EXTENDED] catalog_name

Verifying this change

This change added tests and can be verified as follows:

flink-table/flink-sql-client/src/test/resources/sql/catalog_database.q
flink-table/flink-sql-gateway/src/test/resources/sql/catalog_database.q

Does this pull request potentially affect one of the following parts:

• Dependencies (does it add or upgrade a dependency): no
• The public API, i.e., is any changed class annotated with @Public(Evolving): no
• The serializers: no
• The runtime per-record code paths (performance sensitive): no
• Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn/Mesos, ZooKeeper: no
• The S3 file system connector: no

Documentation

• Does this pull request introduce a new feature? yes
• If yes, how is the feature documented? yes

[flinkbot]

CI report:

• 010f3f8 Azure: SUCCESS

Bot commands

The @flinkbot bot supports the following commands:

• @flinkbot run azure re-run the last Azure build

[liyubin117]

@LadyForest Hi, Could you please take a review? thanks!

[LadyForest]

Hi @liyubin117 thanks for the contribution! I left two comments, PTAL

[liyubin117]

@flinkbot run azure

[liyubin117]

@LadyForest Hi, I have updated as you said, besides, rebased on the latest master branch and CI passed, PTAL, thanks :)

[LadyForest]

Thanks for the update! I left some comments, PTAL

[LadyForest]

This might be a little bit verbose

desc catalog extended cat2;
+-------------------------+-------------------+
|               info name |        info value |
+-------------------------+-------------------+
|                    name |              cat2 |
|                    type | generic_in_memory |
|                 comment |                   |
| option:default-database |                db |
|             option:type | generic_in_memory |
+-------------------------+-------------------+
5 rows in set
!ok

what about

desc catalog extended cat2;
+-------------------------+-------------------+
|               info name |        info value |
+-------------------------+-------------------+
|                    name |              cat2 |
|                    type | generic_in_memory |
|                 comment |                   |
| option:default-database |                db |
+-------------------------+-------------------+
4 rows in set
!ok

or

desc catalog extended cat2;
+-------------------------+-------------------+
|               info name |        info value |
+-------------------------+-------------------+
|                    name |              cat2 |
|                 comment |                   |
| option:default-database |                db |
|             option:type | generic_in_memory |
+-------------------------+-------------------+
4 rows in set
!ok

        if (isExtended) {
            properties.entrySet().stream()
                    .filter(entry -> !"type".equals(entry.getKey()))
                    .sorted(Map.Entry.comparingByKey())
                    .forEach(
                            entry ->
                                    rows.add(
                                            Arrays.asList(
                                                    String.format("option:%s", entry.getKey()),
                                                    entry.getValue())));
        }

[liyubin117]

I have updated as the first output style, and will raise a discussion in dev mail. thanks for your suggesion~

[liyubin117]

mail thread: https://lists.apache.org/thread/tkgg1lv9hg8s3p44256nh5pl48wfwmtf

[LadyForest]

Hi, @liyubin117, thanks for your update. I only left one comment on the doc structure and added a commit to simplify it. PTAL

[liyubin117]

@flinkbot run azure

[LadyForest]

Thanks for the update. LGTM