-
Notifications
You must be signed in to change notification settings - Fork 3k
Introduce GenericAppenderFactory and GenericAppenderHelper #1340
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
98 changes: 98 additions & 0 deletions
98
data/src/main/java/org/apache/iceberg/data/GenericAppenderFactory.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| /* | ||
| * 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.io.IOException; | ||
| import java.io.UncheckedIOException; | ||
| import java.util.Map; | ||
| import org.apache.iceberg.FileFormat; | ||
| import org.apache.iceberg.MetricsConfig; | ||
| import org.apache.iceberg.Schema; | ||
| import org.apache.iceberg.avro.Avro; | ||
| import org.apache.iceberg.data.avro.DataWriter; | ||
| import org.apache.iceberg.data.orc.GenericOrcWriter; | ||
| import org.apache.iceberg.data.parquet.GenericParquetWriter; | ||
| import org.apache.iceberg.io.FileAppender; | ||
| import org.apache.iceberg.io.FileAppenderFactory; | ||
| import org.apache.iceberg.io.OutputFile; | ||
| import org.apache.iceberg.orc.ORC; | ||
| import org.apache.iceberg.parquet.Parquet; | ||
| import org.apache.iceberg.relocated.com.google.common.collect.Maps; | ||
|
|
||
| /** | ||
| * Factory to create a new {@link FileAppender} to write {@link Record}s. | ||
| */ | ||
| public class GenericAppenderFactory implements FileAppenderFactory<Record> { | ||
|
|
||
| private final Schema schema; | ||
| private final Map<String, String> config = Maps.newHashMap(); | ||
|
|
||
| public GenericAppenderFactory(Schema schema) { | ||
| this.schema = schema; | ||
| } | ||
|
|
||
| public GenericAppenderFactory set(String property, String value) { | ||
| config.put(property, value); | ||
| return this; | ||
| } | ||
|
|
||
| public GenericAppenderFactory setAll(Map<String, String> properties) { | ||
| config.putAll(properties); | ||
| return this; | ||
| } | ||
|
|
||
| @Override | ||
| public FileAppender<Record> newAppender(OutputFile outputFile, FileFormat fileFormat) { | ||
| MetricsConfig metricsConfig = MetricsConfig.fromProperties(config); | ||
| try { | ||
| switch (fileFormat) { | ||
| case AVRO: | ||
| return Avro.write(outputFile) | ||
| .schema(schema) | ||
| .createWriterFunc(DataWriter::create) | ||
| .setAll(config) | ||
| .overwrite() | ||
| .build(); | ||
|
|
||
| case PARQUET: | ||
| return Parquet.write(outputFile) | ||
| .schema(schema) | ||
| .createWriterFunc(GenericParquetWriter::buildWriter) | ||
| .setAll(config) | ||
| .metricsConfig(metricsConfig) | ||
| .overwrite() | ||
| .build(); | ||
|
|
||
| case ORC: | ||
| return ORC.write(outputFile) | ||
| .schema(schema) | ||
| .createWriterFunc(GenericOrcWriter::buildWriter) | ||
| .setAll(config) | ||
| .overwrite() | ||
| .build(); | ||
|
|
||
| default: | ||
| throw new UnsupportedOperationException("Cannot write format: " + fileFormat); | ||
| } | ||
| } catch (IOException e) { | ||
| throw new UncheckedIOException(e); | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
97 changes: 97 additions & 0 deletions
97
data/src/test/java/org/apache/iceberg/data/GenericAppenderHelper.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| /* | ||
| * 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.io.File; | ||
| import java.io.IOException; | ||
| import java.util.List; | ||
| import org.apache.iceberg.AppendFiles; | ||
| import org.apache.iceberg.DataFile; | ||
| import org.apache.iceberg.DataFiles; | ||
| import org.apache.iceberg.FileFormat; | ||
| import org.apache.iceberg.Files; | ||
| import org.apache.iceberg.StructLike; | ||
| import org.apache.iceberg.Table; | ||
| import org.apache.iceberg.io.FileAppender; | ||
| import org.apache.iceberg.relocated.com.google.common.base.Preconditions; | ||
| import org.junit.Assert; | ||
| import org.junit.rules.TemporaryFolder; | ||
|
|
||
| /** | ||
| * Helper for appending {@link DataFile} to a table or appending {@link Record}s to a table. | ||
| */ | ||
| public class GenericAppenderHelper { | ||
|
|
||
| private final Table table; | ||
| private final FileFormat fileFormat; | ||
| private final TemporaryFolder tmp; | ||
|
|
||
| public GenericAppenderHelper(Table table, FileFormat fileFormat, TemporaryFolder tmp) { | ||
| this.table = table; | ||
| this.fileFormat = fileFormat; | ||
| this.tmp = tmp; | ||
| } | ||
|
|
||
| public void appendToTable(DataFile... dataFiles) { | ||
| Preconditions.checkNotNull(table, "table not set"); | ||
|
|
||
| AppendFiles append = table.newAppend(); | ||
|
|
||
| for (DataFile dataFile : dataFiles) { | ||
| append = append.appendFile(dataFile); | ||
| } | ||
|
|
||
| append.commit(); | ||
| } | ||
|
|
||
| public void appendToTable(List<Record> records) throws IOException { | ||
| appendToTable(null, records); | ||
| } | ||
|
|
||
| public void appendToTable(StructLike partition, List<Record> records) throws IOException { | ||
| appendToTable(writeFile(partition, records)); | ||
| } | ||
|
|
||
| public DataFile writeFile(StructLike partition, List<Record> records) throws IOException { | ||
| Preconditions.checkNotNull(table, "table not set"); | ||
| File file = tmp.newFile(); | ||
| Assert.assertTrue(file.delete()); | ||
| return appendToLocalFile(table, file, fileFormat, partition, records); | ||
| } | ||
|
|
||
| private static DataFile appendToLocalFile( | ||
| Table table, File file, FileFormat format, StructLike partition, List<Record> records) | ||
| throws IOException { | ||
| FileAppender<Record> appender = new GenericAppenderFactory(table.schema()).newAppender( | ||
| Files.localOutput(file), format); | ||
| try (FileAppender<Record> fileAppender = appender) { | ||
| fileAppender.addAll(records); | ||
| } | ||
|
|
||
| return DataFiles.builder(table.spec()) | ||
| .withRecordCount(records.size()) | ||
| .withFileSizeInBytes(file.length()) | ||
| .withPath(file.toURI().toString()) | ||
| .withMetrics(appender.metrics()) | ||
| .withFormat(format) | ||
| .withPartition(partition) | ||
| .build(); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
To keep the consistent semantics, I suggest to set
overwrite=true. Both flink and spark's FileAppenderFactory have enabled the overwrite.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.
Yes, they do.