org.apache.druid.sql.calcite.planner

Class DruidPlanner

java.lang.Object

org.apache.druid.sql.calcite.planner.DruidPlanner

All Implemented Interfaces:

Closeable, AutoCloseable

public class DruidPlanner
extends Object
implements Closeable

Druid SQL planner. Wraps the underlying Calcite planner with Druid-specific actions around resource validation and conversion of the Calcite logical plan into a Druid native query.

The planner is designed to use once: it makes one trip through its lifecycle defined as:

start --> validate [--> prepare] --> plan

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DruidPlanner.State

Field Summary

Fields

Modifier and Type	Field and Description
static String	UNNAMED_INGESTION_COLUMN_ERROR

Method Summary

Modifier and Type	Method and Description
Access	authorize(Function<Set<ResourceAction>,Access> authorizer, boolean authorizeContextParams) Authorizes the statement.
void	close()
PlannerContext	getPlannerContext()
PlannerResult	plan() Plan an SQL query for execution, returning a PlannerResult which can be used to actually execute the query.
PrepareResult	prepare() Prepare a SQL query for execution, including some initial parsing and validation and any dynamic parameter type resolution, to support prepared statements via JDBC.
PrepareResult	prepareResult()
Set<ResourceAction>	resourceActions(boolean includeContext) Return the resource actions corresponding to the datasources and views which an authenticated request must be authorized for to process the query.
void	validate() Validates a SQL query and populates PlannerContext.getResourceActions().

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

UNNAMED_INGESTION_COLUMN_ERROR

public static final String UNNAMED_INGESTION_COLUMN_ERROR

See Also:

Constant Field Values

Method Detail

validate

public void validate()
              throws org.apache.calcite.sql.parser.SqlParseException,
                     org.apache.calcite.tools.ValidationException

Validates a SQL query and populates PlannerContext.getResourceActions().

Throws:

org.apache.calcite.sql.parser.SqlParseException

org.apache.calcite.tools.ValidationException

prepare

public PrepareResult prepare()

Prepare a SQL query for execution, including some initial parsing and validation and any dynamic parameter type resolution, to support prepared statements via JDBC. Prepare reuses the validation done in validate() which must be called first. A query can be prepared on a data source without having permissions on that data source. This odd state of affairs is necessary because DruidViewMacro prepares a view while having no information about the user of that view.

authorize

public Access authorize(Function<Set<ResourceAction>,Access> authorizer,
                        boolean authorizeContextParams)

Authorizes the statement. Done within the planner to enforce the authorization step within the planner's state machine.

Parameters:

authorizer - a function from resource actions to a Access result.

Returns:

the return value from the authorizer

resourceActions

public Set<ResourceAction> resourceActions(boolean includeContext)

Return the resource actions corresponding to the datasources and views which an authenticated request must be authorized for to process the query. The actions will be null if the planner has not yet advanced to the validation step. This may occur if validation fails and the caller accesses the resource actions as part of clean-up.

plan

public PlannerResult plan()
                   throws org.apache.calcite.tools.ValidationException

Plan an SQL query for execution, returning a PlannerResult which can be used to actually execute the query. Ideally, the query can be planned into a native Druid query, using planWithDruidConvention(org.apache.calcite.rel.RelRoot, org.apache.calcite.sql.SqlExplain, org.apache.calcite.sql.SqlInsert), but will fall-back to planWithBindableConvention(org.apache.calcite.rel.RelRoot, org.apache.calcite.sql.SqlExplain) if this is not possible. Planning reuses the validation done in `validate()` which must be called first.

Throws:

org.apache.calcite.tools.ValidationException

getPlannerContext

public PlannerContext getPlannerContext()

prepareResult

public PrepareResult prepareResult()

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable