Skip to content

feat: make DataFrame::create_physical_plan take &self instead of self#20562

Merged
alamb merged 4 commits intoapache:mainfrom
xanderbailey:claude/physical-plan-without-consume-Z0dJp
Apr 6, 2026
Merged

feat: make DataFrame::create_physical_plan take &self instead of self#20562
alamb merged 4 commits intoapache:mainfrom
xanderbailey:claude/physical-plan-without-consume-Z0dJp

Conversation

@xanderbailey
Copy link
Copy Markdown
Contributor

Which issue does this PR close?

Rationale for this change

Previously create_physical_plan consumed the DataFrame, making it impossible to inspect (e.g. log) the physical plan and then execute the same DataFrame (e.g. via write_parquet or collect) without first cloning it.

Since the method only needs &LogicalPlan (which it forwards to SessionState::create_physical_plan), there is no reason to take ownership. Changing the signature to &self makes the common pattern of "get plan for logging, then write/collect" work naturally.

Also removes the now-unnecessary self.clone() in DataFrame::cache that was introduced for the same reason.

What changes are included in this PR?

Changing self to &self

Are these changes tested?

Yes

Are there any user-facing changes?

Previously `create_physical_plan` consumed the `DataFrame`, making it
impossible to inspect (e.g. log) the physical plan and then execute the
same `DataFrame` (e.g. via `write_parquet` or `collect`) without first
cloning it.

Since the method only needs `&LogicalPlan` (which it forwards to
`SessionState::create_physical_plan`), there is no reason to take
ownership. Changing the signature to `&self` makes the common pattern
of "get plan for logging, then write/collect" work naturally.

Also removes the now-unnecessary `self.clone()` in `DataFrame::cache`
that was introduced for the same reason.

https://claude.ai/code/session_01F2BMik1KryMgRGUi9tTRSs
@github-actions github-actions Bot added the core Core DataFusion crate label Feb 25, 2026
@xanderbailey xanderbailey force-pushed the claude/physical-plan-without-consume-Z0dJp branch from eb049e1 to 05fcdf5 Compare February 25, 2026 23:51
Copy link
Copy Markdown
Contributor

@neilconway neilconway left a comment

Choose a reason for hiding this comment

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

lgtm. Does this constitute an API change?

Looks like a few more clones we can cleanup:

  • datafusion/core/tests/fuzz_cases/aggregate_fuzz.rs:564
  • datafusion/core/tests/physical_optimizer/aggregate_statistics.rs:380
  • datafusion/core/tests/dataframe/mod.rs:101-102

@xanderbailey
Copy link
Copy Markdown
Contributor Author

xanderbailey commented Feb 26, 2026

Hmm, I think maybe technically yes, df.create_physical_plan is fine because rust will auto ref this. I think

Dataframe::create_physical_plan(df)

is a break though...

@neilconway
Copy link
Copy Markdown
Contributor

@alamb This PR looks reasonable to me.

Copy link
Copy Markdown
Contributor

@alamb alamb left a comment

Choose a reason for hiding this comment

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

@alamb This PR looks reasonable to me.

I agree -- thanks @neilconway

THanks for this PR @xanderbailey -- it looks like an improvement to me

@alamb alamb added this pull request to the merge queue Apr 6, 2026
Merged via the queue into apache:main with commit b3b721f Apr 6, 2026
31 checks passed
Dandandan pushed a commit to Dandandan/arrow-datafusion that referenced this pull request Apr 8, 2026
…apache#20562)

## Which issue does this PR close?

<!--
We generally require a GitHub issue to be filed for all bug fixes and
enhancements and this helps us generate change logs for our releases.
You can link an issue to this PR using the GitHub syntax. For example
`Closes #123` indicates that this PR will close issue #123.
-->

- Closes apache#20561

## Rationale for this change

Previously `create_physical_plan` consumed the `DataFrame`, making it
impossible to inspect (e.g. log) the physical plan and then execute the
same `DataFrame` (e.g. via `write_parquet` or `collect`) without first
cloning it.

Since the method only needs `&LogicalPlan` (which it forwards to
`SessionState::create_physical_plan`), there is no reason to take
ownership. Changing the signature to `&self` makes the common pattern of
"get plan for logging, then write/collect" work naturally.


Also removes the now-unnecessary `self.clone()` in `DataFrame::cache`
that was introduced for the same reason.


<!--
Why are you proposing this change? If this is already explained clearly
in the issue then this section is not needed.
Explaining clearly why changes are proposed helps reviewers understand
your changes and offer better suggestions for fixes.
-->

## What changes are included in this PR?
Changing `self` to `&self`
<!--
There is no need to duplicate the description in the issue here but it
is sometimes worth providing a summary of the individual changes in this
PR.
-->

## Are these changes tested?
Yes
<!--
We typically require tests for all PRs in order to:
1. Prevent the code from being accidentally broken by subsequent changes
2. Serve as another way to document the expected behavior of the code

If tests are not included in your PR, please explain why (for example,
are they covered by existing tests)?
-->

## Are there any user-facing changes?

<!--
If there are user-facing changes then we may require documentation to be
updated before approving the PR.
-->

<!--
If there are any breaking changes to public APIs, please add the `api
change` label.
-->

---------

Co-authored-by: xanderbailey <xanderbailey@users.noreply.github.com>
Rich-T-kid pushed a commit to Rich-T-kid/datafusion that referenced this pull request Apr 21, 2026
…apache#20562)

## Which issue does this PR close?

<!--
We generally require a GitHub issue to be filed for all bug fixes and
enhancements and this helps us generate change logs for our releases.
You can link an issue to this PR using the GitHub syntax. For example
`Closes apache#123` indicates that this PR will close issue apache#123.
-->

- Closes apache#20561

## Rationale for this change

Previously `create_physical_plan` consumed the `DataFrame`, making it
impossible to inspect (e.g. log) the physical plan and then execute the
same `DataFrame` (e.g. via `write_parquet` or `collect`) without first
cloning it.

Since the method only needs `&LogicalPlan` (which it forwards to
`SessionState::create_physical_plan`), there is no reason to take
ownership. Changing the signature to `&self` makes the common pattern of
"get plan for logging, then write/collect" work naturally.


Also removes the now-unnecessary `self.clone()` in `DataFrame::cache`
that was introduced for the same reason.


<!--
Why are you proposing this change? If this is already explained clearly
in the issue then this section is not needed.
Explaining clearly why changes are proposed helps reviewers understand
your changes and offer better suggestions for fixes.
-->

## What changes are included in this PR?
Changing `self` to `&self`
<!--
There is no need to duplicate the description in the issue here but it
is sometimes worth providing a summary of the individual changes in this
PR.
-->

## Are these changes tested?
Yes
<!--
We typically require tests for all PRs in order to:
1. Prevent the code from being accidentally broken by subsequent changes
2. Serve as another way to document the expected behavior of the code

If tests are not included in your PR, please explain why (for example,
are they covered by existing tests)?
-->

## Are there any user-facing changes?

<!--
If there are user-facing changes then we may require documentation to be
updated before approving the PR.
-->

<!--
If there are any breaking changes to public APIs, please add the `api
change` label.
-->

---------

Co-authored-by: xanderbailey <xanderbailey@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core Core DataFusion crate

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Asking for a physical plan should not consume the dataframe

3 participants