Skip to content

Improve deprecation message for MemoryExec #14322

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
Jan 28, 2025
Merged

Improve deprecation message for MemoryExec #14322

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3bba784
Improve deprecation message for `MemoryExec`
alamb Jan 27, 2025
08a5ccc
clippy
alamb Jan 27, 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
16 changes: 15 additions & 1 deletion datafusion/physical-plan/src/values.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,16 @@ use datafusion_execution::TaskContext;
use datafusion_physical_expr::EquivalenceProperties;

/// Execution plan for values list based relation (produces constant rows)
#[deprecated(since = "45.0.0", note = "Use `MemoryExec::try_new_as_values` instead")]
///
/// Note this structure is the same as [`MemoryExec`] and is deprecated.
/// Please see the following for alternatives
/// * [`MemoryExec::try_new`]
/// * [`MemoryExec::try_new_from_batches`]
///
/// [`MemoryExec`]: crate::memory::MemoryExec
/// [`MemoryExec::try_new`]: crate::memory::MemoryExec::try_new
/// [`MemoryExec::try_new_from_batches`]: crate::memory::MemoryExec::try_new_from_batches
#[deprecated(since = "45.0.0", note = "Use `MemoryExec` instead")]
#[derive(Debug, Clone)]
pub struct ValuesExec {
/// The schema
Expand All @@ -48,6 +57,7 @@ pub struct ValuesExec {
#[allow(deprecated)]
impl ValuesExec {
/// Create a new values exec from data as expr
#[deprecated(since = "45.0.0", note = "Use `MemoryExec::try_new` instead")]
pub fn try_new(
schema: SchemaRef,
data: Vec<Vec<Arc<dyn PhysicalExpr>>>,
Expand Down Expand Up @@ -101,6 +111,10 @@ impl ValuesExec {
///
/// Errors if any of the batches don't match the provided schema, or if no
/// batches are provided.
#[deprecated(
since = "45.0.0",
note = "Use `MemoryExec::try_new_from_batches` instead"
)]
pub fn try_new_from_batches(
schema: SchemaRef,
batches: Vec<RecordBatch>,
Expand Down
Loading