This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/datafusion.git
The following commit(s) were added to refs/heads/main by this push:
new 46ac990878 Wire up with_new_state with DataSource (#20718)
46ac990878 is described below
commit 46ac990878d1fa5d528e6f94ff6beff04359724d
Author: Gabriel <[email protected]>
AuthorDate: Thu Mar 5 14:55:21 2026 +0100
Wire up with_new_state with DataSource (#20718)
## 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 #.
## Rationale for this change
<!--
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.
-->
`ExecutionPlan::with_new_state()` allows devs to inject custom
information in their nodes that they can use for tweaking their
`ExecutionPlan` implementations.
This mechanism does not work today if the `ExecutionPlan` is a
`DataSourceExec`, as this one does not implement the `with_new_state()`
method from `ExecutionPlan`.
In order to let people use this also for their own `DataSource`
implementations, this PR adds this method to it.
## What changes are included in this PR?
<!--
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.
-->
Propagates `with_new_state()` to the `DataSource` trait, so that custom
`DataSourceExec` can also benefit from it.
## Are these changes tested?
<!--
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)?
-->
As it's just method plumbing, my impression is that having a test for it
is overkill.
## Are there any user-facing changes?
Users can now implement their `with_new_state()` also in `DataSource`,
not only in `ExecutionPlan`
<!--
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.
-->
---
datafusion/datasource/src/source.rs | 28 ++++++++++++++++++++++++++++
1 file changed, 28 insertions(+)
diff --git a/datafusion/datasource/src/source.rs
b/datafusion/datasource/src/source.rs
index bdb45e8e3b..deea108139 100644
--- a/datafusion/datasource/src/source.rs
+++ b/datafusion/datasource/src/source.rs
@@ -228,6 +228,22 @@ pub trait DataSource: Send + Sync + Debug {
&self,
f: &mut dyn FnMut(&dyn PhysicalExpr) -> Result<TreeNodeRecursion>,
) -> Result<TreeNodeRecursion>;
+
+ /// Injects arbitrary run-time state into this DataSource, returning a new
instance
+ /// that incorporates that state *if* it is relevant to the concrete
DataSource implementation.
+ ///
+ /// This is a generic entry point: the `state` can be any type wrapped in
+ /// `Arc<dyn Any + Send + Sync>`. A data source that cares about the
state should
+ /// down-cast it to the concrete type it expects and, if successful,
return a
+ /// modified copy of itself that captures the provided value. If the
state is
+ /// not applicable, the default behaviour is to return `None` so that
parent
+ /// nodes can continue propagating the attempt further down the plan tree.
+ fn with_new_state(
+ &self,
+ _state: Arc<dyn Any + Send + Sync>,
+ ) -> Option<Arc<dyn DataSource>> {
+ None
+ }
}
/// [`ExecutionPlan`] that reads one or more files
@@ -432,6 +448,18 @@ impl ExecutionPlan for DataSourceExec {
as Arc<dyn ExecutionPlan>
})
}
+
+ fn with_new_state(
+ &self,
+ state: Arc<dyn Any + Send + Sync>,
+ ) -> Option<Arc<dyn ExecutionPlan>> {
+ self.data_source
+ .with_new_state(state)
+ .map(|new_data_source| {
+ Arc::new(self.clone().with_data_source(new_data_source))
+ as Arc<dyn ExecutionPlan>
+ })
+ }
}
impl DataSourceExec {
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
