LadyForest commented on code in PR #24555: URL: https://github.com/apache/flink/pull/24555#discussion_r1548860085
########## flink-table/flink-sql-parser/src/main/java/org/apache/flink/sql/parser/dql/SqlShowCreateCatalog.java: ########## @@ -0,0 +1,68 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.flink.sql.parser.dql; + +import org.apache.calcite.sql.SqlIdentifier; +import org.apache.calcite.sql.SqlKind; +import org.apache.calcite.sql.SqlNode; +import org.apache.calcite.sql.SqlOperator; +import org.apache.calcite.sql.SqlSpecialOperator; +import org.apache.calcite.sql.SqlWriter; +import org.apache.calcite.sql.parser.SqlParserPos; + +import java.util.Collections; +import java.util.List; + +/** SHOW CREATE CATALOG sql call. */ +public class SqlShowCreateCatalog extends SqlShowCreate { + + public static final SqlSpecialOperator OPERATOR = + new SqlSpecialOperator("SHOW CREATE CATALOG", SqlKind.OTHER_DDL); + + protected final SqlIdentifier catalogName; + + public SqlShowCreateCatalog(SqlParserPos pos, SqlIdentifier catalogName) { + super(pos, catalogName); + this.catalogName = catalogName; + } + + public SqlIdentifier getCatalogName() { + return catalogName; Review Comment: Is there any speicific reason not to use `sqlIdentifier`? ########## flink-table/flink-sql-parser/src/main/java/org/apache/flink/sql/parser/dql/SqlShowCreateCatalog.java: ########## @@ -0,0 +1,68 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.flink.sql.parser.dql; + +import org.apache.calcite.sql.SqlIdentifier; +import org.apache.calcite.sql.SqlKind; +import org.apache.calcite.sql.SqlNode; +import org.apache.calcite.sql.SqlOperator; +import org.apache.calcite.sql.SqlSpecialOperator; +import org.apache.calcite.sql.SqlWriter; +import org.apache.calcite.sql.parser.SqlParserPos; + +import java.util.Collections; +import java.util.List; + +/** SHOW CREATE CATALOG sql call. */ +public class SqlShowCreateCatalog extends SqlShowCreate { + + public static final SqlSpecialOperator OPERATOR = + new SqlSpecialOperator("SHOW CREATE CATALOG", SqlKind.OTHER_DDL); + + protected final SqlIdentifier catalogName; Review Comment: Is there any specific reason to keep a `catalogName` here? ########## flink-table/flink-sql-parser/src/main/java/org/apache/flink/sql/parser/dql/SqlShowCreateCatalog.java: ########## @@ -0,0 +1,68 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.flink.sql.parser.dql; + +import org.apache.calcite.sql.SqlIdentifier; +import org.apache.calcite.sql.SqlKind; +import org.apache.calcite.sql.SqlNode; +import org.apache.calcite.sql.SqlOperator; +import org.apache.calcite.sql.SqlSpecialOperator; +import org.apache.calcite.sql.SqlWriter; +import org.apache.calcite.sql.parser.SqlParserPos; + +import java.util.Collections; +import java.util.List; + +/** SHOW CREATE CATALOG sql call. */ +public class SqlShowCreateCatalog extends SqlShowCreate { + + public static final SqlSpecialOperator OPERATOR = + new SqlSpecialOperator("SHOW CREATE CATALOG", SqlKind.OTHER_DDL); + + protected final SqlIdentifier catalogName; + + public SqlShowCreateCatalog(SqlParserPos pos, SqlIdentifier catalogName) { + super(pos, catalogName); + this.catalogName = catalogName; + } + + public SqlIdentifier getCatalogName() { + return catalogName; + } + + @Override + public SqlOperator getOperator() { + return OPERATOR; + } + + @Override + public List<SqlNode> getOperandList() { + return Collections.singletonList(sqlIdentifier); + } + + @Override + public void unparse(SqlWriter writer, int leftPrec, int rightPrec) { + writer.keyword("SHOW CREATE CATALOG"); + sqlIdentifier.unparse(writer, leftPrec, rightPrec); + } + + public String catalogName() { + return catalogName.getSimple(); Review Comment: ```suggestion return sqlIdentifier.getSimple(); ``` ########## docs/content.zh/docs/dev/table/sql/show.md: ########## @@ -214,6 +231,22 @@ tEnv.executeSql("SHOW CATALOGS").print() // | default_catalog | // +-----------------+ +// create a catalog +tEnv.executeSql("CREATE CATALOG cat2 WITH (...)") + +// show create catalog +tEnv.executeSql("SHOW CREATE CATALOG cat2").print(); Review Comment: ```suggestion tEnv.executeSql("SHOW CREATE CATALOG cat2").print() ``` ########## docs/content.zh/docs/dev/table/sql/show.md: ########## @@ -411,6 +460,14 @@ table_env.execute_sql("SHOW FULL MODULES").print() Flink SQL> SHOW CATALOGS; default_catalog +Flink SQL> create catalog cat2 WITH (...); +[INFO] Execute statement succeeded. + +Flink SQL> show create catalog cat2; +CREATE CATALOG `cat2` WITH ( + ... +) + Review Comment: Nit: let key word be capitalized to keep consistent with other examples. ########## docs/content.zh/docs/dev/table/sql/show.md: ########## @@ -316,6 +349,22 @@ table_env.execute_sql("SHOW CATALOGS").print() # | default_catalog | # +-----------------+ +# create a catalog +table_env.execute_sql("CREATE CATALOG cat2 WITH (...)") + +# show create catalog +table_env.execute_sql("SHOW CREATE CATALOG cat2").print(); Review Comment: ```suggestion table_env.execute_sql("SHOW CREATE CATALOG cat2").print() ``` ########## docs/content/docs/dev/table/sql/show.md: ########## @@ -411,6 +460,14 @@ table_env.execute_sql("SHOW FULL MODULES").print() Flink SQL> SHOW CATALOGS; default_catalog +Flink SQL> create catalog cat2 WITH (...); Review Comment: ditto ########## docs/content.zh/docs/dev/table/sql/show.md: ########## @@ -102,6 +103,22 @@ tEnv.executeSql("SHOW CURRENT CATALOG").print(); // | default_catalog | // +----------------------+ +// create a catalog +tEnv.executeSql("CREATE CATALOG cat2 WITH (...)") Review Comment: ```suggestion tEnv.executeSql("CREATE CATALOG cat2 WITH (...)"); ``` ########## docs/content/docs/dev/table/sql/show.md: ########## @@ -214,6 +231,22 @@ tEnv.executeSql("SHOW CATALOGS").print() // | default_catalog | // +-----------------+ +// create a catalog +tEnv.executeSql("CREATE CATALOG cat2 WITH (...)") + +// show create catalog +tEnv.executeSql("SHOW CREATE CATALOG cat2").print(); Review Comment: ditto ########## docs/content/docs/dev/table/sql/show.md: ########## @@ -102,6 +103,22 @@ tEnv.executeSql("SHOW CURRENT CATALOG").print(); // | default_catalog | // +----------------------+ +// create a catalog +tEnv.executeSql("CREATE CATALOG cat2 WITH (...)") Review Comment: ditto ########## docs/content/docs/dev/table/sql/show.md: ########## @@ -504,6 +561,38 @@ SHOW CURRENT CATALOG Show current catalog. +## SHOW CREATE CATALOG + +```sql +SHOW CREATE CATALOG catalog_name +``` + +Show creation statement for an existing catalog. + +The output includes the catalog's name and relevant properties, which allows you to easily reuse the created catalogs. Review Comment: Nit: I think the phrase "easily resuse the created catalogs" doesn't quite capture the intended meaning. A more accurate description would be "gain an intuitive understanding of the underlying catalog's metadata." ########## docs/content/docs/dev/table/sql/show.md: ########## @@ -316,6 +349,22 @@ table_env.execute_sql("SHOW CATALOGS").print() # | default_catalog | # +-----------------+ +# create a catalog +table_env.execute_sql("CREATE CATALOG cat2 WITH (...)") + +# show create catalog +table_env.execute_sql("SHOW CREATE CATALOG cat2").print(); Review Comment: ditto -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@flink.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
