You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iceberg.apache.org by bl...@apache.org on 2019/04/21 20:28:24 UTC
[incubator-iceberg] branch master updated: Add a Catalog interface
for table operations. (#165)
This is an automated email from the ASF dual-hosted git repository.
blue pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-iceberg.git
The following commit(s) were added to refs/heads/master by this push:
new 9f699a7 Add a Catalog interface for table operations. (#165)
9f699a7 is described below
commit 9f699a794d26648c00e2f7808420666159e6286f
Author: Parth Brahmbhatt <br...@gmail.com>
AuthorDate: Sun Apr 21 13:28:19 2019 -0700
Add a Catalog interface for table operations. (#165)
---
.../java/org/apache/iceberg/catalog/Catalog.java | 83 ++++++++++++++++++++++
.../java/org/apache/iceberg/catalog/Namespace.java | 51 +++++++++++++
.../apache/iceberg/catalog/TableIdentifier.java | 53 ++++++++++++++
3 files changed, 187 insertions(+)
diff --git a/api/src/main/java/org/apache/iceberg/catalog/Catalog.java b/api/src/main/java/org/apache/iceberg/catalog/Catalog.java
new file mode 100644
index 0000000..d2d2d00
--- /dev/null
+++ b/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);
+}
diff --git a/api/src/main/java/org/apache/iceberg/catalog/Namespace.java b/api/src/main/java/org/apache/iceberg/catalog/Namespace.java
new file mode 100644
index 0000000..4ae9325
--- /dev/null
+++ b/api/src/main/java/org/apache/iceberg/catalog/Namespace.java
@@ -0,0 +1,51 @@
+/*
+ * 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;
+
+/**
+ * Identifies a namespace in iceberg catalog
+ */
+public class Namespace {
+ private final String[] levels;
+ private static final Namespace EMPTY = new Namespace(new String[] {});
+
+ private Namespace(String[] levels) {
+ this.levels = levels;
+ }
+
+ public String[] levels() {
+ return levels;
+ }
+
+ public boolean isEmpty() {
+ return this.equals(Namespace.EMPTY);
+ }
+
+ public static Namespace namespace(String[] levels) {
+ if (levels == null || levels.length == 0) {
+ return Namespace.EMPTY;
+ }
+
+ return new Namespace(levels);
+ }
+
+ public static Namespace empty() {
+ return EMPTY;
+ }
+}
diff --git a/api/src/main/java/org/apache/iceberg/catalog/TableIdentifier.java b/api/src/main/java/org/apache/iceberg/catalog/TableIdentifier.java
new file mode 100644
index 0000000..d671a4c
--- /dev/null
+++ b/api/src/main/java/org/apache/iceberg/catalog/TableIdentifier.java
@@ -0,0 +1,53 @@
+/*
+ * 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;
+
+/**
+ * Identifies a table in iceberg catalog, the namespace is optional
+ * so callers can use {@link #hasNamespace()} to check if namespace is present or not.
+ */
+public class TableIdentifier {
+ private final Namespace namespace;
+ private final String name;
+
+ public TableIdentifier(String name) {
+ this(Namespace.empty(), name);
+ }
+
+ public TableIdentifier(Namespace namespace, String name) {
+ if (name == null || name.isEmpty()) {
+ throw new IllegalArgumentException("name can not be null or empty");
+ }
+
+ this.namespace = namespace == null ? Namespace.empty() : namespace;
+ this.name = name;
+ }
+
+ public boolean hasNamespace() {
+ return !namespace.isEmpty();
+ }
+
+ public Namespace namespace() {
+ return namespace;
+ }
+
+ public String name() {
+ return name;
+ }
+}