This is an automated email from the ASF dual-hosted git repository.
alamb 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 7d49fb308d Minor: refine Partitioning documentation (#12145)
7d49fb308d is described below
commit 7d49fb308d638bef2c1ed1fa96fc87e3f740c72e
Author: Andrew Lamb <[email protected]>
AuthorDate: Mon Aug 26 15:12:23 2024 -0400
Minor: refine Partitioning documentation (#12145)
---
datafusion/expr/src/logical_plan/plan.rs | 6 +++++-
datafusion/physical-expr/src/partitioning.rs | 6 ++++--
2 files changed, 9 insertions(+), 3 deletions(-)
diff --git a/datafusion/expr/src/logical_plan/plan.rs
b/datafusion/expr/src/logical_plan/plan.rs
index 3ede7f25b7..d6574040c5 100644
--- a/datafusion/expr/src/logical_plan/plan.rs
+++ b/datafusion/expr/src/logical_plan/plan.rs
@@ -2932,7 +2932,11 @@ impl Debug for Subquery {
}
}
-/// Logical partitioning schemes supported by the repartition operator.
+/// Logical partitioning schemes supported by [`LogicalPlan::Repartition`]
+///
+/// See [`Partitioning`] for more details on partitioning
+///
+/// [`Partitioning`]:
https://docs.rs/datafusion/latest/datafusion/physical_expr/enum.Partitioning.html#
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum Partitioning {
/// Allocate batches using a round-robin algorithm and the specified
number of partitions
diff --git a/datafusion/physical-expr/src/partitioning.rs
b/datafusion/physical-expr/src/partitioning.rs
index 6472dd4748..45beeb7b81 100644
--- a/datafusion/physical-expr/src/partitioning.rs
+++ b/datafusion/physical-expr/src/partitioning.rs
@@ -24,8 +24,8 @@ use crate::{physical_exprs_equal, EquivalenceProperties,
PhysicalExpr};
/// Output partitioning supported by [`ExecutionPlan`]s.
///
-/// When `executed`, `ExecutionPlan`s produce one or more independent stream
of
-/// data batches in parallel, referred to as partitions. The streams are Rust
+/// Calling [`ExecutionPlan::execute`] produce one or more independent streams
of
+/// [`RecordBatch`]es in parallel, referred to as partitions. The streams are
Rust
/// `async` [`Stream`]s (a special kind of future). The number of output
/// partitions varies based on the input and the operation performed.
///
@@ -102,6 +102,8 @@ use crate::{physical_exprs_equal, EquivalenceProperties,
PhysicalExpr};
/// Plans such as `FilterExec` produce the same number of output streams
/// (partitions) as input streams (partitions).
///
+/// [`RecordBatch`]: arrow::record_batch::RecordBatch
+/// [`ExecutionPlan::execute`]:
https://docs.rs/datafusion/latest/datafusion/physical_plan/trait.ExecutionPlan.html#tymethod.execute
/// [`ExecutionPlan`]:
https://docs.rs/datafusion/latest/datafusion/physical_plan/trait.ExecutionPlan.html
/// [`Stream`]: https://docs.rs/futures/latest/futures/stream/trait.Stream.html
#[derive(Debug, Clone)]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
