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

Web console: adding format notice for CSV and TSV #14783

Merged
merged 5 commits into from
Aug 15, 2023

Conversation

vogievetsky
Copy link
Contributor

Adds a warning that the CSV or TSV sample contains newlines in values which is allowed in the format but Druid will not accept it in the expected way. Adding this because I got really tripped up by this myself.

image

Try it with:

"a","b","c","d","e"
"hello
world",2,3,4,5

Feedback on copy very welcome.

Also changed the links from http://ndjson.org/ to https://jsonlines.org (due to ndjson/ndjson-spec#35 (comment))

if (firstLine === '{') {
return (
<>
This data looks like multi-line formatted JSON object. For Druid to parse a text file it
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This data looks like multi-line formatted JSON object. For Druid to parse a text file it
This data looks like a multi-line formatted JSON object. For Druid to parse a text file it

const formatLabel = format.type.toUpperCase();
return (
<>
{`This ${formatLabel} data has values that contain new lines. Druid requires ${formatLabel} files to have one event per line and thus ${formatLabel} values can not contain new lines. Consider encoding new lines in the values of your ${formatLabel} with some special delimiter.`}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{`This ${formatLabel} data has values that contain new lines. Druid requires ${formatLabel} files to have one event per line and thus ${formatLabel} values can not contain new lines. Consider encoding new lines in the values of your ${formatLabel} with some special delimiter.`}
{`This ${formatLabel} data has values that contain new lines. Druid requires ${formatLabel} files to have one event per line, so ${formatLabel} values cannot contain new lines. Consider encoding new lines in the values of your ${formatLabel} with some special delimiter.`}

Copy link
Contributor

@ektravel ektravel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed the copy.

@vogievetsky vogievetsky merged commit 0b2563f into apache:master Aug 15, 2023
@vogievetsky vogievetsky deleted the format_fixes branch August 15, 2023 22:35
@LakshSingla LakshSingla added this to the 28.0 milestone Oct 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants