Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[FLINK-16951][parquet] Integrate parquet to file system connector
This closes #11653
- Loading branch information
1 parent
7280f98
commit 8127339
Showing
6 changed files
with
387 additions
and
2 deletions.
There are no files selected for viewing
This file contains 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
248 changes: 248 additions & 0 deletions
248
...arquet/src/main/java/org/apache/flink/formats/parquet/ParquetFileSystemFormatFactory.java
This file contains 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,248 @@ | ||
/* | ||
* 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.flink.formats.parquet; | ||
|
||
import org.apache.flink.api.common.io.FileInputFormat; | ||
import org.apache.flink.api.common.io.InputFormat; | ||
import org.apache.flink.api.common.serialization.BulkWriter; | ||
import org.apache.flink.api.common.serialization.Encoder; | ||
import org.apache.flink.configuration.ConfigOption; | ||
import org.apache.flink.core.fs.FileInputSplit; | ||
import org.apache.flink.core.fs.Path; | ||
import org.apache.flink.formats.parquet.row.ParquetRowDataBuilder; | ||
import org.apache.flink.formats.parquet.utils.SerializableConfiguration; | ||
import org.apache.flink.formats.parquet.vector.ParquetColumnarRowSplitReader; | ||
import org.apache.flink.formats.parquet.vector.ParquetSplitReaderUtil; | ||
import org.apache.flink.table.dataformat.BaseRow; | ||
import org.apache.flink.table.descriptors.DescriptorProperties; | ||
import org.apache.flink.table.filesystem.FileSystemFormatFactory; | ||
import org.apache.flink.table.filesystem.PartitionPathUtils; | ||
import org.apache.flink.table.types.DataType; | ||
import org.apache.flink.table.types.logical.LogicalType; | ||
import org.apache.flink.table.types.logical.RowType; | ||
|
||
import org.apache.hadoop.conf.Configuration; | ||
import org.apache.parquet.hadoop.ParquetOutputFormat; | ||
|
||
import java.io.IOException; | ||
import java.util.Arrays; | ||
import java.util.HashMap; | ||
import java.util.LinkedHashMap; | ||
import java.util.List; | ||
import java.util.Map; | ||
import java.util.Optional; | ||
|
||
import static org.apache.flink.configuration.ConfigOptions.key; | ||
import static org.apache.flink.table.dataformat.vector.VectorizedColumnBatch.DEFAULT_SIZE; | ||
import static org.apache.flink.table.descriptors.FormatDescriptorValidator.FORMAT; | ||
import static org.apache.flink.table.filesystem.RowPartitionComputer.restorePartValueFromType; | ||
|
||
/** | ||
* Parquet {@link FileSystemFormatFactory} for file system. | ||
*/ | ||
public class ParquetFileSystemFormatFactory implements FileSystemFormatFactory { | ||
|
||
public static final ConfigOption<Boolean> UTC_TIMEZONE = key("format.utc-timezone") | ||
.booleanType() | ||
.defaultValue(false) | ||
.withDescription("Use UTC timezone or local timezone to the conversion between epoch" + | ||
" time and LocalDateTime. Hive 0.x/1.x/2.x use local timezone. But Hive 3.x" + | ||
" use UTC timezone"); | ||
|
||
/** | ||
* Prefix for parquet-related properties, besides format, start with "parquet". | ||
* See more in {@link ParquetOutputFormat}. | ||
* - parquet.compression | ||
* - parquet.block.size | ||
* - parquet.page.size | ||
* - parquet.dictionary.page.size | ||
* - parquet.writer.max-padding | ||
* - parquet.enable.dictionary | ||
* - parquet.validation | ||
* - parquet.writer.version | ||
* ... | ||
*/ | ||
public static final String PARQUET_PROPERTIES = "format.parquet"; | ||
|
||
@Override | ||
public Map<String, String> requiredContext() { | ||
Map<String, String> context = new HashMap<>(); | ||
context.put(FORMAT, "parquet"); | ||
return context; | ||
} | ||
|
||
@Override | ||
public List<String> supportedProperties() { | ||
return Arrays.asList( | ||
UTC_TIMEZONE.key(), | ||
PARQUET_PROPERTIES + ".*" | ||
); | ||
} | ||
|
||
private static boolean isUtcTimestamp(DescriptorProperties properties) { | ||
return properties.getOptionalBoolean(UTC_TIMEZONE.key()) | ||
.orElse(UTC_TIMEZONE.defaultValue()); | ||
} | ||
|
||
private static Configuration getParquetConfiguration(DescriptorProperties properties) { | ||
Configuration conf = new Configuration(); | ||
properties.asMap().keySet() | ||
.stream() | ||
.filter(key -> key.startsWith(PARQUET_PROPERTIES)) | ||
.forEach(key -> { | ||
String value = properties.getString(key); | ||
String subKey = key.substring((FORMAT + '.').length()); | ||
conf.set(subKey, value); | ||
}); | ||
return conf; | ||
} | ||
|
||
@Override | ||
public InputFormat<BaseRow, ?> createReader(ReaderContext context) { | ||
DescriptorProperties properties = new DescriptorProperties(); | ||
properties.putProperties(context.getFormatProperties()); | ||
|
||
return new ParquetInputFormat( | ||
context.getPaths(), | ||
context.getSchema().getFieldNames(), | ||
context.getSchema().getFieldDataTypes(), | ||
context.getProjectFields(), | ||
context.getDefaultPartName(), | ||
context.getPushedDownLimit(), | ||
getParquetConfiguration(properties), | ||
isUtcTimestamp(properties)); | ||
} | ||
|
||
@Override | ||
public Optional<BulkWriter.Factory<BaseRow>> createBulkWriterFactory(WriterContext context) { | ||
DescriptorProperties properties = new DescriptorProperties(); | ||
properties.putProperties(context.getFormatProperties()); | ||
|
||
return Optional.of(ParquetRowDataBuilder.createWriterFactory( | ||
RowType.of(Arrays.stream(context.getFieldTypesWithoutPartKeys()) | ||
.map(DataType::getLogicalType) | ||
.toArray(LogicalType[]::new), | ||
context.getFieldNamesWithoutPartKeys()), | ||
getParquetConfiguration(properties), | ||
isUtcTimestamp(properties) | ||
)); | ||
} | ||
|
||
@Override | ||
public Optional<Encoder<BaseRow>> createEncoder(WriterContext context) { | ||
return Optional.empty(); | ||
} | ||
|
||
@Override | ||
public boolean supportsSchemaDerivation() { | ||
return true; | ||
} | ||
|
||
/** | ||
* An implementation of {@link ParquetInputFormat} to read {@link BaseRow} records | ||
* from Parquet files. | ||
*/ | ||
public static class ParquetInputFormat extends FileInputFormat<BaseRow> { | ||
|
||
private static final long serialVersionUID = 1L; | ||
|
||
private final String[] fullFieldNames; | ||
private final DataType[] fullFieldTypes; | ||
private final int[] selectedFields; | ||
private final String partDefaultName; | ||
private final boolean utcTimestamp; | ||
private final SerializableConfiguration conf; | ||
private final long limit; | ||
|
||
private transient ParquetColumnarRowSplitReader reader; | ||
private transient long currentReadCount; | ||
|
||
public ParquetInputFormat( | ||
Path[] paths, | ||
String[] fullFieldNames, | ||
DataType[] fullFieldTypes, | ||
int[] selectedFields, | ||
String partDefaultName, | ||
long limit, | ||
Configuration conf, | ||
boolean utcTimestamp) { | ||
super.setFilePaths(paths); | ||
this.limit = limit; | ||
this.partDefaultName = partDefaultName; | ||
this.fullFieldNames = fullFieldNames; | ||
this.fullFieldTypes = fullFieldTypes; | ||
this.selectedFields = selectedFields; | ||
this.conf = new SerializableConfiguration(conf); | ||
this.utcTimestamp = utcTimestamp; | ||
} | ||
|
||
@Override | ||
public void open(FileInputSplit fileSplit) throws IOException { | ||
// generate partition specs. | ||
List<String> fieldNameList = Arrays.asList(fullFieldNames); | ||
LinkedHashMap<String, String> partSpec = PartitionPathUtils.extractPartitionSpecFromPath( | ||
fileSplit.getPath()); | ||
LinkedHashMap<String, Object> partObjects = new LinkedHashMap<>(); | ||
partSpec.forEach((k, v) -> partObjects.put(k, restorePartValueFromType( | ||
partDefaultName.equals(v) ? null : v, | ||
fullFieldTypes[fieldNameList.indexOf(k)]))); | ||
|
||
this.reader = ParquetSplitReaderUtil.genPartColumnarRowReader( | ||
utcTimestamp, | ||
conf.conf(), | ||
fullFieldNames, | ||
fullFieldTypes, | ||
partObjects, | ||
selectedFields, | ||
DEFAULT_SIZE, | ||
new Path(fileSplit.getPath().toString()), | ||
fileSplit.getStart(), | ||
fileSplit.getLength()); | ||
this.currentReadCount = 0L; | ||
} | ||
|
||
@Override | ||
public boolean supportsMultiPaths() { | ||
return true; | ||
} | ||
|
||
@Override | ||
public boolean reachedEnd() throws IOException { | ||
if (currentReadCount >= limit) { | ||
return true; | ||
} else { | ||
return reader.reachedEnd(); | ||
} | ||
} | ||
|
||
@Override | ||
public BaseRow nextRecord(BaseRow reuse) { | ||
currentReadCount++; | ||
return reader.nextRecord(); | ||
} | ||
|
||
@Override | ||
public void close() throws IOException { | ||
if (reader != null) { | ||
this.reader.close(); | ||
} | ||
this.reader = null; | ||
} | ||
} | ||
} |
16 changes: 16 additions & 0 deletions
16
...arquet/src/main/resources/META-INF/services/org.apache.flink.table.factories.TableFactory
This file contains 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,16 @@ | ||
# 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. | ||
|
||
org.apache.flink.formats.parquet.ParquetFileSystemFormatFactory |
58 changes: 58 additions & 0 deletions
58
...flink-parquet/src/test/java/org/apache/flink/formats/parquet/ParquetFileSystemITCase.java
This file contains 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,58 @@ | ||
/* | ||
* 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.flink.formats.parquet; | ||
|
||
import org.apache.flink.table.planner.runtime.batch.sql.BatchFileSystemITCaseBase; | ||
|
||
import org.junit.runner.RunWith; | ||
import org.junit.runners.Parameterized; | ||
|
||
import java.util.ArrayList; | ||
import java.util.Arrays; | ||
import java.util.Collection; | ||
import java.util.List; | ||
|
||
/** | ||
* ITCase for {@link ParquetFileSystemFormatFactory}. | ||
*/ | ||
@RunWith(Parameterized.class) | ||
public class ParquetFileSystemITCase extends BatchFileSystemITCaseBase { | ||
|
||
private final boolean configure; | ||
|
||
@Parameterized.Parameters(name = "{0}") | ||
public static Collection<Boolean> parameters() { | ||
return Arrays.asList(false, true); | ||
} | ||
|
||
public ParquetFileSystemITCase(boolean configure) { | ||
this.configure = configure; | ||
} | ||
|
||
@Override | ||
public String[] formatProperties() { | ||
List<String> ret = new ArrayList<>(); | ||
ret.add("'format'='parquet'"); | ||
if (configure) { | ||
ret.add("'format.utc-timezone'='true'"); | ||
ret.add("'format.parquet.compression'='gzip'"); | ||
} | ||
return ret.toArray(new String[0]); | ||
} | ||
} |
This file contains 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.