stevenzwu commented on code in PR #12774: URL: https://github.com/apache/iceberg/pull/12774#discussion_r2441157815
########## core/src/main/java/org/apache/iceberg/formats/WriteBuilder.java: ########## @@ -0,0 +1,115 @@ +/* + * 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.formats; + +import java.io.IOException; +import java.nio.ByteBuffer; +import java.util.Map; +import org.apache.iceberg.FileContent; +import org.apache.iceberg.MetricsConfig; +import org.apache.iceberg.Schema; +import org.apache.iceberg.io.FileAppender; + +/** + * Builder interface for creating file writers across supported data file formats. The {@link + * FormatModel} implementations provide the appropriate {@link WriteBuilder} instances. + * + * <p>The {@link WriteBuilder} follows the builder pattern to configure and create {@link + * FileAppender} instances that write data to the target output files. + * + * <p>This interface is directly exposed to users for parameterizing when only an appender is + * required. + */ +public interface WriteBuilder { + /** Set the file schema. */ + WriteBuilder schema(Schema schema); + + /** + * Sets the input schema accepted by the writer. If not provided derived from the {@link + * #schema(Schema)}. + */ + WriteBuilder inputSchema(Object schema); + + /** + * Set a writer configuration property which affects the writer behavior. + * + * @param property a writer config property name + * @param value config value + * @return this for method chaining + */ + WriteBuilder set(String property, String value); + + /** + * Sets multiple writer configuration properties that affect the writer behavior. + * + * @param properties writer config properties to set + * @return this for method chaining + */ + default WriteBuilder setAll(Map<String, String> properties) { + properties.forEach(this::set); + return this; + } + + /** + * Set a file metadata property in the created file. + * + * @param property a file metadata property name + * @param value config value + * @return this for method chaining + */ + WriteBuilder meta(String property, String value); + + /** + * Sets multiple file metadata properties in the created file. + * + * @param properties file metadata properties to set + * @return this for method chaining + */ + default WriteBuilder meta(Map<String, String> properties) { + properties.forEach(this::meta); + return this; + } + + /** + * Based on the target file content the generated {@link FileAppender} needs different + * configuration. + */ + WriteBuilder content(FileContent content); + + /** Sets the metrics configuration used for collecting column metrics for the created file. */ + WriteBuilder metricsConfig(MetricsConfig metricsConfig); + + /** Overwrite the file if it already exists. By default, overwrite is disabled. */ + WriteBuilder overwrite(); + + /** + * Sets the encryption key used for writing the file. If the writer does not support encryption, + * then an exception should be thrown. + */ + WriteBuilder withFileEncryptionKey(ByteBuffer encryptionKey); + + /** + * Sets the additional authentication data (AAD) prefix used for writing the file. If the reader + * does not support encryption, then an exception should be thrown. + */ + WriteBuilder withAADPrefix(ByteBuffer aadPrefix); + + /** Finalizes the configuration and builds the {@link FileAppender}. */ + <D> FileAppender<D> build() throws IOException; Review Comment: do we still need this with the FileAppenderFactory deprecation merged? ########## core/src/test/java/org/apache/iceberg/formats/TestFormatModelRegistry.java: ########## @@ -0,0 +1,134 @@ +/* + * 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.formats; + +import static org.assertj.core.api.Assertions.assertThatThrownBy; +import static org.assertj.core.api.AssertionsForInterfaceTypes.assertThat; + +import org.apache.iceberg.FileFormat; +import org.apache.iceberg.io.InputFile; +import org.apache.iceberg.io.OutputFile; +import org.apache.iceberg.util.Pair; +import org.junit.jupiter.api.Test; + +class TestFormatModelRegistry { + /** Tests that registering the same class with the same configuration is successful. */ + @Test + void testSuccessfulReRegister() { + // It is fine to register the same classes with the same configuration multiple times Review Comment: nit: move this comment line to just before line 39 ########## core/src/main/java/org/apache/iceberg/formats/ContentFileWriteBuilderImpl.java: ########## @@ -0,0 +1,333 @@ +/* + * 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.formats; + +import java.io.IOException; +import java.nio.ByteBuffer; +import java.util.List; +import java.util.Objects; +import java.util.stream.Collectors; +import java.util.stream.IntStream; +import org.apache.iceberg.FileFormat; +import org.apache.iceberg.Metrics; +import org.apache.iceberg.MetricsConfig; +import org.apache.iceberg.PartitionSpec; +import org.apache.iceberg.Schema; +import org.apache.iceberg.SortOrder; +import org.apache.iceberg.StructLike; +import org.apache.iceberg.deletes.EqualityDeleteWriter; +import org.apache.iceberg.deletes.PositionDelete; +import org.apache.iceberg.deletes.PositionDeleteWriter; +import org.apache.iceberg.encryption.EncryptionKeyMetadata; +import org.apache.iceberg.io.DataWriter; +import org.apache.iceberg.io.FileAppender; +import org.apache.iceberg.relocated.com.google.common.base.Preconditions; + +/** + * An internal implementation that handles all {@link ContentFileWriteBuilder} interface variants. + * + * <p>This unified implementation serves as a backend for multiple specialized content writers: + * + * <ul> + * <li>{@link DataWriteBuilder} for creating data files + * <li>{@link EqualityDeleteWriteBuilder} for creating equality delete files + * <li>{@link PositionDeleteWriteBuilder} for creating position delete files + * </ul> + * + * <p>The implementation delegates to a format-specific {@link WriteBuilder} while enriching it with + * content-specific functionality. When building a writer, the implementation configures the + * underlying builder and calls its {@link WriteBuilder#build()} method to create the appropriate + * specialized writer for the requested content type. + * + * @param <B> the concrete builder type for method chaining + * @param <S> the type of the schema for the input data + * @param <D> the type of data records the writer will accept + */ +abstract class ContentFileWriteBuilderImpl<B extends ContentFileWriteBuilder<B>, D, S> + implements ContentFileWriteBuilder<B> { + private final WriteBuilder writeBuilder; + private final String location; + private final FileFormat format; + private PartitionSpec spec = null; + private StructLike partition = null; + private EncryptionKeyMetadata keyMetadata = null; + private SortOrder sortOrder = null; + + static <D, S> DataWriteBuilder<D, S> forDataFile( + WriteBuilder writeBuilder, String location, FileFormat format) { + return new DataFileWriteBuilder<>(writeBuilder, location, format); + } + + static <D, S> EqualityDeleteWriteBuilder<D, S> forEqualityDelete( + WriteBuilder writeBuilder, String location, FileFormat format) { + return new EqualityDeleteFileWriteBuilder<>(writeBuilder, location, format); + } + + static PositionDeleteWriteBuilder forPositionDelete( + WriteBuilder writeBuilder, String location, FileFormat format) { + return new PositionDeleteFileWriteBuilder(writeBuilder, location, format); + } + + private ContentFileWriteBuilderImpl( + WriteBuilder writeBuilder, String location, FileFormat format) { + this.writeBuilder = writeBuilder; + this.location = location; + this.format = format; + } + + @Override + public B set(String property, String value) { + writeBuilder.set(property, value); + return self(); + } + + @Override + public B meta(String property, String value) { + writeBuilder.meta(property, value); + return self(); + } + + @Override + public B metricsConfig(MetricsConfig metricsConfig) { + writeBuilder.metricsConfig(metricsConfig); + return self(); + } + + @Override + public B overwrite() { + writeBuilder.overwrite(); + return self(); + } + + @Override + public B withFileEncryptionKey(ByteBuffer encryptionKey) { + writeBuilder.withFileEncryptionKey(encryptionKey); + return self(); + } + + @Override + public B withAADPrefix(ByteBuffer aadPrefix) { + writeBuilder.withAADPrefix(aadPrefix); + return self(); + } + + @Override + public B spec(PartitionSpec newSpec) { + this.spec = newSpec; + return self(); + } + + @Override + public B partition(StructLike newPartition) { + this.partition = newPartition; + return self(); + } + + @Override + public B keyMetadata(EncryptionKeyMetadata newKeyMetadata) { + this.keyMetadata = newKeyMetadata; + return self(); + } + + @Override + public B sortOrder(SortOrder newSortOrder) { + this.sortOrder = newSortOrder; + return self(); + } + + private static class DataFileWriteBuilder<D, S> + extends ContentFileWriteBuilderImpl<DataWriteBuilder<D, S>, D, S> + implements DataWriteBuilder<D, S> { + private DataFileWriteBuilder(WriteBuilder writeBuilder, String location, FileFormat format) { + super(writeBuilder, location, format); + } + + @Override + public DataFileWriteBuilder<D, S> schema(Schema schema) { + super.writeBuilder.schema(schema); + return this; + } + + @Override + public DataFileWriteBuilder<D, S> inputSchema(S schema) { + super.writeBuilder.inputSchema(schema); + return this; + } + + @Override + public DataFileWriteBuilder<D, S> self() { + return this; + } + + @Override + public DataWriter<D> build() throws IOException { + Preconditions.checkArgument(super.spec != null, "Cannot create data writer without spec"); + Preconditions.checkArgument( + super.spec.isUnpartitioned() || super.partition != null, + "Partition must not be null when creating data writer for partitioned spec"); + + return new DataWriter<>( + super.writeBuilder.build(), + super.format, + super.location, + super.spec, + super.partition, + super.keyMetadata, + super.sortOrder); + } + } + + private static class EqualityDeleteFileWriteBuilder<D, S> + extends ContentFileWriteBuilderImpl<EqualityDeleteWriteBuilder<D, S>, D, S> + implements EqualityDeleteWriteBuilder<D, S> { + private Schema rowSchema = null; + private int[] equalityFieldIds = null; + + private EqualityDeleteFileWriteBuilder( + WriteBuilder writeBuilder, String location, FileFormat format) { + super(writeBuilder, location, format); + } + + @Override + public EqualityDeleteFileWriteBuilder<D, S> schema(Schema schema) { + super.writeBuilder.schema(schema); + return this; + } + + @Override + public EqualityDeleteFileWriteBuilder<D, S> inputSchema(S schema) { + super.writeBuilder.inputSchema(schema); + return this; + } + + @Override + public EqualityDeleteFileWriteBuilder<D, S> self() { + return this; + } + + @Override + public EqualityDeleteFileWriteBuilder<D, S> rowSchema(Schema schema) { + this.rowSchema = schema; Review Comment: `rowSchema` is eventually set to builder as `super.writeBuilder.schema(schema)` in `build()` method. but the `schema(Schema schmea` in line 208 also does the same thing. do we need two methods for the same thing? ########## core/src/test/java/org/apache/iceberg/formats/TestFormatModelRegistry.java: ########## @@ -0,0 +1,134 @@ +/* + * 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.formats; + +import static org.assertj.core.api.Assertions.assertThatThrownBy; +import static org.assertj.core.api.AssertionsForInterfaceTypes.assertThat; + +import org.apache.iceberg.FileFormat; +import org.apache.iceberg.io.InputFile; +import org.apache.iceberg.io.OutputFile; +import org.apache.iceberg.util.Pair; +import org.junit.jupiter.api.Test; + +class TestFormatModelRegistry { + /** Tests that registering the same class with the same configuration is successful. */ + @Test + void testSuccessfulReRegister() { + // It is fine to register the same classes with the same configuration multiple times + DummyFormatModel model = new DummyFormatModel(Object.class, Object.class); + FormatModelRegistry.register(model); + assertThat(FormatModelRegistry.models()) + .containsEntry(Pair.of(FileFormat.PARQUET, Object.class), model); + FormatModelRegistry.register(model); + assertThat(FormatModelRegistry.models()) + .containsEntry(Pair.of(FileFormat.PARQUET, Object.class), model); + } + + /** Tests that registering the same class with the same configuration updates the registration. */ + @Test + void testUpdatedRegistration() { + DummyFormatModel model1 = new DummyFormatModel(Object.class, Object.class); + DummyFormatModel model2 = new DummyFormatModel(Object.class, Object.class); + FormatModelRegistry.register(model1); + assertThat(FormatModelRegistry.models().get(Pair.of(model1.format(), model1.type()))) + .isEqualTo(model1); + + // Registering a new model with the same format and schema type should replace the old one + FormatModelRegistry.register(model2); + assertThat(FormatModelRegistry.models().get(Pair.of(model1.format(), model1.type()))) + .isNotEqualTo(model1); + assertThat(FormatModelRegistry.models().get(Pair.of(model1.format(), model1.type()))) + .isEqualTo(model2); Review Comment: #`isNotSameAs` and `isSameAs` might be more accurate for identity comparison here, although `isEqualTo` works the same here because `DummyFormatModel` doesn't override `equalsTo` method ########## core/src/test/java/org/apache/iceberg/formats/TestFormatModelRegistry.java: ########## @@ -0,0 +1,134 @@ +/* + * 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.formats; + +import static org.assertj.core.api.Assertions.assertThatThrownBy; +import static org.assertj.core.api.AssertionsForInterfaceTypes.assertThat; + +import org.apache.iceberg.FileFormat; +import org.apache.iceberg.io.InputFile; +import org.apache.iceberg.io.OutputFile; +import org.apache.iceberg.util.Pair; +import org.junit.jupiter.api.Test; + +class TestFormatModelRegistry { + /** Tests that registering the same class with the same configuration is successful. */ + @Test + void testSuccessfulReRegister() { + // It is fine to register the same classes with the same configuration multiple times + DummyFormatModel model = new DummyFormatModel(Object.class, Object.class); Review Comment: nit: rename `DummyFormatModel` to `DummyParquetFormatModel` ########## core/src/main/java/org/apache/iceberg/formats/ReadBuilder.java: ########## @@ -0,0 +1,118 @@ +/* + * 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.formats; + +import java.nio.ByteBuffer; +import java.util.Map; +import org.apache.iceberg.Schema; +import org.apache.iceberg.expressions.Expression; +import org.apache.iceberg.io.CloseableIterable; +import org.apache.iceberg.mapping.NameMapping; + +/** + * Builder interface for creating file readers across supported data file formats. The {@link + * FormatModel} implementations provides appropriate {@link ReadBuilder} instances + * + * <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. + */ +public interface ReadBuilder { + /** + * 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 + */ + ReadBuilder split(long newStart, long newLength); + + /** Set the projection schema. */ + ReadBuilder project(Schema schema); + + /** Sets the expected output schema. If not provided derived from the {@link #project(Schema)}. */ + default ReadBuilder outputSchema(Object schema) { Review Comment: this doesn't seem to be used in the PoC uber PR #12298 ########## core/src/main/java/org/apache/iceberg/formats/FormatModelRegistry.java: ########## @@ -0,0 +1,244 @@ +/* + * 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.data; + +import java.util.List; +import java.util.Map; +import org.apache.iceberg.ContentFile; +import org.apache.iceberg.DataFile; +import org.apache.iceberg.DeleteFile; +import org.apache.iceberg.FileContent; +import org.apache.iceberg.FileFormat; +import org.apache.iceberg.common.DynMethods; +import org.apache.iceberg.deletes.EqualityDeleteWriter; +import org.apache.iceberg.deletes.PositionDelete; +import org.apache.iceberg.deletes.PositionDeleteWriter; +import org.apache.iceberg.encryption.EncryptedOutputFile; +import org.apache.iceberg.io.DataWriter; +import org.apache.iceberg.io.FileAppender; +import org.apache.iceberg.io.FormatModel; +import org.apache.iceberg.io.InputFile; +import org.apache.iceberg.io.ReadBuilder; +import org.apache.iceberg.io.WriteBuilder; +import org.apache.iceberg.relocated.com.google.common.base.Preconditions; +import org.apache.iceberg.relocated.com.google.common.collect.ImmutableList; +import org.apache.iceberg.relocated.com.google.common.collect.Maps; +import org.apache.iceberg.util.Pair; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * A registry that manages file-format-specific readers and writers through a unified object model + * factory interface. + * + * <p>This registry provides access to {@link ReadBuilder}s for data consumption and various writer + * builders: + * + * <ul> + * <li>{@link WriteBuilder} for basic file writing, + * <li>{@link DataWriteBuilder} for data files, + * <li>{@link EqualityDeleteWriteBuilder} for equality deletes, + * <li>{@link PositionDeleteWriteBuilder} for position deletes. + * </ul> + * + * The appropriate builder is selected based on {@link FileFormat} and object model name. + * + * <p>{@link FormatModel} objects are registered through {@link #register(FormatModel)} and used for + * creating readers and writers. Read builders are returned directly from the factory. Write + * builders may be wrapped in specialized content file writer implementations depending on the + * requested builder type. + */ +public final class FormatModelRegistry { + private static final Logger LOG = LoggerFactory.getLogger(FormatModelRegistry.class); + // The list of classes which are used for registering the reader and writer builders + private static final List<String> CLASSES_TO_REGISTER = ImmutableList.of(); + + private static final Map<Pair<FileFormat, Class<?>>, FormatModel<?, ?>> FORMAT_MODELS = + Maps.newConcurrentMap(); + + private FormatModelRegistry() {} + + /** + * Registers an {@link FormatModel} in this registry. + * + * <p>The {@link FormatModel} creates readers and writers for a specific combinations of file + * format (Parquet, ORC, Avro) and object model (for example: "generic", "spark", "flink", etc.). + * Registering custom factories allows integration of new data processing engines for the + * supported file formats with Iceberg's file access mechanisms. + * + * <p>Each factory must be uniquely identified by its combination of file format and object model + * name. This uniqueness constraint prevents ambiguity when selecting factories for read and write + * operations. + * + * @param formatModel the factory implementation to register + * @throws IllegalArgumentException if a factory is already registered for the combination of + * {@link FormatModel#format()} and {@link FormatModel#type()} + */ + public static void register(FormatModel<?, ?> formatModel) { + Pair<FileFormat, Class<?>> key = Pair.of(formatModel.format(), formatModel.type()); + Preconditions.checkArgument( + !FORMAT_MODELS.containsKey(key), + "Cannot register %s: %s is registered for format=%s model=%s", + formatModel.getClass(), + FORMAT_MODELS.containsKey(key) ? FORMAT_MODELS.get(key).getClass() : null, + key.first(), + key.second()); + + FORMAT_MODELS.put(key, formatModel); + } + + @SuppressWarnings("CatchBlockLogException") + private static void registerSupportedFormats() { + // Uses dynamic methods to call the `register` for the listed classes + for (String classToRegister : CLASSES_TO_REGISTER) { + try { + DynMethods.builder("register").impl(classToRegister).buildStaticChecked().invoke(); + } catch (NoSuchMethodException e) { + // failing to register a factory is normal and does not require a stack trace + LOG.info("Unable to register {}: {}", classToRegister, e.getMessage()); + } + } + } + + static { + registerSupportedFormats(); + } + + /** + * Returns a reader builder for the specified file format and object model. + * + * <p>The returned {@link ReadBuilder} provides a fluent interface for configuring how data is + * read from the input file and converted to the output objects. The builder supports + * configuration options like schema projection, predicate pushdown, batch size and encryption. + * + * @param format the file format (Parquet, Avro, ORC) that determines the parsing implementation + * @param type the output type + * @param inputFile source file to read data from + * @param <D> the type of data records the reader will produce + * @return a configured reader builder for the specified format and object model + */ + public static <D, S> ReadBuilder<D, S> readBuilder( + FileFormat format, Class<D> type, InputFile inputFile) { + FormatModel<D, S> factory = factoryFor(format, type); + return factory.readBuilder(inputFile); + } + + /** + * Returns a writer builder for appending data to the specified output file. + * + * <p>The returned builder produces a {@link FileAppender} that accepts records defined by the + * specified object model and persists them using the given file format. Data is written to the + * output file, but this basic writer does not collect or return {@link ContentFile} metadata. + * + * @param format the file format used for writing + * @param type the input type + * @param outputFile destination for the written data + * @param <D> the type of data records the writer will accept + * @return a configured writer builder for creating the appender + */ + public static <D, S> WriteBuilder<D, S> writeBuilder( + FileFormat format, Class<D> type, EncryptedOutputFile outputFile) { + FormatModel<D, S> factory = factoryFor(format, type); + return factory.writeBuilder(outputFile.encryptingOutputFile()).content(FileContent.DATA); + } + + /** + * Returns a writer builder for generating a {@link DataFile}. + * + * <p>The returned builder produces a writer that accepts records defined by the specified object + * model and persists them using the provided file format. Unlike basic writers, this writer + * collects file metadata during the writing process and generates a {@link DataFile} that can be + * used for table operations. + * + * @param format the file format used for writing + * @param type the input type + * @param outputFile destination for the written data + * @param <D> the type of data records the writer will accept + * @return a configured data write builder for creating a {@link DataWriter} + */ + public static <D, S> DataWriteBuilder<D, S> dataWriteBuilder( + FileFormat format, Class<D> type, EncryptedOutputFile outputFile) { + FormatModel<D, S> factory = factoryFor(format, type); + WriteBuilder<D, S> writeBuilder = + factory.writeBuilder(outputFile.encryptingOutputFile()).content(FileContent.DATA); + return ContentFileWriteBuilderImpl.forDataFile( + writeBuilder, outputFile.encryptingOutputFile().location(), format); + } + + /** + * Creates a writer builder for generating a {@link DeleteFile} with equality deletes. + * + * <p>The returned builder produces a writer that accepts records defined by the specified object + * model and persists them using the given file format. The writer persists equality delete + * records that identify rows to be deleted based on the configured equality fields, producing a + * {@link DeleteFile} that can be used for table operations. + * + * @param format the file format used for writing + * @param type the input type + * @param outputFile destination for the written data + * @param <D> the type of data records the writer will accept + * @return a configured delete write builder for creating an {@link EqualityDeleteWriter} + */ + public static <D, S> EqualityDeleteWriteBuilder<D, S> equalityDeleteWriteBuilder( + FileFormat format, Class<D> type, EncryptedOutputFile outputFile) { + FormatModel<D, S> factory = factoryFor(format, type); + WriteBuilder<D, S> writeBuilder = + factory + .writeBuilder(outputFile.encryptingOutputFile()) + .content(FileContent.EQUALITY_DELETES); + return ContentFileWriteBuilderImpl.forEqualityDelete( + writeBuilder, outputFile.encryptingOutputFile().location(), format); + } + + /** + * Creates a writer builder for generating a {@link DeleteFile} with position-based deletes. + * + * <p>The returned builder produces a writer that accepts records defined by the specified object + * model and persists them using the given file format. The writer accepts {@link PositionDelete} + * records that identify rows to be deleted by file path and position, producing a {@link + * DeleteFile} that can be used for table operations. + * + * @param format the file format used for writing + * @param outputFile destination for the written data + * @return a configured delete write builder for creating a {@link PositionDeleteWriter} + */ + public static PositionDeleteWriteBuilder positionDeleteWriteBuilder( + FileFormat format, EncryptedOutputFile outputFile) { + FormatModel<PositionDelete<?>, Object> factory = factoryForPositionDelete(format); + WriteBuilder<PositionDelete<?>, Object> writeBuilder = + factory + .writeBuilder(outputFile.encryptingOutputFile()) + .content(FileContent.POSITION_DELETES); + return ContentFileWriteBuilderImpl.forPositionDelete( + writeBuilder, outputFile.encryptingOutputFile().location(), format); + } + + @SuppressWarnings("unchecked") + private static <D, S> FormatModel<D, S> factoryFor(FileFormat format, Class<D> type) { Review Comment: nit: `Format model is not registered for format %s and type %s` ########## core/src/main/java/org/apache/iceberg/formats/FormatModel.java: ########## @@ -0,0 +1,86 @@ +/* + * 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.formats; + +import org.apache.iceberg.FileFormat; +import org.apache.iceberg.io.InputFile; +import org.apache.iceberg.io.OutputFile; + +/** + * Interface that provides a unified abstraction for converting between data file formats and + * input/output data representations. + * + * <p>{@link FormatModel} serves as a bridge between storage formats ({@link FileFormat}) and + * expected input/output data structures, optimizing performance through direct conversion without + * intermediate representations. File format implementations handle the low-level parsing details + * while the object model determines the in-memory representation used for the parsed data. + * Together, these provide a consistent API for consuming data files while optimizing for specific + * processing engines. + * + * <p>Iceberg provides some built-in object models and processing engines can implement custom + * object models to integrate with Iceberg's file reading and writing capabilities. + * + * @param <D> output type used for reading data, and input type for writing data and deletes + * @param <S> the type of the schema for the input/output data + */ +public interface FormatModel<D, S> { + /** The file format which is read/written by the object model. */ + FileFormat format(); + + /** + * Returns the unique identifier for the object model implementation processed by this factory. Review Comment: nit: `the unique identifier` seems unclear to me. Maybe? ``` Return the row type class ``` -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
