xuefuz commented on a change in pull request #8007: [FLINK-11474][table] Add ReadableCatalog, ReadableWritableCatalog, and other … URL: https://github.com/apache/flink/pull/8007#discussion_r274073139
########## File path: flink-table/flink-table-common/src/main/java/org/apache/flink/table/catalog/ReadableWritableCatalog.java ########## @@ -0,0 +1,154 @@ +/* + * 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.table.catalog; + +import org.apache.flink.table.catalog.exceptions.DatabaseAlreadyExistException; +import org.apache.flink.table.catalog.exceptions.DatabaseNotExistException; +import org.apache.flink.table.catalog.exceptions.TableAlreadyExistException; +import org.apache.flink.table.catalog.exceptions.TableNotExistException; + +/** + * An interface responsible for manipulating catalog metadata. + */ +public interface ReadableWritableCatalog extends ReadableCatalog { + + // ------ databases ------ + + /** + * Create a database. + * + * @param name Name of the database to be created + * @param database The database definition + * @param ignoreIfExists Flag to specify behavior when a database with the given name already exists: + * if set to false, throw a DatabaseAlreadyExistException, + * if set to true, do nothing. + * @throws DatabaseAlreadyExistException if the given database already exists and ignoreIfExists is false + */ + void createDatabase(String name, CatalogDatabase database, boolean ignoreIfExists) + throws DatabaseAlreadyExistException; + + /** + * Drop a database. + * + * @param name Name of the database to be dropped. + * @param ignoreIfNotExists Flag to specify behavior when the database does not exist: + * if set to false, throw an exception, + * if set to true, do nothing. + * @throws DatabaseNotExistException if the given database does not exist + */ + void dropDatabase(String name, boolean ignoreIfNotExists) throws DatabaseNotExistException; + + /** + * Modify an existing database. + * + * @param name Name of the database to be modified + * @param newDatabase The new database definition + * @param ignoreIfNotExists Flag to specify behavior when the given database does not exist: + * if set to false, throw an exception, + * if set to true, do nothing. + * @throws DatabaseNotExistException if the given database does not exist + */ + void alterDatabase(String name, CatalogDatabase newDatabase, boolean ignoreIfNotExists) + throws DatabaseNotExistException; + + // ------ tables and views ------ + + /** + * Drop a table or view. + * + * @param tablePath Path of the table or view to be dropped + * @param ignoreIfNotExists Flag to specify behavior when the table or view does not exist: + * if set to false, throw an exception, + * if set to true, do nothing. + * @throws TableNotExistException if the table or view does not exist + */ + void dropTable(ObjectPath tablePath, boolean ignoreIfNotExists) throws TableNotExistException; + + /** + * Rename an existing table or view. + * + * @param tablePath Path of the table or view to rename + * @param newTableName the new name of the table or view + * @param ignoreIfNotExists Flag to specify behavior when the table or view does not exist: + * if set to false, throw an exception, + * if set to true, do nothing. + * @throws TableNotExistException if the table does not exist + * @throws DatabaseNotExistException if the database in tablePath to doesn't exist + */ + void renameTable(ObjectPath tablePath, String newTableName, boolean ignoreIfNotExists) + throws TableNotExistException, DatabaseNotExistException; + + // ------ tables ------ + + /** + * Create a new table. Note that TableStats in the table is ignored for table creation. + * + * @param tablePath Path of the table to be created + * @param table The table definition + * @param ignoreIfExists Flag to specify behavior when a table already exists at the given path: + * if set to false, it throws a TableAlreadyExistException, + * if set to true, do nothing. + * @throws TableAlreadyExistException if table already exists and ignoreIfExists is false + * @throws DatabaseNotExistException if the database in tablePath doesn't exist + */ + void createTable(ObjectPath tablePath, CatalogTable table, boolean ignoreIfExists) Review comment: Thanks all for the feedback. I don't think either method name or signature of the method or both can tell the whole story. That's the reason why we have API document, which is indispensable for API users. If one is still confused even after looking at the API documentation, then we have a problem. However, I don't think it's the case here. Plus, naming is very subjective and it can never be perfect! Nevertheless, I take the point of merging APIs for regular tables and views into a single set, which is reflected in the latest update. Let me know if there is anything to be further changed. Thanks. ---------------------------------------------------------------- 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. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
