-
Notifications
You must be signed in to change notification settings - Fork 3.4k
Core: Add REST spec and request for committing changes against multiple tables #7741
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
43 changes: 43 additions & 0 deletions
43
core/src/main/java/org/apache/iceberg/rest/requests/CommitTransactionRequest.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| /* | ||
| * 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.rest.requests; | ||
|
|
||
| import java.util.List; | ||
| import org.apache.iceberg.relocated.com.google.common.base.Preconditions; | ||
| import org.apache.iceberg.rest.RESTRequest; | ||
| import org.immutables.value.Value; | ||
|
|
||
| @Value.Immutable | ||
| public interface CommitTransactionRequest extends RESTRequest { | ||
| List<UpdateTableRequest> tableChanges(); | ||
|
|
||
| @Override | ||
| default void validate() { | ||
| check(); | ||
| } | ||
|
|
||
| @Value.Check | ||
|
nastra marked this conversation as resolved.
Outdated
|
||
| default void check() { | ||
| Preconditions.checkArgument(!tableChanges().isEmpty(), "Invalid table changes: empty"); | ||
| for (UpdateTableRequest tableChange : tableChanges()) { | ||
| Preconditions.checkArgument( | ||
| null != tableChange.identifier(), "Invalid table changes: table identifier required"); | ||
|
nastra marked this conversation as resolved.
|
||
| } | ||
| } | ||
| } | ||
117 changes: 117 additions & 0 deletions
117
core/src/main/java/org/apache/iceberg/rest/requests/CommitTransactionRequestParser.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| /* | ||
| * 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.rest.requests; | ||
|
|
||
| import com.fasterxml.jackson.core.JsonGenerator; | ||
| import com.fasterxml.jackson.databind.JsonNode; | ||
| import java.io.IOException; | ||
| import java.util.List; | ||
| import org.apache.iceberg.MetadataUpdate; | ||
| import org.apache.iceberg.MetadataUpdateParser; | ||
| import org.apache.iceberg.catalog.TableIdentifier; | ||
| import org.apache.iceberg.catalog.TableIdentifierParser; | ||
| import org.apache.iceberg.relocated.com.google.common.base.Preconditions; | ||
| import org.apache.iceberg.relocated.com.google.common.collect.Lists; | ||
| import org.apache.iceberg.util.JsonUtil; | ||
|
|
||
| public class CommitTransactionRequestParser { | ||
| private static final String TABLE_CHANGES = "table-changes"; | ||
| private static final String IDENTIFIER = "identifier"; | ||
| private static final String REQUIREMENTS = "requirements"; | ||
| private static final String UPDATES = "updates"; | ||
|
|
||
| private CommitTransactionRequestParser() {} | ||
|
|
||
| public static String toJson(CommitTransactionRequest request) { | ||
| return toJson(request, false); | ||
| } | ||
|
|
||
| public static String toJson(CommitTransactionRequest request, boolean pretty) { | ||
| return JsonUtil.generate(gen -> toJson(request, gen), pretty); | ||
| } | ||
|
|
||
| public static void toJson(CommitTransactionRequest request, JsonGenerator gen) | ||
| throws IOException { | ||
| Preconditions.checkArgument(null != request, "Invalid commit tx request: null"); | ||
|
|
||
| gen.writeStartObject(); | ||
| gen.writeFieldName(TABLE_CHANGES); | ||
| gen.writeStartArray(); | ||
|
|
||
| for (UpdateTableRequest tableChange : request.tableChanges()) { | ||
| gen.writeStartObject(); | ||
|
|
||
| gen.writeFieldName(IDENTIFIER); | ||
| TableIdentifierParser.toJson(tableChange.identifier(), gen); | ||
|
|
||
| gen.writeArrayFieldStart(REQUIREMENTS); | ||
| for (UpdateTableRequest.UpdateRequirement updateRequirement : tableChange.requirements()) { | ||
| UpdateRequirementParser.toJson(updateRequirement, gen); | ||
| } | ||
| gen.writeEndArray(); | ||
|
|
||
| gen.writeArrayFieldStart(UPDATES); | ||
| for (MetadataUpdate metadataUpdate : tableChange.updates()) { | ||
| MetadataUpdateParser.toJson(metadataUpdate, gen); | ||
| } | ||
| gen.writeEndArray(); | ||
|
|
||
| gen.writeEndObject(); | ||
| } | ||
|
|
||
| gen.writeEndArray(); | ||
| gen.writeEndObject(); | ||
| } | ||
|
|
||
| public static CommitTransactionRequest fromJson(String json) { | ||
| return JsonUtil.parse(json, CommitTransactionRequestParser::fromJson); | ||
| } | ||
|
|
||
| public static CommitTransactionRequest fromJson(JsonNode json) { | ||
| Preconditions.checkArgument(null != json, "Cannot parse commit tx request from null object"); | ||
|
|
||
| ImmutableCommitTransactionRequest.Builder builder = ImmutableCommitTransactionRequest.builder(); | ||
| JsonNode changes = JsonUtil.get(TABLE_CHANGES, json); | ||
|
|
||
| Preconditions.checkArgument( | ||
| changes.isArray(), "Cannot parse commit tx request from non-array: %s", changes); | ||
|
nastra marked this conversation as resolved.
|
||
|
|
||
| for (JsonNode node : changes) { | ||
| TableIdentifier identifier = TableIdentifierParser.fromJson(JsonUtil.get(IDENTIFIER, node)); | ||
|
|
||
| JsonNode requirementsNode = JsonUtil.get(REQUIREMENTS, node); | ||
| List<UpdateTableRequest.UpdateRequirement> requirements = Lists.newArrayList(); | ||
| Preconditions.checkArgument( | ||
| requirementsNode.isArray(), | ||
| "Cannot parse requirements from non-array: %s", | ||
| requirementsNode); | ||
| requirementsNode.forEach(req -> requirements.add(UpdateRequirementParser.fromJson(req))); | ||
|
|
||
| JsonNode updatesNode = JsonUtil.get(UPDATES, node); | ||
| List<MetadataUpdate> updates = Lists.newArrayList(); | ||
| Preconditions.checkArgument( | ||
| updatesNode.isArray(), "Cannot parse metadata updates from non-array: %s", updatesNode); | ||
|
|
||
| updatesNode.forEach(update -> updates.add(MetadataUpdateParser.fromJson(update))); | ||
| builder.addTableChanges(new UpdateTableRequest(identifier, requirements, updates)); | ||
| } | ||
|
|
||
| return builder.build(); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Is this worth using Immutables?
This is straightforward as a simple object, and then callers don't need to know that there is a different implementation class they should use.
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.
I'm ok not using Immutables here, since it's a single field. We'll just end up with slightly more code than in the Immutables version but without another class being generated