-
Notifications
You must be signed in to change notification settings - Fork 3k
Nessie support for core #1587
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Nessie support for core #1587
Changes from all commits
52b34b7
dd7278d
a76061e
a0e98a7
0052ab3
491e7c2
c1ca68c
a52e751
823e5bc
4ef071f
6fa22bb
b23f6da
8a9009b
bf52afa
5a15cde
f9bc7ba
fc7cc8f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,336 @@ | ||
| /* | ||
| * 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.nessie; | ||
|
|
||
| import com.dremio.nessie.api.TreeApi; | ||
| import com.dremio.nessie.client.NessieClient; | ||
| import com.dremio.nessie.error.BaseNessieClientServerException; | ||
| import com.dremio.nessie.error.NessieConflictException; | ||
| import com.dremio.nessie.error.NessieNotFoundException; | ||
| import com.dremio.nessie.model.Contents; | ||
| import com.dremio.nessie.model.IcebergTable; | ||
| import com.dremio.nessie.model.ImmutableDelete; | ||
| import com.dremio.nessie.model.ImmutableOperations; | ||
| import com.dremio.nessie.model.ImmutablePut; | ||
| import com.dremio.nessie.model.Operations; | ||
| import com.dremio.nessie.model.Reference; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Set; | ||
| import java.util.function.Function; | ||
| import java.util.stream.Collectors; | ||
| import java.util.stream.Stream; | ||
| import org.apache.hadoop.conf.Configurable; | ||
| import org.apache.hadoop.conf.Configuration; | ||
| import org.apache.iceberg.BaseMetastoreCatalog; | ||
| import org.apache.iceberg.CatalogProperties; | ||
| import org.apache.iceberg.CatalogUtil; | ||
| import org.apache.iceberg.TableOperations; | ||
| import org.apache.iceberg.catalog.Namespace; | ||
| import org.apache.iceberg.catalog.SupportsNamespaces; | ||
| import org.apache.iceberg.catalog.TableIdentifier; | ||
| import org.apache.iceberg.exceptions.AlreadyExistsException; | ||
| import org.apache.iceberg.exceptions.CommitFailedException; | ||
| import org.apache.iceberg.exceptions.NamespaceNotEmptyException; | ||
| import org.apache.iceberg.exceptions.NoSuchNamespaceException; | ||
| import org.apache.iceberg.exceptions.NoSuchTableException; | ||
| import org.apache.iceberg.hadoop.HadoopFileIO; | ||
| import org.apache.iceberg.io.FileIO; | ||
| import org.apache.iceberg.relocated.com.google.common.base.Joiner; | ||
| import org.apache.iceberg.relocated.com.google.common.collect.ImmutableMap; | ||
| import org.apache.iceberg.util.Tasks; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| /** | ||
| * Nessie implementation of Iceberg Catalog. | ||
| * | ||
| * <p> | ||
| * A note on namespaces: Nessie namespaces are implicit and do not need to be explicitly created or deleted. | ||
| * The create and delete namespace methods are no-ops for the NessieCatalog. One can still list namespaces that have | ||
| * objects stored in them to assist with namespace-centric catalog exploration. | ||
| * </p> | ||
| */ | ||
| public class NessieCatalog extends BaseMetastoreCatalog implements AutoCloseable, SupportsNamespaces, Configurable { | ||
| private static final Logger logger = LoggerFactory.getLogger(NessieCatalog.class); | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nit: static final constants should use upper case names, like LOGGER. I'm not sure why style checks didn't catch this. (Not a blocker)
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. fixed. I was just arguing w/ @jacques-n on this point on Fri ;-) He sided with you. |
||
| private static final Joiner SLASH = Joiner.on("/"); | ||
| private NessieClient client; | ||
| private String warehouseLocation; | ||
| private Configuration config; | ||
| private UpdateableReference reference; | ||
| private String name; | ||
| private FileIO fileIO; | ||
|
|
||
| public NessieCatalog() { | ||
| } | ||
|
|
||
| @Override | ||
| public void initialize(String inputName, Map<String, String> options) { | ||
| String fileIOImpl = options.get(CatalogProperties.FILE_IO_IMPL); | ||
| this.fileIO = fileIOImpl == null ? new HadoopFileIO(config) : CatalogUtil.loadFileIO(fileIOImpl, options, config); | ||
| this.name = inputName == null ? "nessie" : inputName; | ||
rdblue marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| // remove nessie prefix | ||
| final Function<String, String> removePrefix = x -> x.replace("nessie.", ""); | ||
|
|
||
| this.client = NessieClient.withConfig(x -> options.get(removePrefix.apply(x))); | ||
|
|
||
| this.warehouseLocation = options.get(CatalogProperties.WAREHOUSE_LOCATION); | ||
| if (warehouseLocation == null) { | ||
| throw new IllegalStateException("Parameter warehouse not set, nessie can't store data."); | ||
| } | ||
| final String requestedRef = options.get(removePrefix.apply(NessieClient.CONF_NESSIE_REF)); | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Did you intend to change this to
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It is just ref now, the
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I missed the |
||
| this.reference = loadReference(requestedRef); | ||
| } | ||
|
|
||
| @Override | ||
| public void close() { | ||
| client.close(); | ||
| } | ||
|
|
||
| @Override | ||
| public String name() { | ||
| return name; | ||
| } | ||
|
|
||
| @Override | ||
| protected TableOperations newTableOps(TableIdentifier tableIdentifier) { | ||
| TableReference pti = TableReference.parse(tableIdentifier); | ||
| UpdateableReference newReference = this.reference; | ||
| if (pti.reference() != null) { | ||
| newReference = loadReference(pti.reference()); | ||
| } | ||
| return new NessieTableOperations(NessieUtil.toKey(pti.tableIdentifier()), newReference, client, fileIO); | ||
| } | ||
|
|
||
| @Override | ||
| protected String defaultWarehouseLocation(TableIdentifier table) { | ||
| if (table.hasNamespace()) { | ||
| return SLASH.join(warehouseLocation, table.namespace().toString(), table.name()); | ||
| } | ||
| return SLASH.join(warehouseLocation, table.name()); | ||
| } | ||
|
|
||
| @Override | ||
| public List<TableIdentifier> listTables(Namespace namespace) { | ||
| return tableStream(namespace).collect(Collectors.toList()); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean dropTable(TableIdentifier identifier, boolean purge) { | ||
| reference.checkMutable(); | ||
|
|
||
| IcebergTable existingTable = table(identifier); | ||
| if (existingTable == null) { | ||
| return false; | ||
| } | ||
|
|
||
| // We try to drop the table. Simple retry after ref update. | ||
| boolean threw = true; | ||
| try { | ||
| Tasks.foreach(identifier) | ||
| .retry(5) | ||
| .stopRetryOn(NessieNotFoundException.class) | ||
| .throwFailureWhenFinished() | ||
| .run(this::dropTableInner, BaseNessieClientServerException.class); | ||
| threw = false; | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nit: Up to you whether to change this or not. I know some people strongly prefer only one exit point from a method.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. fixed. I like your way better too..just a hangover from the refactor |
||
| } catch (NessieConflictException e) { | ||
| logger.error("Cannot drop table: failed after retry (update ref and retry)", e); | ||
| } catch (NessieNotFoundException e) { | ||
| logger.error("Cannot drop table: ref is no longer valid.", e); | ||
| } catch (BaseNessieClientServerException e) { | ||
| logger.error("Cannot drop table: unknown error", e); | ||
| } | ||
rdblue marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return !threw; | ||
| } | ||
|
|
||
| @Override | ||
| public void renameTable(TableIdentifier from, TableIdentifier toOriginal) { | ||
| reference.checkMutable(); | ||
|
|
||
| TableIdentifier to = NessieUtil.removeCatalogName(toOriginal, name()); | ||
|
|
||
| IcebergTable existingFromTable = table(from); | ||
| if (existingFromTable == null) { | ||
| throw new NoSuchTableException("table %s doesn't exists", from.name()); | ||
| } | ||
| IcebergTable existingToTable = table(to); | ||
| if (existingToTable != null) { | ||
| throw new AlreadyExistsException("table %s already exists", to.name()); | ||
| } | ||
|
|
||
| Operations contents = ImmutableOperations.builder() | ||
| .addOperations(ImmutablePut.builder().key(NessieUtil.toKey(to)).contents(existingFromTable).build(), | ||
| ImmutableDelete.builder().key(NessieUtil.toKey(from)).build()) | ||
| .build(); | ||
|
|
||
| try { | ||
| Tasks.foreach(contents) | ||
| .retry(5) | ||
| .stopRetryOn(NessieNotFoundException.class) | ||
| .throwFailureWhenFinished() | ||
| .run(c -> { | ||
| client.getTreeApi().commitMultipleOperations(reference.getAsBranch().getName(), reference.getHash(), | ||
| "iceberg rename table", c); | ||
| refresh(); | ||
| }, BaseNessieClientServerException.class); | ||
|
|
||
| } catch (NessieNotFoundException e) { | ||
| // important note: the NotFoundException refers to the ref only. If a table was not found it would imply that the | ||
| // another commit has deleted the table from underneath us. This would arise as a Conflict exception as opposed to | ||
| // a not found exception. This is analogous to a merge conflict in git when a table has been changed by one user | ||
| // and removed by another. | ||
| throw new RuntimeException("Failed to drop table as ref is no longer valid.", e); | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This can't happen if the Maybe we're guaranteed that the ref hasn't changed because this isn't a
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If I have opened projectnessie/nessie#477 to track the lack of documentation on the exception classes. In the meantime I have added a comment here |
||
| } catch (BaseNessieClientServerException e) { | ||
| throw new CommitFailedException(e, "Failed to rename table: the current reference is not up to date."); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * creating namespaces in nessie is implicit, therefore this is a no-op. Metadata is ignored. | ||
| * | ||
| * @param namespace a multi-part namespace | ||
| * @param metadata a string Map of properties for the given namespace | ||
| */ | ||
| @Override | ||
| public void createNamespace(Namespace namespace, Map<String, String> metadata) { | ||
| } | ||
|
|
||
| @Override | ||
| public List<Namespace> listNamespaces(Namespace namespace) throws NoSuchNamespaceException { | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should we create a trait just for listing namespaces that are implicit?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. How do you mean? A new interface that no-ops create, load, drop from
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Just an interface that omits those. All this needs is to list namespaces, not do anything else. I guess we can take a closer look if anything else needs this. |
||
| return tableStream(namespace) | ||
| .map(TableIdentifier::namespace) | ||
| .filter(n -> !n.isEmpty()) | ||
| .distinct() | ||
| .collect(Collectors.toList()); | ||
| } | ||
|
|
||
| /** | ||
| * namespace metadata is not supported in Nessie and we return an empty map. | ||
| * | ||
| * @param namespace a namespace. {@link Namespace} | ||
| * @return an empty map | ||
| */ | ||
| @Override | ||
| public Map<String, String> loadNamespaceMetadata(Namespace namespace) throws NoSuchNamespaceException { | ||
| return ImmutableMap.of(); | ||
| } | ||
|
|
||
| /** | ||
| * Namespaces in Nessie are implicit and deleting them results in a no-op. | ||
| * | ||
| * @param namespace a namespace. {@link Namespace} | ||
| * @return always false. | ||
| */ | ||
| @Override | ||
| public boolean dropNamespace(Namespace namespace) throws NamespaceNotEmptyException { | ||
| return false; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean setProperties(Namespace namespace, Map<String, String> properties) throws NoSuchNamespaceException { | ||
| throw new UnsupportedOperationException( | ||
| "Cannot set namespace properties " + namespace + " : setProperties is not supported"); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean removeProperties(Namespace namespace, Set<String> properties) throws NoSuchNamespaceException { | ||
| throw new UnsupportedOperationException( | ||
| "Cannot remove properties " + namespace + " : removeProperties is not supported"); | ||
| } | ||
|
|
||
| @Override | ||
| public void setConf(Configuration conf) { | ||
| this.config = conf; | ||
| } | ||
|
|
||
| @Override | ||
| public Configuration getConf() { | ||
| return config; | ||
| } | ||
|
|
||
| TreeApi getTreeApi() { | ||
| return client.getTreeApi(); | ||
| } | ||
|
|
||
| public void refresh() throws NessieNotFoundException { | ||
| reference.refresh(); | ||
| } | ||
|
|
||
| public String currentHash() { | ||
| return reference.getHash(); | ||
| } | ||
|
|
||
| String currentRefName() { | ||
| return reference.getName(); | ||
| } | ||
|
|
||
| private IcebergTable table(TableIdentifier tableIdentifier) { | ||
| try { | ||
| Contents table = client.getContentsApi().getContents(NessieUtil.toKey(tableIdentifier), reference.getHash()); | ||
| return table.unwrap(IcebergTable.class).orElse(null); | ||
| } catch (NessieNotFoundException e) { | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| private UpdateableReference loadReference(String requestedRef) { | ||
| try { | ||
| Reference ref = requestedRef == null ? client.getTreeApi().getDefaultBranch() | ||
| : client.getTreeApi().getReferenceByName(requestedRef); | ||
| return new UpdateableReference(ref, client.getTreeApi()); | ||
| } catch (NessieNotFoundException ex) { | ||
| if (requestedRef != null) { | ||
| throw new IllegalArgumentException(String.format("Nessie ref '%s' does not exist. " + | ||
| "This ref must exist before creating a NessieCatalog.", requestedRef), ex); | ||
| } | ||
|
|
||
| throw new IllegalArgumentException(String.format("Nessie does not have an existing default branch." + | ||
| "Either configure an alternative ref via %s or create the default branch on the server.", | ||
| NessieClient.CONF_NESSIE_REF), ex); | ||
| } | ||
| } | ||
|
|
||
|
|
||
| public void dropTableInner(TableIdentifier identifier) throws NessieConflictException, NessieNotFoundException { | ||
| try { | ||
| client.getContentsApi().deleteContents(NessieUtil.toKey(identifier), | ||
| reference.getAsBranch().getName(), | ||
| reference.getHash(), | ||
| String.format("delete table %s", identifier)); | ||
|
|
||
| } finally { | ||
| // TODO: fix this so we don't depend on it in tests. and move refresh into catch clause. | ||
| refresh(); | ||
| } | ||
| } | ||
|
|
||
| private Stream<TableIdentifier> tableStream(Namespace namespace) { | ||
| try { | ||
| return client.getTreeApi() | ||
| .getEntries(reference.getHash()) | ||
| .getEntries() | ||
| .stream() | ||
| .filter(NessieUtil.namespacePredicate(namespace)) | ||
| .map(NessieUtil::toIdentifier); | ||
| } catch (NessieNotFoundException ex) { | ||
| throw new NoSuchNamespaceException(ex, "Unable to list tables due to missing ref. %s", reference.getName()); | ||
| } | ||
| } | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What's happening in the Nessie plugin?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It uses
quarkusAppRunnerConfigdependencies to discover the Nessie Quarkus server and its dependencies then uses that to start a server. Some of the operations to discover all runtime dependencies are non-trivial and require a full gradle dependency graph, hence why its non-trivial to do in a test suite. I believe the primary reason for all this is to facilitate easily building graalvm native images.See https://github.com/projectnessie/nessie/tree/main/tools/apprunner-gradle-plugin for the actual code