Skip to content

Improve comments for DataSinkExec #17873

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 2 commits into from
Oct 2, 2025
Merged

Improve comments for DataSinkExec #17873

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ba67e55
Add notes for DataSinkExec
xudong963 Oct 2, 2025
c6c7385
Merge branch 'main' into doc_for_data_sink_doc
xudong963 Oct 2, 2025
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
5 changes: 5 additions & 0 deletions datafusion/datasource/src/sink.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,11 @@ impl Debug for DataSinkExec {

impl DataSinkExec {
/// Create a plan to write to `sink`
/// Note: DataSinkExec requires its input to have a single partition.
/// If the input has multiple partitions, the physical optimizer will
/// automatically insert a Merge-related operator to merge them.
/// If you construct PhysicalPlan without going through the physical optimizer,
/// you must ensure that the input has a single partition.
pub fn new(
input: Arc<dyn ExecutionPlan>,
sink: Arc<dyn DataSink>,
Expand Down