RussellSpitzer commented on a change in pull request #2379: URL: https://github.com/apache/iceberg/pull/2379#discussion_r609718416
########## File path: api/src/main/java/org/apache/iceberg/actions/compaction/DataCompactionStrategy.java ########## @@ -0,0 +1,103 @@ +/* + * 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.compaction; + +import java.io.Serializable; +import java.util.Iterator; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.stream.Collectors; +import org.apache.iceberg.DataFile; +import org.apache.iceberg.FileScanTask; +import org.apache.iceberg.Table; +import org.apache.iceberg.expressions.Expression; +import org.apache.iceberg.expressions.Expressions; +import org.apache.iceberg.relocated.com.google.common.collect.Sets; + +public interface DataCompactionStrategy extends Serializable { + + /** + * Returns the name of this compaction strategy + */ + String name(); + + /** + * Returns a set of options which this compaction strategy can use. This is an allowed-list and any options not + * specified here will be rejected at runtime. + */ + Set<String> validOptions(); + + default void validateOptions(Map<String, String> options) { + Sets.SetView<String> invalidOptions = Sets.difference(options.keySet(), validOptions()); + if (!invalidOptions.isEmpty()) { + String invalidColumnString = invalidOptions.stream().collect(Collectors.joining(",", "[", "]")); + String validColumnString = validOptions().stream().collect(Collectors.joining(",", "[", "]")); + + throw new IllegalArgumentException(String.format( + "Cannot use strategy %s with unknown options %s. This strategy accepts %s", + name(), invalidColumnString, validColumnString)); + } + } + + DataCompactionStrategy withOptions(Map<String, String> options); + + /** + * Before the compaction strategy rules are applied, the underlying action has the ability to use this expression + * to filter the FileScanTasks which will be created when planning file reads that will later be run through + * this compaction strategy. + * + * @return an Iceberg expression to use when discovering file scan tasks + */ + default Expression preFilter() { + return Expressions.alwaysTrue(); + } + + /** + * Removes all file references which this plan will not rewrite or change. Unlike the preFilter, this method can + * execute arbitrary code and isn't restricted to just Iceberg Expressions. This should be serializable so that + * Actions which run remotely can utilize the method. + * + * @param dataFiles iterator of live datafiles in a given partition + * @return iterator containing only files to be rewritten + */ + Iterator<FileScanTask> filesToCompact(Iterator<FileScanTask> dataFiles); Review comment: Yeah I'm trying to differentiate Manfiest entry pushdowns and algorithm specific filtering -- 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]
