Skip to content

Commit 424757f

Browse files
authored
impored document string for plan builder (#10496)
1 parent 0c5d72b commit 424757f

File tree

1 file changed

+22
-10
lines changed

1 file changed

+22
-10
lines changed

datafusion/expr/src/logical_plan/builder.rs

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1147,22 +1147,34 @@ impl LogicalPlanBuilder {
11471147
}
11481148

11491149
/// Converts a `Arc<LogicalPlan>` into `LogicalPlanBuilder`
1150-
/// fn employee_schema() -> Schema {
1151-
/// Schema::new(vec![
1152-
/// Field::new("id", DataType::Int32, false),
1153-
/// Field::new("first_name", DataType::Utf8, false),
1154-
/// Field::new("last_name", DataType::Utf8, false),
1155-
/// Field::new("state", DataType::Utf8, false),
1156-
/// Field::new("salary", DataType::Int32, false),
1157-
/// ])
1158-
/// }
1150+
/// ```
1151+
/// # use datafusion_expr::{Expr, expr, col, LogicalPlanBuilder, logical_plan::table_scan};
1152+
/// # use datafusion_common::Result;
1153+
/// # use arrow::datatypes::{Schema, DataType, Field};
1154+
/// # fn main() -> Result<()> {
1155+
/// #
1156+
/// # fn employee_schema() -> Schema {
1157+
/// # Schema::new(vec![
1158+
/// # Field::new("id", DataType::Int32, false),
1159+
/// # Field::new("first_name", DataType::Utf8, false),
1160+
/// # Field::new("last_name", DataType::Utf8, false),
1161+
/// # Field::new("state", DataType::Utf8, false),
1162+
/// # Field::new("salary", DataType::Int32, false),
1163+
/// # ])
1164+
/// # }
1165+
/// #
1166+
/// // Create the plan
11591167
/// let plan = table_scan(Some("employee_csv"), &employee_schema(), Some(vec![3, 4]))?
11601168
/// .sort(vec![
11611169
/// Expr::Sort(expr::Sort::new(Box::new(col("state")), true, true)),
11621170
/// Expr::Sort(expr::Sort::new(Box::new(col("salary")), false, false)),
11631171
/// ])?
11641172
/// .build()?;
1165-
/// let plan_builder: LogicalPlanBuilder = Arc::new(plan).into();
1173+
/// // Convert LogicalPlan into LogicalPlanBuilder
1174+
/// let plan_builder: LogicalPlanBuilder = std::sync::Arc::new(plan).into();
1175+
/// # Ok(())
1176+
/// # }
1177+
/// ```
11661178
11671179
impl From<Arc<LogicalPlan>> for LogicalPlanBuilder {
11681180
fn from(plan: Arc<LogicalPlan>) -> Self {

0 commit comments

Comments
 (0)