Add documentation

Author: pepijnve

datafusion/physical-plan/src/aggregates/no_grouping.rs

@@ -35,7 +35,7 @@ use std::task::{Context, Poll};
 
 use super::AggregateExec;
 use crate::filter::batch_filter;
-use crate::poll_budget::{PollBudget, YieldStream};
+use crate::r#yield::{PollBudget, YieldStream};
 use datafusion_execution::memory_pool::{MemoryConsumer, MemoryReservation};
 use futures::stream::{Stream, StreamExt};
 

datafusion/physical-plan/src/aggregates/row_hash.rs

@@ -49,7 +49,7 @@ use datafusion_physical_expr::{GroupsAccumulatorAdapter, PhysicalSortExpr};
 
 use super::order::GroupOrdering;
 use super::AggregateExec;
-use crate::poll_budget::PollBudget;
+use crate::r#yield::PollBudget;
 use datafusion_physical_expr::aggregate::AggregateFunctionExpr;
 use datafusion_physical_expr_common::sort_expr::LexOrdering;
 use futures::stream::{Stream, StreamExt};

datafusion/physical-plan/src/aggregates/topk_stream.rs

@@ -22,7 +22,7 @@ use crate::aggregates::{
     aggregate_expressions, evaluate_group_by, evaluate_many, AggregateExec,
     PhysicalGroupBy,
 };
-use crate::poll_budget::PollBudget;
+use crate::r#yield::PollBudget;
 use crate::{RecordBatchStream, SendableRecordBatchStream};
 use arrow::array::{Array, ArrayRef, RecordBatch};
 use arrow::datatypes::SchemaRef;

datafusion/physical-plan/src/filter.rs

@@ -63,7 +63,7 @@ use datafusion_physical_expr::{
 };
 use futures::FutureExt;
 
-use crate::poll_budget::PollBudget;
+use crate::r#yield::PollBudget;
 use datafusion_physical_expr_common::physical_expr::fmt_sql;
 use futures::stream::{Stream, StreamExt};
 use itertools::Itertools;

datafusion/physical-plan/src/joins/cross_join.rs

@@ -46,7 +46,7 @@ use datafusion_execution::memory_pool::{MemoryConsumer, MemoryReservation};
 use datafusion_execution::TaskContext;
 use datafusion_physical_expr::equivalence::join_equivalence_properties;
 
-use crate::poll_budget::{PollBudget, YieldStream};
+use crate::r#yield::{PollBudget, YieldStream};
 use async_trait::async_trait;
 use futures::{ready, Stream, StreamExt, TryStreamExt};
 

datafusion/physical-plan/src/joins/hash_join.rs

@@ -81,7 +81,7 @@ use datafusion_physical_expr::equivalence::{
 use datafusion_physical_expr::PhysicalExprRef;
 use datafusion_physical_expr_common::datum::compare_op_for_nested;
 
-use crate::poll_budget::{PollBudget, YieldStream};
+use crate::r#yield::{PollBudget, YieldStream};
 use ahash::RandomState;
 use datafusion_physical_expr_common::physical_expr::fmt_sql;
 use futures::{ready, Stream, StreamExt, TryStreamExt};

datafusion/physical-plan/src/joins/nested_loop_join.rs

@@ -61,7 +61,7 @@ use datafusion_physical_expr::equivalence::{
     join_equivalence_properties, ProjectionMapping,
 };
 
-use crate::poll_budget::{PollBudget, YieldStream};
+use crate::r#yield::{PollBudget, YieldStream};
 use futures::{ready, Stream, StreamExt, TryStreamExt};
 use parking_lot::Mutex;
 

datafusion/physical-plan/src/joins/sort_merge_join.rs

@@ -74,7 +74,7 @@ use datafusion_physical_expr::PhysicalExprRef;
 use datafusion_physical_expr_common::physical_expr::fmt_sql;
 use datafusion_physical_expr_common::sort_expr::{LexOrdering, LexRequirement};
 
-use crate::poll_budget::PollBudget;
+use crate::r#yield::PollBudget;
 use futures::{FutureExt, Stream, StreamExt};
 
 /// Join execution plan that executes equi-join predicates on multiple partitions using Sort-Merge

datafusion/physical-plan/src/lib.rs

@@ -73,7 +73,6 @@ pub mod limit;
 pub mod memory;
 pub mod metrics;
 pub mod placeholder_row;
-pub mod poll_budget;
 pub mod projection;
 pub mod recursive_query;
 pub mod repartition;
@@ -87,6 +86,7 @@ pub mod unnest;
 pub mod values;
 pub mod windows;
 pub mod work_table;
+pub mod r#yield;
 pub mod udaf {
     pub use datafusion_expr::StatisticsArgs;
     pub use datafusion_physical_expr::aggregate::AggregateFunctionExpr;

datafusion/physical-plan/src/poll_budget.rs

@@ -54,7 +54,7 @@ use datafusion_execution::TaskContext;
 use datafusion_physical_expr::LexOrdering;
 use datafusion_physical_expr_common::sort_expr::LexRequirement;
 
-use crate::poll_budget::PollBudget;
+use crate::r#yield::PollBudget;
 use futures::{StreamExt, TryStreamExt};
 use log::{debug, trace};
 

datafusion/physical-plan/src/sorts/sort.rs

@@ -63,7 +63,7 @@ use datafusion_physical_expr::window::{
 use datafusion_physical_expr::PhysicalExpr;
 use datafusion_physical_expr_common::sort_expr::{LexOrdering, LexRequirement};
 
-use crate::poll_budget::PollBudget;
+use crate::r#yield::PollBudget;
 use futures::stream::Stream;
 use futures::{ready, FutureExt, StreamExt};
 use hashbrown::hash_table::HashTable;

datafusion/physical-plan/src/windows/bounded_window_agg_exec.rs

@@ -46,7 +46,7 @@ use datafusion_common::{internal_err, Result};
 use datafusion_execution::TaskContext;
 use datafusion_physical_expr_common::sort_expr::{LexOrdering, LexRequirement};
 
-use crate::poll_budget::PollBudget;
+use crate::r#yield::PollBudget;
 use futures::{ready, FutureExt, Stream, StreamExt};
 
 /// Window execution plan