Skip to content

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

Merged
vogievetsky merged 5 commits into
apache:masterfrom
vogievetsky:format_fixes
Aug 15, 2023
Merged

vogievetsky merged 5 commits into
apache:masterfrom
vogievetsky:format_fixes

Conversation

@vogievetsky

Copy link
Copy Markdown
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))

Comment thread web-console/src/druid-models/ingestion-spec/ingestion-spec.tsx Outdated
Comment thread web-console/src/druid-models/ingestion-spec/ingestion-spec.tsx Outdated
Comment thread web-console/src/druid-models/ingestion-spec/ingestion-spec.tsx Outdated
if (firstLine === '{') {
return (
<>
This data looks like multi-line formatted JSON object. For Druid to parse a text file it

Copy link
Copy Markdown
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
Copy Markdown
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.`}

@ektravel ektravel left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Reviewed the copy.

vogievetsky and others added 4 commits August 8, 2023 16:23
Co-authored-by: 317brian <53799971+317brian@users.noreply.github.com>
Co-authored-by: 317brian <53799971+317brian@users.noreply.github.com>
Co-authored-by: 317brian <53799971+317brian@users.noreply.github.com>
@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
riovic918data pushed a commit to riovic918data/druid that referenced this pull request Jun 12, 2026
* adding format notice for CSV and TSV

* Update web-console/src/druid-models/ingestion-spec/ingestion-spec.tsx

Co-authored-by: 317brian <53799971+317brian@users.noreply.github.com>

* Update web-console/src/druid-models/ingestion-spec/ingestion-spec.tsx

Co-authored-by: 317brian <53799971+317brian@users.noreply.github.com>

* Update web-console/src/druid-models/ingestion-spec/ingestion-spec.tsx

Co-authored-by: 317brian <53799971+317brian@users.noreply.github.com>

* fix tests

---------

Co-authored-by: 317brian <53799971+317brian@users.noreply.github.com>
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