Skip to content
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

Core: Add REST API for committing changes against multiple tables #7569

Merged
merged 1 commit into from Jun 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions core/src/main/java/org/apache/iceberg/BaseTransaction.java
Expand Up @@ -107,6 +107,10 @@ public String tableName() {
}

public TableMetadata startMetadata() {
return base;
}

public TableMetadata currentMetadata() {
rdblue marked this conversation as resolved.
Show resolved Hide resolved
return current;
}

Expand Down
52 changes: 52 additions & 0 deletions core/src/main/java/org/apache/iceberg/catalog/TableCommit.java
@@ -0,0 +1,52 @@
/*
* 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 org.apache.iceberg.MetadataUpdate;
import org.apache.iceberg.TableMetadata;
import org.apache.iceberg.UpdateRequirement;
import org.apache.iceberg.UpdateRequirements;
import org.apache.iceberg.relocated.com.google.common.base.Preconditions;
import org.immutables.value.Value;

@Value.Immutable
public interface TableCommit {
nastra marked this conversation as resolved.
Show resolved Hide resolved
TableIdentifier identifier();

List<UpdateRequirement> requirements();

List<MetadataUpdate> updates();

static TableCommit create(TableIdentifier identifier, TableMetadata base, TableMetadata updated) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Javadoc?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added in #7867

Preconditions.checkArgument(null != identifier, "Invalid table identifier: null");
Preconditions.checkArgument(null != base && null != updated, "Invalid table metadata: null");
Preconditions.checkArgument(
base.uuid().equals(updated.uuid()),
"UUID of base (%s) and updated (%s) table metadata does not match",
base.uuid(),
updated.uuid());

return ImmutableTableCommit.builder()
.identifier(identifier)
.requirements(UpdateRequirements.forUpdateTable(base, updated.changes()))
.updates(updated.changes())
.build();
}
}
Expand Up @@ -314,7 +314,7 @@ private static TableMetadata create(TableOperations ops, UpdateTableRequest requ
return ops.current();
}

private static TableMetadata commit(TableOperations ops, UpdateTableRequest request) {
static TableMetadata commit(TableOperations ops, UpdateTableRequest request) {
AtomicBoolean isRetry = new AtomicBoolean(false);
try {
Tasks.foreach(ops)
Expand Down
13 changes: 13 additions & 0 deletions core/src/main/java/org/apache/iceberg/rest/RESTCatalog.java
Expand Up @@ -33,16 +33,19 @@
import org.apache.iceberg.catalog.Namespace;
import org.apache.iceberg.catalog.SessionCatalog;
import org.apache.iceberg.catalog.SupportsNamespaces;
import org.apache.iceberg.catalog.TableCommit;
import org.apache.iceberg.catalog.TableIdentifier;
import org.apache.iceberg.exceptions.NamespaceNotEmptyException;
import org.apache.iceberg.exceptions.NoSuchNamespaceException;
import org.apache.iceberg.hadoop.Configurable;
import org.apache.iceberg.relocated.com.google.common.base.Preconditions;
import org.apache.iceberg.relocated.com.google.common.collect.ImmutableList;

public class RESTCatalog implements Catalog, SupportsNamespaces, Configurable<Object>, Closeable {
private final RESTSessionCatalog sessionCatalog;
private final Catalog delegate;
private final SupportsNamespaces nsDelegate;
private final SessionCatalog.SessionContext context;

public RESTCatalog() {
this(
Expand All @@ -60,6 +63,7 @@ public RESTCatalog(
this.sessionCatalog = new RESTSessionCatalog(clientBuilder, null);
this.delegate = sessionCatalog.asCatalog(context);
this.nsDelegate = (SupportsNamespaces) delegate;
this.context = context;
}

@Override
Expand Down Expand Up @@ -248,4 +252,13 @@ public void setConf(Object conf) {
public void close() throws IOException {
sessionCatalog.close();
}

public void commitTransaction(List<TableCommit> commits) {
sessionCatalog.commitTransaction(context, commits);
}

public void commitTransaction(TableCommit... commits) {
sessionCatalog.commitTransaction(
context, ImmutableList.<TableCommit>builder().add(commits).build());
}
}
20 changes: 20 additions & 0 deletions core/src/main/java/org/apache/iceberg/rest/RESTSessionCatalog.java
Expand Up @@ -52,6 +52,7 @@
import org.apache.iceberg.catalog.BaseSessionCatalog;
import org.apache.iceberg.catalog.Catalog;
import org.apache.iceberg.catalog.Namespace;
import org.apache.iceberg.catalog.TableCommit;
import org.apache.iceberg.catalog.TableIdentifier;
import org.apache.iceberg.exceptions.NoSuchNamespaceException;
import org.apache.iceberg.exceptions.NoSuchTableException;
Expand All @@ -63,13 +64,16 @@
import org.apache.iceberg.relocated.com.google.common.base.Preconditions;
import org.apache.iceberg.relocated.com.google.common.collect.ImmutableList;
import org.apache.iceberg.relocated.com.google.common.collect.ImmutableMap;
import org.apache.iceberg.relocated.com.google.common.collect.Lists;
import org.apache.iceberg.rest.auth.OAuth2Properties;
import org.apache.iceberg.rest.auth.OAuth2Util;
import org.apache.iceberg.rest.auth.OAuth2Util.AuthSession;
import org.apache.iceberg.rest.requests.CommitTransactionRequest;
import org.apache.iceberg.rest.requests.CreateNamespaceRequest;
import org.apache.iceberg.rest.requests.CreateTableRequest;
import org.apache.iceberg.rest.requests.RenameTableRequest;
import org.apache.iceberg.rest.requests.UpdateNamespacePropertiesRequest;
import org.apache.iceberg.rest.requests.UpdateTableRequest;
import org.apache.iceberg.rest.responses.ConfigResponse;
import org.apache.iceberg.rest.responses.CreateNamespaceResponse;
import org.apache.iceberg.rest.responses.GetNamespaceResponse;
Expand Down Expand Up @@ -916,4 +920,20 @@ private Cache<TableOperations, FileIO> newFileIOCloser() {
})
.build();
}

public void commitTransaction(SessionContext context, List<TableCommit> commits) {
List<UpdateTableRequest> tableChanges = Lists.newArrayListWithCapacity(commits.size());

for (TableCommit commit : commits) {
tableChanges.add(
new UpdateTableRequest(commit.identifier(), commit.requirements(), commit.updates()));
}

client.post(
paths.commitTransaction(),
new CommitTransactionRequest(tableChanges),
null,
headers(context),
ErrorHandlers.tableCommitHandler());
}
}
Expand Up @@ -48,7 +48,7 @@ public UpdateTableRequest(
this.updates = updates;
}

UpdateTableRequest(
public UpdateTableRequest(
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is required to be public so that it can be used in RESTSessionCatalog.
It might be also worth adding a Builder to UpdateTableRequest so that we don't have to make it public here.
In this case we have two options:

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should have a create method like TableCommit? Or one that accepts a TableCommit and returns the correct request? That would be simpler than a builder.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure that would also work. I'll make the respective changes in the next PR

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added in #7867

TableIdentifier identifier,
List<org.apache.iceberg.UpdateRequirement> requirements,
List<MetadataUpdate> updates) {
Expand Down
Expand Up @@ -22,6 +22,11 @@
import java.util.List;
import java.util.Map;
import java.util.function.Consumer;
import org.apache.iceberg.BaseTable;
import org.apache.iceberg.BaseTransaction;
import org.apache.iceberg.Table;
import org.apache.iceberg.Transaction;
import org.apache.iceberg.Transactions;
import org.apache.iceberg.catalog.Catalog;
import org.apache.iceberg.catalog.Namespace;
import org.apache.iceberg.catalog.SupportsNamespaces;
Expand All @@ -40,6 +45,8 @@
import org.apache.iceberg.exceptions.ValidationException;
import org.apache.iceberg.relocated.com.google.common.base.Splitter;
import org.apache.iceberg.relocated.com.google.common.collect.ImmutableMap;
import org.apache.iceberg.relocated.com.google.common.collect.Lists;
import org.apache.iceberg.rest.requests.CommitTransactionRequest;
import org.apache.iceberg.rest.requests.CreateNamespaceRequest;
import org.apache.iceberg.rest.requests.CreateTableRequest;
import org.apache.iceberg.rest.requests.RenameTableRequest;
Expand Down Expand Up @@ -130,7 +137,9 @@ enum Route {
HTTPMethod.POST,
"v1/namespaces/{namespace}/tables/{table}/metrics",
ReportMetricsRequest.class,
null);
null),
COMMIT_TRANSACTION(
HTTPMethod.POST, "v1/transactions/commit", CommitTransactionRequest.class, null);

private final HTTPMethod method;
private final int requiredLength;
Expand Down Expand Up @@ -357,12 +366,49 @@ public <T extends RESTResponse> T handleRequest(
return null;
}

case COMMIT_TRANSACTION:
{
CommitTransactionRequest request = castRequest(CommitTransactionRequest.class, body);
commitTransaction(catalog, request);
return null;
}

default:
}

return null;
}

/**
* This is a very simplistic approach that only validates the requirements for each table and does
* not do any other conflict detection. Therefore, it does not guarantee true transactional
* atomicity, which is left to the implementation details of a REST server.
*/
private static void commitTransaction(Catalog catalog, CommitTransactionRequest request) {
List<Transaction> transactions = Lists.newArrayList();

for (UpdateTableRequest tableChange : request.tableChanges()) {
Table table = catalog.loadTable(tableChange.identifier());
if (table instanceof BaseTable) {
Transaction transaction =
Transactions.newTransaction(
tableChange.identifier().toString(), ((BaseTable) table).operations());
transactions.add(transaction);

BaseTransaction.TransactionTable txTable =
(BaseTransaction.TransactionTable) transaction.table();

// this performs validations and makes temporary commits that are in-memory
CatalogHandlers.commit(txTable.operations(), tableChange);
} else {
throw new IllegalStateException("Cannot wrap catalog that does not produce BaseTable");
}
}

// only commit if validations passed previously
transactions.forEach(Transaction::commitTransaction);
}

public <T extends RESTResponse> T execute(
HTTPMethod method,
String path,
Expand Down