-
Notifications
You must be signed in to change notification settings - Fork 3.4k
API: add an action API for rewrite deletes #2841
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
Changes from 13 commits
a2eee90
ed51fc7
0697cf5
9537fa1
c68303b
6014276
597e8f9
82c8118
bc1a0b9
dee5962
70b7162
dcb3201
a6a2540
6d0853b
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,55 @@ | ||
| /* | ||
| * 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.actions; | ||
|
|
||
| import org.apache.iceberg.expressions.Expression; | ||
|
|
||
| /** | ||
| * An action for converting the equality delete files to position delete files. | ||
| */ | ||
| public interface ConvertEqualityDeleteFiles | ||
| extends SnapshotUpdate<ConvertEqualityDeleteFiles, ConvertEqualityDeleteFiles.Result> { | ||
|
|
||
| /** | ||
| * A row filter for finding the equality deletes to convert. | ||
| * <p> | ||
| * The row filter will be converted to a partition filter with an inclusive projection, so that candidate deletes are | ||
| * selected if any row match the expression. The matching delete files will be converted to position delete files. | ||
|
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 isn't quite correct. An inclusive projection matches if a file can contain rows that match. But it doesn't necessarily. I would change this to "Any file that may contain rows matching this filter will be used by the action."
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. An inclusive metrics evaluator evaluates the file in that way. But when the expression was projected to partition filter, since the partition value of the file is determined, the matching logic should be determined. Please correct me if I understand wrongly. |
||
| * | ||
| * @param expression An iceberg expression used to find deletes. | ||
| * @return this for method chaining | ||
| */ | ||
| ConvertEqualityDeleteFiles rowFilter(Expression expression); | ||
|
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. Since we have just one filter, there is no need to add "row" in the method name. Let's change it back 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. Done. |
||
|
|
||
| /** | ||
| * The action result that contains a summary of the execution. | ||
| */ | ||
| interface Result { | ||
| /** | ||
| * Returns the count of the deletes that been converted. | ||
| */ | ||
| int convertedEqualityDeleteFilesCount(); | ||
|
|
||
| /** | ||
| * Returns the count of the added position delete files. | ||
| */ | ||
| int addedPositionDeleteFilesCount(); | ||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| /* | ||
| * 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.actions; | ||
|
|
||
| import org.apache.iceberg.expressions.Expression; | ||
|
|
||
| /** | ||
| * An action for rewriting position delete files. | ||
| * <p> | ||
| * Generally used for optimizing the size and layout of position delete files within a table. | ||
| */ | ||
| public interface RewritePositionDeleteFiles | ||
| extends SnapshotUpdate<RewritePositionDeleteFiles, RewritePositionDeleteFiles.Result> { | ||
|
|
||
| /** | ||
| * A row filter for finding deletes to rewrite. | ||
| * <p> | ||
| * The row filter will be converted to a partition filter with an inclusive projection, so that candidate deletes are | ||
| * selected if any row match the expression. The matching delete files will be rewritten. | ||
| * | ||
| * @param expression An iceberg expression used to find deletes. | ||
| * @return this for method chaining | ||
| */ | ||
| RewritePositionDeleteFiles rowFilter(Expression expression); | ||
|
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 think that we plan to convert this to a partition filter using an inclusive projection like the equality delete rewrite, correct? @jackye1995, is there a use case for matching files and then using stats to filter out position delete files that don't match? I can't think of one. |
||
|
|
||
| /** | ||
| * The action result that contains a summary of the execution. | ||
| */ | ||
| interface Result { | ||
| /** | ||
| * Returns the count of the position deletes that been rewritten. | ||
| */ | ||
| int rewrittenDeleteFilesCount(); | ||
|
|
||
| /** | ||
| * Returns the count of the added delete files. | ||
| */ | ||
| int addedDeleteFilesCount(); | ||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| /* | ||
| * 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.actions; | ||
|
|
||
| import java.util.Map; | ||
| import java.util.Set; | ||
| import org.apache.iceberg.DeleteFile; | ||
| import org.apache.iceberg.FileScanTask; | ||
| import org.apache.iceberg.Table; | ||
|
|
||
| /** | ||
| * A strategy for the action to convert equality delete to position deletes. | ||
| */ | ||
| public interface ConvertEqualityDeleteStrategy { | ||
|
|
||
| /** | ||
| * Returns the name of this convert deletes strategy | ||
| */ | ||
| String name(); | ||
|
|
||
| /** | ||
| * Returns the table being modified by this convert strategy | ||
| */ | ||
| Table table(); | ||
|
|
||
| /** | ||
| * Returns a set of options which this convert strategy can use. This is an allowed-list and any options not | ||
| * specified here will be rejected at runtime. | ||
| */ | ||
| Set<String> validOptions(); | ||
|
|
||
| /** | ||
| * Sets options to be used with this strategy | ||
| */ | ||
| RewritePositionDeleteStrategy options(Map<String, String> options); | ||
|
|
||
| /** | ||
| * Select the delete files to convert. | ||
| * | ||
| * @param deleteFiles iterable of delete files in a group. | ||
| * @return iterable of original delete file to be converted. | ||
| */ | ||
| Iterable<DeleteFile> selectDeleteFiles(Iterable<DeleteFile> deleteFiles); | ||
|
|
||
| /** | ||
| * Groups delete files into lists which will be processed in a single executable unit. Each group will end up being | ||
| * committed as an independent set of changes. This creates the jobs which will eventually be run as by the underlying | ||
| * Action. | ||
| * | ||
| * @param dataFiles iterable of data files that contain the DeleteFile to be converted | ||
| * @return iterable of lists of FileScanTasks which will be processed together | ||
| */ | ||
| Iterable<Iterable<FileScanTask>> planDeleteFileGroups(Iterable<FileScanTask> dataFiles); | ||
|
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: The order of methods doesn't match
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. will update. |
||
|
|
||
| /** | ||
| * Define how to convert the deletes. | ||
| * | ||
| * @param deleteFilesToConvert a group of files to be converted together | ||
| * @return iterable of delete files used to replace the original delete files. | ||
| */ | ||
| Iterable<DeleteFile> convertDeleteFiles(Iterable<DeleteFile> deleteFilesToConvert); | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| /* | ||
| * 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.actions; | ||
|
|
||
| import java.util.Map; | ||
| import java.util.Set; | ||
| import org.apache.iceberg.DeleteFile; | ||
| import org.apache.iceberg.Table; | ||
|
|
||
| /** | ||
| * A strategy for an action to rewrite position delete files. | ||
| */ | ||
| public interface RewritePositionDeleteStrategy { | ||
|
|
||
| /** | ||
| * Returns the name of this rewrite deletes strategy | ||
| */ | ||
| String name(); | ||
|
|
||
| /** | ||
| * Returns the table being modified by this rewrite strategy | ||
| */ | ||
| Table table(); | ||
|
|
||
| /** | ||
| * Returns a set of options which this rewrite strategy can use. This is an allowed-list and any options not | ||
| * specified here will be rejected at runtime. | ||
| */ | ||
| Set<String> validOptions(); | ||
|
|
||
| /** | ||
| * Sets options to be used with this strategy | ||
| */ | ||
| RewritePositionDeleteStrategy options(Map<String, String> options); | ||
|
|
||
| /** | ||
| * Select the delete files to rewrite. | ||
| * | ||
| * @param deleteFiles iterable of delete files in a group. | ||
| * @return iterable of original delete file to be replaced. | ||
| */ | ||
| Iterable<DeleteFile> selectDeleteFiles(Iterable<DeleteFile> deleteFiles); | ||
|
|
||
| /** | ||
| * Groups into lists which will be processed in a single executable unit. Each group will end up being | ||
| * committed as an independent set of changes. This creates the jobs which will eventually be run as by the underlying | ||
| * Action. | ||
| * | ||
| * @param deleteFiles iterable of DeleteFile to be rewritten | ||
| * @return iterable of lists of FileScanTasks which will be processed together | ||
| */ | ||
| Iterable<Iterable<DeleteFile>> planDeleteFileGroups(Iterable<DeleteFile> deleteFiles); | ||
|
|
||
| /** | ||
| * Define how to rewrite the deletes. | ||
| * | ||
| * @param deleteFilesToRewrite a group of files to be rewritten together | ||
| * @return iterable of delete files used to replace the original delete files. | ||
| */ | ||
| Iterable<DeleteFile> rewriteDeleteFiles(Iterable<DeleteFile> deleteFilesToRewrite); | ||
| } |
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 think that this should mention that this filter will be converted to a partition filter with an inclusive projection and that matching delete files will be rewritten. It should be clear that it isn't possible to match individual deletes, only whole files.
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.
will add doc.