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

Class PlannerConfig

java.lang.Object

org.apache.druid.sql.calcite.planner.PlannerConfig

public class PlannerConfig
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PlannerConfig.Builder	Builder for PlannerConfig, primarily for use in tests to allow setting options programmatically rather than from the command line or a properties file.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CTX_COMPUTE_INNER_JOIN_COST_AS_FILTER
static final String	CTX_KEY_FORCE_EXPRESSION_VIRTUAL_COLUMNS
static final String	CTX_KEY_USE_APPROXIMATE_COUNT_DISTINCT
static final String	CTX_KEY_USE_APPROXIMATE_TOPN
static final String	CTX_KEY_USE_GROUPING_SET_FOR_EXACT_DISTINCT
static final String	CTX_KEY_USE_LEXICOGRAPHIC_TOPN
static final String	CTX_KEY_USE_NATIVE_QUERY_EXPLAIN
static final String	CTX_MAX_NUMERIC_IN_FILTERS
static final String	CTX_REQUIRE_TIME_CONDITION
static final int	NUM_FILTER_NOT_USED

Constructor Summary

Constructors

Constructor	Description
PlannerConfig()

Method Summary

Modifier and Type	Method	Description
static PlannerConfig.Builder	builder()
boolean	equals(Object o)
int	getMaxNumericInFilters()
int	getMaxTopNLimit()
String	getNativeQuerySqlPlanningMode()
Map<String,Object>	getNonDefaultAsQueryContext()	Translates PlannerConfig settings into its equivalent QueryContext map.
org.joda.time.DateTimeZone	getSqlTimeZone()
int	hashCode()
boolean	isAuthorizeSystemTablesDirectly()
boolean	isComputeInnerJoinCostAsFilter()
boolean	isEnableSysQueriesTable()	Returns whether the sys.queries table is enabled.
boolean	isForceExpressionVirtualColumns()
boolean	isRequireTimeCondition()
boolean	isUseApproximateCountDistinct()
boolean	isUseApproximateTopN()
boolean	isUseGroupingSetForExactDistinct()
boolean	isUseLexicographicTopN()
boolean	isUseNativeQueryExplain()
PlannerConfig.Builder	toBuilder()
String	toString()
PlannerConfig	withOverrides(Map<String,Object> queryContext)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

CTX_KEY_USE_APPROXIMATE_COUNT_DISTINCT

public static final String CTX_KEY_USE_APPROXIMATE_COUNT_DISTINCT

See Also:

• Constant Field Values

CTX_KEY_USE_GROUPING_SET_FOR_EXACT_DISTINCT

public static final String CTX_KEY_USE_GROUPING_SET_FOR_EXACT_DISTINCT

See Also:

• Constant Field Values

CTX_KEY_USE_APPROXIMATE_TOPN

public static final String CTX_KEY_USE_APPROXIMATE_TOPN

See Also:

• Constant Field Values

CTX_KEY_USE_LEXICOGRAPHIC_TOPN

public static final String CTX_KEY_USE_LEXICOGRAPHIC_TOPN

See Also:

• Constant Field Values

CTX_COMPUTE_INNER_JOIN_COST_AS_FILTER

public static final String CTX_COMPUTE_INNER_JOIN_COST_AS_FILTER

See Also:

• Constant Field Values

CTX_KEY_USE_NATIVE_QUERY_EXPLAIN

public static final String CTX_KEY_USE_NATIVE_QUERY_EXPLAIN

See Also:

• Constant Field Values

CTX_KEY_FORCE_EXPRESSION_VIRTUAL_COLUMNS

public static final String CTX_KEY_FORCE_EXPRESSION_VIRTUAL_COLUMNS

See Also:

• Constant Field Values

CTX_MAX_NUMERIC_IN_FILTERS

public static final String CTX_MAX_NUMERIC_IN_FILTERS

See Also:

• Constant Field Values

CTX_REQUIRE_TIME_CONDITION

public static final String CTX_REQUIRE_TIME_CONDITION

See Also:

• Constant Field Values

NUM_FILTER_NOT_USED

public static final int NUM_FILTER_NOT_USED

See Also:

• Constant Field Values

Constructor Details

PlannerConfig

public PlannerConfig()

Method Details

getMaxNumericInFilters

public int getMaxNumericInFilters()

getMaxTopNLimit

public int getMaxTopNLimit()

isUseApproximateCountDistinct

public boolean isUseApproximateCountDistinct()

isUseGroupingSetForExactDistinct

public boolean isUseGroupingSetForExactDistinct()

isUseApproximateTopN

public boolean isUseApproximateTopN()

isUseLexicographicTopN

public boolean isUseLexicographicTopN()

isRequireTimeCondition

public boolean isRequireTimeCondition()

getSqlTimeZone

public org.joda.time.DateTimeZone getSqlTimeZone()

isComputeInnerJoinCostAsFilter

public boolean isComputeInnerJoinCostAsFilter()

isAuthorizeSystemTablesDirectly

public boolean isAuthorizeSystemTablesDirectly()

isUseNativeQueryExplain

public boolean isUseNativeQueryExplain()

isForceExpressionVirtualColumns

public boolean isForceExpressionVirtualColumns()

Returns:

true if special virtual columns should not be optimized and should always be of type "expressions", false otherwise.

getNativeQuerySqlPlanningMode

public String getNativeQuerySqlPlanningMode()

isEnableSysQueriesTable

public boolean isEnableSysQueriesTable()

Returns whether the sys.queries table is enabled.

withOverrides

public PlannerConfig withOverrides(Map<String,Object> queryContext)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

builder

public static PlannerConfig.Builder builder()

toBuilder

public PlannerConfig.Builder toBuilder()

getNonDefaultAsQueryContext

public Map<String,Object> getNonDefaultAsQueryContext()

Translates PlannerConfig settings into its equivalent QueryContext map.

Throws:

DruidException - if the translation is not possible.