Skip to content

Implement tree explain for CsvSink #15204

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Mar 13, 2025
Merged

Implement tree explain for CsvSink #15204

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 4 additions & 2 deletions datafusion/datasource-csv/src/file_format.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -666,8 +666,10 @@ impl DisplayAs for CsvSink {
write!(f, ")")
}
DisplayFormatType::TreeRender => {
// TODO: collect info
write!(f, "")
if !self.config.file_groups.is_empty() {
Copy link
Contributor

Choose a reason for hiding this comment

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

I debugged a bit more and it seems the issue is that the actual filename target is in self.config.table_path rather than self.config_file_groups

However, this way is consisent with the other data sinks

@irenjj is there any chance you can make a ticket / PR to fix this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I will fix this issue together in #15112.

FileGroupDisplay(&self.config.file_groups).fmt_as(t, f)?;
}
Ok(())
}
}
}
Expand Down
16 changes: 16 additions & 0 deletions datafusion/sqllogictest/test_files/explain_tree.slt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1725,6 +1725,22 @@ physical_plan
09)│ rows: 1 │
10)└───────────────────────────┘

query TT
explain COPY (VALUES (1, 'foo', 1, '2023-01-01'), (2, 'bar', 2, '2023-01-02'), (3, 'baz', 3, '2023-01-03'))
TO 'test_files/scratch/explain_tree/2.csv';
----
physical_plan
01)┌───────────────────────────┐
02)│ DataSinkExec │
Copy link
Contributor

Choose a reason for hiding this comment

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

It is interesting that the format is not shown in this plan 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's triggered by DataSinkExec:
DisplayFormatType::TreeRender => self.sink().fmt_as(t, f)
CsvSink is only a part of the DataSinkExec format.
A more reasonable output format might be:

 DataSinkExec
---------------
   sink=csv

   filegroup...

Copy link
Contributor

Choose a reason for hiding this comment

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

I agree -- can you make a follow on PR for this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I created a new PR #15206, and I found that the actual type of the sink can be determined from the file extension.

03)└─────────────┬─────────────┘
04)┌─────────────┴─────────────┐
05)│ DataSourceExec │
06)│ -------------------- │
07)│ bytes: 2672 │
08)│ format: memory │
09)│ rows: 1 │
10)└───────────────────────────┘

# Test explain tree rendering for CoalesceBatchesExec with limit
statement ok
CREATE TABLE IF NOT EXISTS t1 (a INT) AS VALUES(1),(2),(3),(4),(5),(6),(7),(8),(9),(10);
Expand Down