rdblue commented on code in PR #12774: URL: https://github.com/apache/iceberg/pull/12774#discussion_r2162709047
########## core/src/main/java/org/apache/iceberg/io/ReadBuilder.java: ########## @@ -0,0 +1,131 @@ +/* + * 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.io; + +import java.nio.ByteBuffer; +import java.util.Map; +import org.apache.iceberg.Schema; +import org.apache.iceberg.expressions.Expression; +import org.apache.iceberg.mapping.NameMapping; + +/** + * Builder interface for creating file readers across supported data file formats. Each {@link + * FileAccessFactory} implementation provides appropriate {@link ReadBuilder} instances based on: + * + * <ul> + * <li>source file format (Parquet, Avro, ORC) + * <li>engine-specific object representation (spark, flink, generic, etc.) + * </ul> + * + * <p>The {@link ReadBuilder} follows the builder pattern to configure and create {@link + * CloseableIterable} instances that read data from source files. Configuration options include + * schema projection, predicate filtering, record batching, and encryption settings. + * + * <p>This interface is directly exposed to users for parameterizing readers. + * + * @param <B> the concrete builder type for method chaining + */ +public interface ReadBuilder<B extends ReadBuilder<B>> { + /** The configuration key for the batch size in the case of vectorized reads. */ + String RECORDS_PER_BATCH_KEY = "iceberg.records-per-batch"; + + /** + * Restricts the read to the given range: [start, start + length). + * + * @param newStart the start position for this read + * @param newLength the length of the range this read should scan + */ + B split(long newStart, long newLength); + + /** Read only the given columns. */ + B project(Schema newSchema); + + /** + * Pushes down the {@link Expression} filter for the reader to prevent reading unnecessary + * records. Some readers might not be able to filter some parts of the expression. In this case + * the reader might return unfiltered or partially filtered rows. It is the caller's + * responsibility to apply the filter again. + * + * @param newFilter the filter to set + * @param filterCaseSensitive whether the filtering is case-sensitive or not + */ + default B filter(Expression newFilter, boolean filterCaseSensitive) { Review Comment: I don't agree that the current API is misleading, but I do understand the concern. The main problem is that this needs to change uses that currently call `caseSensitive(boolean)`. Also, if there are future cases that need to be case insensitive, I don't think it makes sense for them to each be configured individually given that the user/caller expectation is that all name matching is case sensitive or not. For instance, other interfaces (including `Scan`) also expose `select(String... columns)` and the case sensitivity setting is used for both expression binding and for column selection. This change would set a precedent that we should instead use `select(selectCaseSensitive, String... columns)` but that would allow surprising behavior if you set `selectCaseSensitive` differently than `filterCaseSensitive`. I think this should go back to the original `caseSensitive(boolean)`. -- 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. To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For additional commands, e-mail: issues-h...@iceberg.apache.org
