org.apache.druid.sql.calcite.planner

Class PlannerContext

java.lang.Object

org.apache.druid.sql.calcite.planner.PlannerContext

public class PlannerContext
extends Object

Like PlannerConfig, but that has static configuration and this class contains dynamic, per-query configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CTX_SQL_CURRENT_TIMESTAMP
static String	CTX_SQL_OUTER_LIMIT
static String	CTX_SQL_QUERY_ID
static String	CTX_SQL_STRINGIFY_ARRAYS
static String	CTX_SQL_TIME_ZONE
static String	DATA_CTX_AUTHENTICATION_RESULT

Method Summary

Modifier and Type	Method and Description
void	addNativeQueryId(String queryId)
static PlannerContext	create(String sql, DruidOperatorTable operatorTable, ExprMacroTable macroTable, com.fasterxml.jackson.databind.ObjectMapper jsonMapper, PlannerConfig plannerConfig, DruidSchemaCatalog rootSchema, SqlEngine engine, QueryContext queryContext)
org.apache.calcite.DataContext	createDataContext(org.apache.calcite.adapter.java.JavaTypeFactory typeFactory, List<org.apache.calcite.avatica.remote.TypedValue> parameters)
boolean	engineHasFeature(EngineFeature feature)
AuthenticationResult	getAuthenticationResult()
Access	getAuthorizationResult()
SqlEngine	getEngine()
ExprMacroTable	getExprMacroTable()
VirtualColumnRegistry	getJoinExpressionVirtualColumnRegistry()
com.fasterxml.jackson.databind.ObjectMapper	getJsonMapper()
org.joda.time.DateTime	getLocalNow()
CopyOnWriteArrayList<String>	getNativeQueryIds()
DruidOperatorTable	getOperatorTable()
List<org.apache.calcite.avatica.remote.TypedValue>	getParameters()
PlannerConfig	getPlannerConfig()
String	getPlanningError()
QueryContext	getQueryContext()
QueryMaker	getQueryMaker()
Set<ResourceAction>	getResourceActions()
String	getSchemaResourceType(String schema, String resourceName)
String	getSql()
String	getSqlQueryId()
org.joda.time.DateTimeZone	getTimeZone()
boolean	isStringifyArrays()
void	setAuthenticationResult(AuthenticationResult authenticationResult)
void	setAuthorizationResult(Access access)
void	setJoinExpressionVirtualColumnRegistry(VirtualColumnRegistry joinExpressionVirtualColumnRegistry)
void	setParameters(List<org.apache.calcite.avatica.remote.TypedValue> parameters)
void	setPlanningError(String formatText, Object... arguments) Sets the planning error in the context that will be shown to the user if the SQL query cannot be translated to a native query.
void	setQueryMaker(QueryMaker queryMaker)
void	setResourceActions(Set<ResourceAction> resourceActions)

Methods inherited from class java.lang.Object

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

Field Detail

CTX_SQL_QUERY_ID

public static final String CTX_SQL_QUERY_ID

See Also:

Constant Field Values

CTX_SQL_CURRENT_TIMESTAMP

public static final String CTX_SQL_CURRENT_TIMESTAMP

See Also:

Constant Field Values

CTX_SQL_TIME_ZONE

public static final String CTX_SQL_TIME_ZONE

See Also:

Constant Field Values

CTX_SQL_STRINGIFY_ARRAYS

public static final String CTX_SQL_STRINGIFY_ARRAYS

See Also:

Constant Field Values

CTX_SQL_OUTER_LIMIT

public static final String CTX_SQL_OUTER_LIMIT

See Also:

Constant Field Values

DATA_CTX_AUTHENTICATION_RESULT

public static final String DATA_CTX_AUTHENTICATION_RESULT

See Also:

Constant Field Values

Method Detail

create

public static PlannerContext create(String sql,
                                    DruidOperatorTable operatorTable,
                                    ExprMacroTable macroTable,
                                    com.fasterxml.jackson.databind.ObjectMapper jsonMapper,
                                    PlannerConfig plannerConfig,
                                    DruidSchemaCatalog rootSchema,
                                    SqlEngine engine,
                                    QueryContext queryContext)

getOperatorTable

public DruidOperatorTable getOperatorTable()

getExprMacroTable

public ExprMacroTable getExprMacroTable()

getJsonMapper

public com.fasterxml.jackson.databind.ObjectMapper getJsonMapper()

getPlannerConfig

public PlannerConfig getPlannerConfig()

getLocalNow

public org.joda.time.DateTime getLocalNow()

getTimeZone

public org.joda.time.DateTimeZone getTimeZone()

getSchemaResourceType

@Nullable
public String getSchemaResourceType(String schema,
                                              String resourceName)

getQueryContext

public QueryContext getQueryContext()

isStringifyArrays

public boolean isStringifyArrays()

getParameters

public List<org.apache.calcite.avatica.remote.TypedValue> getParameters()

getAuthenticationResult

public AuthenticationResult getAuthenticationResult()

getSql

public String getSql()

getSqlQueryId

public String getSqlQueryId()

getNativeQueryIds

public CopyOnWriteArrayList<String> getNativeQueryIds()

addNativeQueryId

public void addNativeQueryId(String queryId)

getPlanningError

@Nullable
public String getPlanningError()

setPlanningError

public void setPlanningError(String formatText,
                             Object... arguments)

Sets the planning error in the context that will be shown to the user if the SQL query cannot be translated to a native query. This error is often a hint and thus should be phrased as such. Also, the final plan can be very different from SQL that user has written. So again, the error should be phrased to indicate this gap clearly.

createDataContext

public org.apache.calcite.DataContext createDataContext(org.apache.calcite.adapter.java.JavaTypeFactory typeFactory,
                                                        List<org.apache.calcite.avatica.remote.TypedValue> parameters)

getAuthorizationResult

public Access getAuthorizationResult()

setParameters

public void setParameters(List<org.apache.calcite.avatica.remote.TypedValue> parameters)

setAuthenticationResult

public void setAuthenticationResult(AuthenticationResult authenticationResult)

setAuthorizationResult

public void setAuthorizationResult(Access access)

getResourceActions

public Set<ResourceAction> getResourceActions()

setResourceActions

public void setResourceActions(Set<ResourceAction> resourceActions)

setQueryMaker

public void setQueryMaker(QueryMaker queryMaker)

getEngine

public SqlEngine getEngine()

engineHasFeature

public boolean engineHasFeature(EngineFeature feature)

getQueryMaker

public QueryMaker getQueryMaker()

getJoinExpressionVirtualColumnRegistry

public VirtualColumnRegistry getJoinExpressionVirtualColumnRegistry()

setJoinExpressionVirtualColumnRegistry

public void setJoinExpressionVirtualColumnRegistry(VirtualColumnRegistry joinExpressionVirtualColumnRegistry)