Package org.apache.druid.sql.calcite.planner

Class PlannerFactory

java.lang.Object

org.apache.druid.sql.calcite.planner.PlannerToolbox

org.apache.druid.sql.calcite.planner.PlannerFactory

public class PlannerFactory
extends PlannerToolbox

Field Summary

Fields inherited from class org.apache.druid.sql.calcite.planner.PlannerToolbox

authConfig, authorizerMapper, calciteRuleManager, catalog, druidSchemaName, hookDispatcher, joinableFactoryWrapper, jsonMapper, macroTable, operatorTable, plannerConfig, policyEnforcer, rootSchema

Constructor Summary

Constructors

Constructor

Description

PlannerFactory(DruidSchemaCatalog rootSchema, DruidOperatorTable operatorTable, ExprMacroTable macroTable, PlannerConfig plannerConfig, AuthorizerMapper authorizerMapper, com.fasterxml.jackson.databind.ObjectMapper jsonMapper, String druidSchemaName, CalciteRulesManager calciteRuleManager, JoinableFactoryWrapper joinableFactoryWrapper, CatalogResolver catalog, AuthConfig authConfig, PolicyEnforcer policyEnforcer, DruidHookDispatcher hookDispatcher)

Method Summary

Modifier and Type	Method	Description
DruidPlanner	createPlanner(SqlEngine engine, String sql, org.apache.calcite.sql.SqlNode sqlNode, Set<String> authContextKeys, Map<String,Object> queryContext, PlannerHook hook)	Create a Druid query planner from an initial query context.
DruidPlanner	createPlannerForTesting(SqlEngine engine, String sql, Map<String,Object> queryContext)	Not just visible for, but only for testing.
AuthorizerMapper	getAuthorizerMapper()

Methods inherited from class org.apache.druid.sql.calcite.planner.PlannerToolbox

calciteRuleManager, catalogResolver, druidSchemaName, exprMacroTable, getAuthConfig, getHookDispatcher, getPolicyEnforcer, joinableFactoryWrapper, jsonMapper, operatorTable, plannerConfig, rootSchema

Methods inherited from class java.lang.Object

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

Constructor Details

PlannerFactory

@Inject
public PlannerFactory(DruidSchemaCatalog rootSchema,
 DruidOperatorTable operatorTable,
 ExprMacroTable macroTable,
 PlannerConfig plannerConfig,
 AuthorizerMapper authorizerMapper,
 com.fasterxml.jackson.databind.ObjectMapper jsonMapper,
 String druidSchemaName,
 CalciteRulesManager calciteRuleManager,
 JoinableFactoryWrapper joinableFactoryWrapper,
 CatalogResolver catalog,
 AuthConfig authConfig,
 PolicyEnforcer policyEnforcer,
 DruidHookDispatcher hookDispatcher)

Method Details

createPlanner

public DruidPlanner createPlanner(SqlEngine engine,
 String sql,
 org.apache.calcite.sql.SqlNode sqlNode,
 Set<String> authContextKeys,
 Map<String,Object> queryContext,
 PlannerHook hook)

Create a Druid query planner from an initial query context. If allowSetStatementsToBuildContext is set to true, the parser is allowed to parse multi-part SQL statements where all statements in the list except the last one are SET statements, for example 'SET x = 'y'; SET foo = 123; SELECT ...', where these values will be added to the QueryContext of the final statement.

Parameters:

engine - current SQL engine

sql - sql query string

sqlNode - parsed sql query, from DruidSqlParser.parse(String, boolean). This is the main statement from StatementAndSetContext.getMainStatement().

authContextKeys - an immutable set of context keys needed for authorization checks.

queryContext - query context including StatementAndSetContext.getSetContext()

hook - calcite planner hook

createPlannerForTesting

public DruidPlanner createPlannerForTesting(SqlEngine engine,
 String sql,
 Map<String,Object> queryContext)

Not just visible for, but only for testing. Create a planner pre-loaded with an escalated authentication result and ready to go authorization result.

getAuthorizerMapper

public AuthorizerMapper getAuthorizerMapper()