rdblue commented on a change in pull request #2255: URL: https://github.com/apache/iceberg/pull/2255#discussion_r582181411
########## File path: api/src/main/java/org/apache/iceberg/actions/RewriteDataFiles.java ########## @@ -0,0 +1,104 @@ +/* + * 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.DataFile; +import org.apache.iceberg.expressions.Expression; + +/** + * An action that rewrites data files. + */ +public interface RewriteDataFiles extends + ConfigurableAction<RewriteDataFiles, RewriteDataFiles.Result>, + SnapshotUpdate<RewriteDataFiles, RewriteDataFiles.Result> { + + /** + * Pass a row filter to filter {@link DataFile}s to be rewritten. + * <p> + * Note that all files that may contain data matching the filter may be rewritten. + * + * @param expr a row filter to filter out data files + * @return this for method chaining + */ + RewriteDataFiles filter(Expression expr); + + /** + * Enables or disables case sensitive expression binding. + * + * @param caseSensitive caseSensitive + * @return this for method chaining + */ + RewriteDataFiles caseSensitive(boolean caseSensitive); + + /** + * Pass a PartitionSpec id to specify which PartitionSpec should be used in DataFile rewrite + * + * @param specId PartitionSpec id to rewrite + * @return this for method chaining + */ + RewriteDataFiles outputSpecId(int specId); + + /** + * Specify the target rewrite data file size in bytes + * + * @param targetSize size in bytes of rewrite data file + * @return this for method chaining + */ + RewriteDataFiles targetSizeInBytes(long targetSize); + + /** + * Specify the number of "bins" considered when trying to pack the next file split into a task. Increasing this + * usually makes tasks a bit more even by considering more ways to pack file regions into a single task with extra + * planning cost. + * <p> + * This configuration can reorder the incoming file regions, to preserve order for lower/upper bounds in file + * metadata, user can use a lookback of 1. + * + * @param splitLookback number of "bins" considered when trying to pack the next file split into a task. + * @return this for method chaining + */ + RewriteDataFiles splitLookback(int splitLookback); + + /** + * Specify the minimum file size to count to pack into one "bin". If the read file size is smaller than this specified + * threshold, Iceberg will use this value to do count. + * <p> + * this configuration controls the number of files to compact for each task, small value would lead to a high + * compaction, the default value is 4MB. + * + * @param splitOpenFileCost minimum file size to count to pack into one "bin". + * @return this for method chaining + */ + RewriteDataFiles splitOpenFileCost(long splitOpenFileCost); + + /** + * The action result that contains a summary of the execution. + */ + interface Result { + /** + * Returns rewritten data files. + */ + Iterable<DataFile> rewrittenDataFiles(); + /** Review comment: Nit: missing newline between methods. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
