Skip to content

Commit 8d542ec

Browse files
authored
Improve deprecation message for MemoryExec (#14322)
* Improve deprecation message for `MemoryExec` * clippy
1 parent 1920771 commit 8d542ec

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

datafusion/physical-plan/src/values.rs

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,16 @@ use datafusion_execution::TaskContext;
3434
use datafusion_physical_expr::EquivalenceProperties;
3535

3636
/// Execution plan for values list based relation (produces constant rows)
37-
#[deprecated(since = "45.0.0", note = "Use `MemoryExec::try_new_as_values` instead")]
37+
///
38+
/// Note this structure is the same as [`MemoryExec`] and is deprecated.
39+
/// Please see the following for alternatives
40+
/// * [`MemoryExec::try_new`]
41+
/// * [`MemoryExec::try_new_from_batches`]
42+
///
43+
/// [`MemoryExec`]: crate::memory::MemoryExec
44+
/// [`MemoryExec::try_new`]: crate::memory::MemoryExec::try_new
45+
/// [`MemoryExec::try_new_from_batches`]: crate::memory::MemoryExec::try_new_from_batches
46+
#[deprecated(since = "45.0.0", note = "Use `MemoryExec` instead")]
3847
#[derive(Debug, Clone)]
3948
pub struct ValuesExec {
4049
/// The schema
@@ -48,6 +57,7 @@ pub struct ValuesExec {
4857
#[allow(deprecated)]
4958
impl ValuesExec {
5059
/// Create a new values exec from data as expr
60+
#[deprecated(since = "45.0.0", note = "Use `MemoryExec::try_new` instead")]
5161
pub fn try_new(
5262
schema: SchemaRef,
5363
data: Vec<Vec<Arc<dyn PhysicalExpr>>>,
@@ -101,6 +111,10 @@ impl ValuesExec {
101111
///
102112
/// Errors if any of the batches don't match the provided schema, or if no
103113
/// batches are provided.
114+
#[deprecated(
115+
since = "45.0.0",
116+
note = "Use `MemoryExec::try_new_from_batches` instead"
117+
)]
104118
pub fn try_new_from_batches(
105119
schema: SchemaRef,
106120
batches: Vec<RecordBatch>,

0 commit comments

Comments
 (0)