gortiz commented on code in PR #15277:
URL: https://github.com/apache/pinot/pull/15277#discussion_r2005674087
##########
pinot-query-planner/src/main/java/org/apache/pinot/query/QueryEnvironment.java:
##########
@@ -558,4 +546,134 @@ default boolean defaultEnableGroupTrim() {
@Nullable
WorkerManager getWorkerManager();
}
+
+ /// A query that have been parsed, validates, transformed into a [RelNode]
and optimized with Calcite.
+ ///
+ /// This represents the last point where Calcite is being used. This object
can then be:
+ /// - Used to get the tables involved in the query (see [#getTableNames])
+ /// - Used to explain the query plan (see [#explain])
+ /// - Used to plan how to evaluate the query using Pinot Engine (see
[#planQuery])
+ ///
+ /// Compiled queries are craeted by calling [QueryEnvironment#compile] and
should be closed.
Review Comment:
I don't know if callers need to know about PlannerContext or whether the
fact that CompiledQuery contains a PlannerContext is written in stone, so I
preferred to be less specific. Anyway, I don't think we need to be super formal
in these mostly inner APIs, so I'm going to add that
--
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: commits-unsubscr...@pinot.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@pinot.apache.org
For additional commands, e-mail: commits-h...@pinot.apache.org
