Parth-Brahmbhatt commented on a change in pull request #165: Adding the catalog interface to allow iceberg to handle top level catalog operations. URL: https://github.com/apache/incubator-iceberg/pull/165#discussion_r277938945
########## File path: api/src/main/java/org/apache/iceberg/catalog/Catalog.java ########## @@ -0,0 +1,83 @@ +/* + * 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.iceberg.catalog; + +import java.util.List; +import java.util.Map; +import org.apache.iceberg.PartitionSpec; +import org.apache.iceberg.Schema; +import org.apache.iceberg.Table; +import org.apache.iceberg.exceptions.AlreadyExistsException; +import org.apache.iceberg.exceptions.NoSuchTableException; + +/** + * Top level Catalog APIs that supports table DDLs and namespace listing. + */ +public interface Catalog { + /** + * creates the table or throws {@link AlreadyExistsException}. + * + * @param tableIdentifier an identifier to identify this table in a namespace. + * @param schema the schema for this table, can not be null. + * @param spec the partition spec for this table, can not be null. + * @param tableProperties can be null or empty + * @return Table instance that was created + */ + Table createTable( + TableIdentifier tableIdentifier, + Schema schema, + PartitionSpec spec, + Map<String, String> tableProperties); + + /** + * Check if table exists or not. + * + * @param tableIdentifier an identifier to identify this table in a namespace. + * @return true if table exists, false if it doesn't. + */ + boolean tableExists(TableIdentifier tableIdentifier); + + /** + * Drops the table if it exists, otherwise throws {@link NoSuchTableException} + * The implementation should not delete the underlying data but ensure that a + * subsequent call to {@link Catalog#tableExists(TableIdentifier)} returns false. + * <p> + * If the table does not exists it will throw {@link NoSuchTableException} + * + * @param tableIdentifier an identifier to identify this table in a namespace. + */ + void dropTable(TableIdentifier tableIdentifier); + + /** + * Renames a table. If {@code from} does not exists throws {@link NoSuchTableException} + * If {@code to} exists than throws {@link AlreadyExistsException}. + * + * @param from original name of the table. + * @param to expected new name of the table. + */ + void renameTable(TableIdentifier from, TableIdentifier to); + + /** + * Returns list of all the tables {@link TableIdentifier tables} under the provided namespace. + * + * @param namespace identifier for the namespace under which tables are to be listed. + * @return List of {@link TableIdentifier} under the specified namespace. + */ + List<TableIdentifier> listTables(Namespace namespace); Review comment: To be honest I am not sure where do we draw the line. May be the listTables API is a bad idea and we should remove it and only keep top level table DDL APIs as iceberg is managing only table level operations. @rdblue what are your thoughts on this? ---------------------------------------------------------------- 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: [email protected] With regards, Apache Git Services --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
