Skip to content
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

[fix](tvf) Tvf supports to parse the enclose character in csv files #45407

Merged
merged 3 commits into from
Dec 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion be/src/vec/exec/format/csv/csv_reader.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -928,9 +928,13 @@ Status CsvReader::_prepare_parse(size_t* read_line, bool* is_parse_name) {
_trim_tailing_spaces, _trim_double_quotes, _value_separator,
_value_separator_length);
} else {
// If we pass `_file_slot_descs.size() - 1` to EncloseCsvTextFieldSplitter, it will cause BE core dump
// because currently _file_slot_descs is an empty vector.
// The _file_slot_descs.size() is only used to reserve space,
// so it's ok to pass 0 to EncloseCsvLineReaderContext
text_line_reader_ctx = std::make_shared<EncloseCsvLineReaderContext>(
_line_delimiter, _line_delimiter_length, _value_separator, _value_separator_length,
_file_slot_descs.size() - 1, _enclose, _escape, _keep_cr);
0, _enclose, _escape, _keep_cr);
_fields_splitter = std::make_unique<EncloseCsvTextFieldSplitter>(
_trim_tailing_spaces, false,
std::static_pointer_cast<EncloseCsvLineReaderContext>(text_line_reader_ctx),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ public class FileFormatConstants {
public static final String PROP_COMPRESS = "compress";
public static final String PROP_COMPRESS_TYPE = "compress_type";
public static final String PROP_PATH_PARTITION_KEYS = "path_partition_keys";
public static final String PROP_ENCLOSE = "enclose";

// decimal(p,s)
public static final Pattern DECIMAL_TYPE_PATTERN = Pattern.compile("decimal\\((\\d+),(\\d+)\\)");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ public abstract class ExternalFileTableValuedFunction extends TableValuedFunctio
private TTextSerdeType textSerdeType = TTextSerdeType.JSON_TEXT_SERDE;
private String columnSeparator = FileFormatConstants.DEFAULT_COLUMN_SEPARATOR;
private String lineDelimiter = FileFormatConstants.DEFAULT_LINE_DELIMITER;
private byte enclose = 0;
private String jsonRoot = "";
private String jsonPaths = "";
private boolean stripOuterArray;
Expand Down Expand Up @@ -231,6 +232,17 @@ protected Map<String, String> parseCommonProperties(Map<String, String> properti
}
lineDelimiter = Separator.convertSeparator(lineDelimiter);

String enclosedString = getOrDefaultAndRemove(copiedProps, FileFormatConstants.PROP_ENCLOSE, "");
if (!Strings.isNullOrEmpty(enclosedString)) {
if (enclosedString.length() > 1) {
throw new AnalysisException("enclose should not be longer than one byte.");
}
enclose = (byte) enclosedString.charAt(0);
if (enclose == 0) {
throw new AnalysisException("enclose should not be byte [0].");
}
}

jsonRoot = getOrDefaultAndRemove(copiedProps, FileFormatConstants.PROP_JSON_ROOT, "");
jsonPaths = getOrDefaultAndRemove(copiedProps, FileFormatConstants.PROP_JSON_PATHS, "");
readJsonByLine = Boolean.valueOf(
Expand Down Expand Up @@ -285,6 +297,9 @@ public TFileAttributes getFileAttributes() {
TFileTextScanRangeParams fileTextScanRangeParams = new TFileTextScanRangeParams();
fileTextScanRangeParams.setColumnSeparator(this.columnSeparator);
fileTextScanRangeParams.setLineDelimiter(this.lineDelimiter);
if (enclose != 0) {
fileTextScanRangeParams.setEnclose(enclose);
}
fileAttributes.setTextParams(fileTextScanRangeParams);
if (this.fileFormatType == TFileFormatType.FORMAT_CSV_PLAIN) {
fileAttributes.setHeaderType(this.headerType);
Expand Down
6 changes: 6 additions & 0 deletions regression-test/data/external_table_p0/tvf/enclose_csv.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
id, field1, field2
"1", "hello", "same, field"
"2", "doris", "same, field2"
"3", "nereids", "same, field3"
"4", "pipeline", "same, field4"
"5", "storage", "same, field5"
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
-- This file is automatically generated. You should know what you did if you want to edit this
-- !enclose_1 --
"1" "hello" "same, field"
"2" "doris" "same, field2"
"3" "nereids" "same, field3"
"4" "pipeline" "same, field4"
"5" "storage" "same, field5"

-- !enclose_2 --
1 hello same, field
2 doris same, field2
3 nereids same, field3
4 pipeline same, field4
5 storage same, field5

Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
import org.junit.Assert

// 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.

suite("test_local_tvf_enclose", "p0,tvf") {
List<List<Object>> backends = sql """ show backends """
assertTrue(backends.size() > 0)
def be_id = backends[0][0]

String filename = "enclose_csv.csv"

def dataFilePath = context.config.dataPath + "/external_table_p0/tvf/${filename}"

def outFilePath="/"

for (List<Object> backend : backends) {
def be_host = backend[1]
scpFiles ("root", be_host, dataFilePath, outFilePath, false);
}


sql """set enable_nereids_planner=true"""
sql """set enable_fallback_to_original_planner=false"""

qt_enclose_1 """
select * from local(
"file_path" = "${filename}",
"backend_id" = "${be_id}",
"format" = "csv_with_names",
"column_separator" = ", ",
"enclose" = "\\\"") order by id;
"""

qt_enclose_2 """
select * from local(
"file_path" = "${filename}",
"backend_id" = "${be_id}",
"format" = "csv_with_names",
"column_separator" = ", ",
"enclose" = "\\\"",
"trim_double_quotes" = "true") order by id;
"""

// test error case
test {
sql """
select * from local(
"file_path" = "${filename}",
"backend_id" = "${be_id}",
"format" = "csv_with_names",
"column_separator" = ", ",
"enclose" = "\\\"\\\"") order by id;
"""
// check exception message contains
exception "enclose should not be longer than one byte."
}
}
Loading