geoffreyclaude commented on code in PR #17843:
URL: https://github.com/apache/datafusion/pull/17843#discussion_r2531559958
##########
datafusion/expr/src/planner.rs:
##########
@@ -324,6 +334,85 @@ pub enum PlannerResult<T> {
Original(T),
}
+/// Result of planning a relation with [`RelationPlanner`]
+#[cfg(feature = "sql")]
+#[derive(Debug, Clone)]
+pub struct PlannedRelation {
+ /// The logical plan for the relation
+ pub plan: LogicalPlan,
+ /// Optional table alias for the relation
+ pub alias: Option<TableAlias>,
+}
+
+#[cfg(feature = "sql")]
+impl PlannedRelation {
+ /// Create a new `PlannedRelation` with the given plan and alias
+ pub fn new(plan: LogicalPlan, alias: Option<TableAlias>) -> Self {
+ Self { plan, alias }
+ }
+}
+
+/// Result of attempting to plan a relation with extension planners
+#[cfg(feature = "sql")]
+#[derive(Debug)]
+pub enum RelationPlanning {
+ /// The relation was successfully planned by an extension planner
+ Planned(PlannedRelation),
+ /// No extension planner handled the relation, return it for default
processing
+ Original(TableFactor),
+}
+
+/// Customize planning SQL table factors to [`LogicalPlan`]s.
+#[cfg(feature = "sql")]
+pub trait RelationPlanner: Debug + Send + Sync {
+ /// Plan a table factor into a [`LogicalPlan`].
+ ///
+ /// Returning `Ok(RelationPlanning::Transformed(planned_relation))`
short-circuits further planning and uses the
+ /// provided plan. Returning `Ok(RelationPlanning::Original(relation))`
allows the next registered planner,
+ /// or DataFusion's default logic, to handle the relation.
Review Comment:
Fixed the comment typo, the code is actually `RelationPlanning::Planned` and
not `RelationPlanning::Transformed`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
