[FLINK-17604] Implement format factory for CSV serialization and #12065
There are no files selected for viewing
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
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,251 @@ | ||
| /* | ||
| * 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.csv; | ||
|
|
||
| import org.apache.flink.api.common.serialization.DeserializationSchema; | ||
| import org.apache.flink.api.common.serialization.SerializationSchema; | ||
| import org.apache.flink.api.common.typeinfo.TypeInformation; | ||
| import org.apache.flink.configuration.ConfigOption; | ||
| import org.apache.flink.configuration.ReadableConfig; | ||
| import org.apache.flink.table.api.ValidationException; | ||
| import org.apache.flink.table.connector.ChangelogMode; | ||
| import org.apache.flink.table.connector.format.ScanFormat; | ||
| import org.apache.flink.table.connector.format.SinkFormat; | ||
| import org.apache.flink.table.connector.sink.DynamicTableSink; | ||
| import org.apache.flink.table.connector.source.ScanTableSource; | ||
| import org.apache.flink.table.data.RowData; | ||
| import org.apache.flink.table.factories.DeserializationFormatFactory; | ||
| import org.apache.flink.table.factories.DynamicTableFactory; | ||
| import org.apache.flink.table.factories.FactoryUtil; | ||
| import org.apache.flink.table.factories.SerializationFormatFactory; | ||
| import org.apache.flink.table.types.DataType; | ||
| import org.apache.flink.table.types.logical.RowType; | ||
|
|
||
| import java.util.Arrays; | ||
| import java.util.Collections; | ||
| import java.util.HashSet; | ||
| import java.util.Set; | ||
|
|
||
| import static org.apache.flink.formats.csv.CsvOptions.ALLOW_COMMENTS; | ||
| import static org.apache.flink.formats.csv.CsvOptions.ARRAY_ELEMENT_DELIMITER; | ||
| import static org.apache.flink.formats.csv.CsvOptions.DISABLE_QUOTE_CHARACTER; | ||
| import static org.apache.flink.formats.csv.CsvOptions.ESCAPE_CHARACTER; | ||
| import static org.apache.flink.formats.csv.CsvOptions.FIELD_DELIMITER; | ||
| import static org.apache.flink.formats.csv.CsvOptions.IGNORE_PARSE_ERRORS; | ||
| import static org.apache.flink.formats.csv.CsvOptions.LINE_DELIMITER; | ||
| import static org.apache.flink.formats.csv.CsvOptions.NULL_LITERAL; | ||
| import static org.apache.flink.formats.csv.CsvOptions.QUOTE_CHARACTER; | ||
|
|
||
| /** | ||
| * Format factory for providing configured instances of CSV to RowData {@link SerializationSchema} | ||
| * and {@link DeserializationSchema}. | ||
| */ | ||
| public final class CsvFormatFactory implements | ||
| DeserializationFormatFactory, | ||
| SerializationFormatFactory { | ||
|
|
||
| public static final String IDENTIFIER = "csv"; | ||
|
|
||
| @SuppressWarnings("unchecked") | ||
| @Override | ||
| public ScanFormat<DeserializationSchema<RowData>> createScanFormat( | ||
| DynamicTableFactory.Context context, ReadableConfig formatOptions) { | ||
| FactoryUtil.validateFactoryOptions(this, formatOptions); | ||
| validateFormatOptions(formatOptions); | ||
|
|
||
| return new ScanFormat<DeserializationSchema<RowData>>() { | ||
| @Override | ||
| public DeserializationSchema<RowData> createScanFormat( | ||
| ScanTableSource.Context scanContext, | ||
| DataType producedDataType) { | ||
| final RowType rowType = (RowType) producedDataType.getLogicalType(); | ||
| final TypeInformation<RowData> rowDataTypeInfo = | ||
| (TypeInformation<RowData>) scanContext.createTypeInformation(producedDataType); | ||
| final CsvRowDataDeserializationSchema.Builder schemaBuilder = | ||
| new CsvRowDataDeserializationSchema.Builder( | ||
| rowType, | ||
| rowDataTypeInfo); | ||
| configureDeserializationSchema(formatOptions, schemaBuilder); | ||
| return schemaBuilder.build(); | ||
| } | ||
|
|
||
| @Override | ||
| public ChangelogMode getChangelogMode() { | ||
| return ChangelogMode.insertOnly(); | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| @Override | ||
| public SinkFormat<SerializationSchema<RowData>> createSinkFormat( | ||
| DynamicTableFactory.Context context, | ||
| ReadableConfig formatOptions) { | ||
| FactoryUtil.validateFactoryOptions(this, formatOptions); | ||
| validateFormatOptions(formatOptions); | ||
|
|
||
| return new SinkFormat<SerializationSchema<RowData>>() { | ||
|
|
||
| @Override | ||
| public SerializationSchema<RowData> createSinkFormat( | ||
| DynamicTableSink.Context context, | ||
| DataType consumedDataType) { | ||
| final RowType rowType = (RowType) consumedDataType.getLogicalType(); | ||
| final CsvRowDataSerializationSchema.Builder schemaBuilder = | ||
| new CsvRowDataSerializationSchema.Builder(rowType); | ||
| configureSerializationSchema(formatOptions, schemaBuilder); | ||
| return schemaBuilder.build(); | ||
| } | ||
|
|
||
| @Override | ||
| public ChangelogMode getChangelogMode() { | ||
| return ChangelogMode.insertOnly(); | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| @Override | ||
| public String factoryIdentifier() { | ||
| return IDENTIFIER; | ||
| } | ||
|
|
||
| @Override | ||
| public Set<ConfigOption<?>> requiredOptions() { | ||
| return Collections.emptySet(); | ||
| } | ||
|
|
||
| @Override | ||
| public Set<ConfigOption<?>> optionalOptions() { | ||
| Set<ConfigOption<?>> options = new HashSet<>(); | ||
| options.add(FIELD_DELIMITER); | ||
| options.add(LINE_DELIMITER); | ||
| options.add(DISABLE_QUOTE_CHARACTER); | ||
| options.add(QUOTE_CHARACTER); | ||
| options.add(ALLOW_COMMENTS); | ||
| options.add(IGNORE_PARSE_ERRORS); | ||
| options.add(ARRAY_ELEMENT_DELIMITER); | ||
| options.add(ESCAPE_CHARACTER); | ||
| options.add(NULL_LITERAL); | ||
| return options; | ||
| } | ||
|
|
||
| // ------------------------------------------------------------------------ | ||
| // Validation | ||
| // ------------------------------------------------------------------------ | ||
|
|
||
| private static void validateFormatOptions(ReadableConfig tableOptions) { | ||
|
Member
There was a problem hiding this comment. We should also check |
||
| final boolean hasQuoteCharacter = tableOptions.getOptional(QUOTE_CHARACTER).isPresent(); | ||
| final boolean isDisabledQuoteCharacter = tableOptions.get(DISABLE_QUOTE_CHARACTER); | ||
| if (isDisabledQuoteCharacter && hasQuoteCharacter){ | ||
| throw new ValidationException( | ||
| "Format cannot define a quote character and disabled quote character at the same time."); | ||
| } | ||
| // Validate the option value must be a single char. | ||
| validateCharacterVal(tableOptions, FIELD_DELIMITER); | ||
| validateCharacterVal(tableOptions, ARRAY_ELEMENT_DELIMITER); | ||
| validateCharacterVal(tableOptions, QUOTE_CHARACTER); | ||
| validateCharacterVal(tableOptions, ESCAPE_CHARACTER); | ||
|
Member
There was a problem hiding this comment.
|
||
|
|
||
| tableOptions.getOptional(LINE_DELIMITER).ifPresent(delimiter -> { | ||
| Set<String> allowedValues = new HashSet<>(Arrays.asList("\r", "\n", "\r\n", "")); | ||
| if (!allowedValues.contains(delimiter)) { | ||
| throw new ValidationException( | ||
| String.format("Invalid value for option '%s.%s'. Supported values are %s, but was: %s", | ||
| IDENTIFIER, | ||
| LINE_DELIMITER.key(), | ||
| "[\\r, \\n, \\r\\n, \"\"]", | ||
| delimiter)); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| /** Validates the option {@code option} value must be a Character. */ | ||
| private static void validateCharacterVal( | ||
| ReadableConfig tableOptions, | ||
| ConfigOption<String> option) { | ||
| if (tableOptions.getOptional(option).isPresent()) { | ||
| if (tableOptions.get(option).length() != 1) { | ||
| throw new ValidationException( | ||
| String.format("Option '%s.%s' must be a string with single character, but was: %s", | ||
| IDENTIFIER, | ||
| option.key(), | ||
| tableOptions.get(option))); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // ------------------------------------------------------------------------ | ||
| // Utilities | ||
| // ------------------------------------------------------------------------ | ||
|
|
||
| private static void configureDeserializationSchema( | ||
| ReadableConfig formatOptions, | ||
| CsvRowDataDeserializationSchema.Builder schemaBuilder) { | ||
| formatOptions.getOptional(FIELD_DELIMITER) | ||
| .map(delimiter -> delimiter.charAt(0)) | ||
| .ifPresent(schemaBuilder::setFieldDelimiter); | ||
|
|
||
| formatOptions.getOptional(QUOTE_CHARACTER) | ||
| .map(quote -> quote.charAt(0)) | ||
| .ifPresent(schemaBuilder::setQuoteCharacter); | ||
|
|
||
| formatOptions.getOptional(ALLOW_COMMENTS) | ||
| .ifPresent(schemaBuilder::setAllowComments); | ||
|
|
||
| formatOptions.getOptional(IGNORE_PARSE_ERRORS) | ||
| .ifPresent(schemaBuilder::setIgnoreParseErrors); | ||
|
|
||
| formatOptions.getOptional(ARRAY_ELEMENT_DELIMITER) | ||
| .ifPresent(schemaBuilder::setArrayElementDelimiter); | ||
|
|
||
| formatOptions.getOptional(ESCAPE_CHARACTER) | ||
| .map(escape -> escape.charAt(0)) | ||
| .ifPresent(schemaBuilder::setEscapeCharacter); | ||
|
|
||
| formatOptions.getOptional(NULL_LITERAL) | ||
| .ifPresent(schemaBuilder::setNullLiteral); | ||
| } | ||
|
|
||
| private static void configureSerializationSchema( | ||
| ReadableConfig formatOptions, | ||
| CsvRowDataSerializationSchema.Builder schemaBuilder) { | ||
| formatOptions.getOptional(FIELD_DELIMITER) | ||
| .map(delimiter -> delimiter.charAt(0)) | ||
| .ifPresent(schemaBuilder::setFieldDelimiter); | ||
|
|
||
| formatOptions.getOptional(LINE_DELIMITER) | ||
| .ifPresent(schemaBuilder::setLineDelimiter); | ||
|
|
||
| if (formatOptions.get(DISABLE_QUOTE_CHARACTER)) { | ||
| schemaBuilder.disableQuoteCharacter(); | ||
| } else { | ||
| formatOptions.getOptional(QUOTE_CHARACTER) | ||
| .map(quote -> quote.charAt(0)) | ||
| .ifPresent(schemaBuilder::setQuoteCharacter); | ||
| } | ||
|
|
||
| formatOptions.getOptional(ARRAY_ELEMENT_DELIMITER) | ||
| .ifPresent(schemaBuilder::setArrayElementDelimiter); | ||
|
|
||
| formatOptions.getOptional(ESCAPE_CHARACTER) | ||
| .map(escape -> escape.charAt(0)) | ||
| .ifPresent(schemaBuilder::setEscapeCharacter); | ||
|
|
||
| formatOptions.getOptional(NULL_LITERAL) | ||
| .ifPresent(schemaBuilder::setNullLiteral); | ||
| } | ||
| } | ||
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,95 @@ | ||
| /* | ||
| * 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.csv; | ||
|
|
||
| import org.apache.flink.configuration.ConfigOption; | ||
| import org.apache.flink.configuration.ConfigOptions; | ||
|
|
||
| /** Options for CSV format. */ | ||
| public class CsvOptions { | ||
| private CsvOptions() {} | ||
|
|
||
| // ------------------------------------------------------------------------ | ||
| // Options | ||
| // ------------------------------------------------------------------------ | ||
|
|
||
| public static final ConfigOption<String> FIELD_DELIMITER = ConfigOptions | ||
| .key("field-delimiter") | ||
| .stringType() | ||
| .defaultValue(",") | ||
| .withDescription("Optional field delimiter character (',' by default)"); | ||
|
|
||
| public static final ConfigOption<String> LINE_DELIMITER = ConfigOptions | ||
| .key("line-delimiter") | ||
| .stringType() | ||
| .defaultValue("\n") | ||
| .withDescription("Optional line delimiter (\"\\n\" by default, otherwise\n" | ||
| + "\"\\r\" or \"\\r\\n\" are allowed), unicode is supported if\n" | ||
| + "the delimiter is an invisible special character,\n" | ||
| + "e.g. U&'\\000D' is the unicode representation of carriage return \"\\r\"" | ||
| + "e.g. U&'\\000A' is the unicode representation of line feed \"\\n\""); | ||
|
|
||
| public static final ConfigOption<Boolean> DISABLE_QUOTE_CHARACTER = ConfigOptions | ||
| .key("disable-quote-character") | ||
| .booleanType() | ||
| .defaultValue(false) | ||
| .withDescription("Optional flag to disabled quote character for enclosing field values (false by default)\n" | ||
| + "if true, quote-character can not be set"); | ||
|
|
||
| public static final ConfigOption<String> QUOTE_CHARACTER = ConfigOptions | ||
| .key("quote-character") | ||
| .stringType() | ||
| .defaultValue("\"") | ||
| .withDescription("Optional quote character for enclosing field values ('\"' by default)"); | ||
|
|
||
| public static final ConfigOption<Boolean> ALLOW_COMMENTS = ConfigOptions | ||
| .key("allow-comments") | ||
| .booleanType() | ||
| .defaultValue(false) | ||
| .withDescription("Optional flag to ignore comment lines that start with \"#\"\n" | ||
| + "(disabled by default);\n" | ||
| + "if enabled, make sure to also ignore parse errors to allow empty rows"); | ||
|
|
||
| public static final ConfigOption<Boolean> IGNORE_PARSE_ERRORS = ConfigOptions | ||
| .key("ignore-parse-errors") | ||
| .booleanType() | ||
| .defaultValue(false) | ||
| .withDescription("Optional flag to skip fields and rows with parse errors instead of failing;\n" | ||
| + "fields are set to null in case of errors"); | ||
|
|
||
| public static final ConfigOption<String> ARRAY_ELEMENT_DELIMITER = ConfigOptions | ||
| .key("array-element-delimiter") | ||
| .stringType() | ||
| .defaultValue(";") | ||
| .withDescription("Optional array element delimiter string for separating\n" | ||
| + "array and row element values (\";\" by default)"); | ||
|
|
||
| public static final ConfigOption<String> ESCAPE_CHARACTER = ConfigOptions | ||
| .key("escape-character") | ||
| .stringType() | ||
| .noDefaultValue() | ||
| .withDescription("Optional escape character for escaping values (disabled by default)"); | ||
|
|
||
| public static final ConfigOption<String> NULL_LITERAL = ConfigOptions | ||
| .key("null-literal") | ||
| .stringType() | ||
| .noDefaultValue() | ||
| .withDescription("Optional null literal string that is interpreted as a\n" | ||
| + "null value (disabled by default)"); | ||
| } |
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,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.csv.CsvFormatFactory |
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.
Call
FactoryUtil.validateFactoryOptions(this, formatOptions);at the beginning. It will checks all the options.Please also add a test for verify invalid "csv.ignore-parse-errors" = "abc" option.
Uh oh!
There was an error while loading. Please reload this page.
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.
Added to FactoryUtil.
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.
Added in the factory instead.