Package org.apache.druid.query

Class QueryContexts

java.lang.Object

org.apache.druid.query.QueryContexts

public class QueryContexts
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QueryContexts.Vectorize

Field Summary

Fields

Modifier and Type	Field	Description
static String	BROKER_PARALLEL_MERGE_INITIAL_YIELD_ROWS_KEY
static String	BROKER_PARALLEL_MERGE_KEY
static String	BROKER_PARALLEL_MERGE_SMALL_BATCH_ROWS_KEY
static String	BROKER_PARALLELISM
static String	BROKER_SERVICE_NAME
static String	BY_SEGMENT_KEY
static String	CTX_EXECUTION_MODE
static String	CTX_SQL_QUERY_ID
static String	CTX_SQL_STRINGIFY_ARRAYS
static boolean	DEFAULT_BY_SEGMENT
static boolean	DEFAULT_ENABLE_DEBUG
static boolean	DEFAULT_ENABLE_JOIN_FILTER_PUSH_DOWN
static boolean	DEFAULT_ENABLE_JOIN_FILTER_REWRITE
static long	DEFAULT_ENABLE_JOIN_FILTER_REWRITE_MAX_SIZE
static boolean	DEFAULT_ENABLE_JOIN_FILTER_REWRITE_VALUE_COLUMN_FILTERS
static boolean	DEFAULT_ENABLE_PARALLEL_MERGE
static boolean	DEFAULT_ENABLE_REWRITE_JOIN_TO_FILTER
static boolean	DEFAULT_ENABLE_SQL_JOIN_LEFT_SCAN_DIRECT
static boolean	DEFAULT_ENABLE_TIME_BOUNDARY_PLANNING
static int	DEFAULT_IN_SUB_QUERY_THRESHOLD
static boolean	DEFAULT_POPULATE_CACHE
static boolean	DEFAULT_POPULATE_RESULTLEVEL_CACHE
static int	DEFAULT_PRIORITY
static boolean	DEFAULT_SECONDARY_PARTITION_PRUNING
static String	DEFAULT_TIMEOUT_KEY
static long	DEFAULT_TIMEOUT_MILLIS
static int	DEFAULT_UNCOVERED_INTERVALS_LIMIT
static boolean	DEFAULT_USE_CACHE
static boolean	DEFAULT_USE_FILTER_CNF
static boolean	DEFAULT_USE_RESULTLEVEL_CACHE
static QueryContexts.Vectorize	DEFAULT_VECTORIZE
static QueryContexts.Vectorize	DEFAULT_VECTORIZE_VIRTUAL_COLUMN
static boolean	DEFAULT_WINDOWING_STRICT_VALIDATION
static String	ENABLE_DEBUG
static String	FINALIZE_KEY
static String	IN_SUB_QUERY_THRESHOLD_KEY
static String	JOIN_FILTER_PUSH_DOWN_KEY
static String	JOIN_FILTER_REWRITE_ENABLE_KEY
static String	JOIN_FILTER_REWRITE_MAX_SIZE_KEY
static String	JOIN_FILTER_REWRITE_VALUE_COLUMN_FILTERS_ENABLE_KEY
static String	LANE_KEY
static String	MAX_NUMERIC_IN_FILTERS
static String	MAX_QUEUED_BYTES_KEY
static String	MAX_SCATTER_GATHER_BYTES_KEY
static String	MAX_SUBQUERY_BYTES_KEY
static String	MAX_SUBQUERY_ROWS_KEY
static String	MIN_TOP_N_THRESHOLD
static long	NO_TIMEOUT
static String	NUM_RETRIES_ON_MISSING_SEGMENTS_KEY
static String	POPULATE_CACHE_KEY
static String	POPULATE_RESULT_LEVEL_CACHE_KEY
static String	PRIORITY_KEY
static String	QUERY_RESOURCE_ID
static String	RETURN_PARTIAL_RESULTS_KEY
static String	REWRITE_JOIN_TO_FILTER_ENABLE_KEY
static String	SECONDARY_PARTITION_PRUNING_KEY
static String	SERIALIZE_DATE_TIME_AS_LONG_INNER_KEY
static String	SERIALIZE_DATE_TIME_AS_LONG_KEY
static String	SQL_JOIN_LEFT_SCAN_DIRECT
static String	TIME_BOUNDARY_PLANNING_KEY
static String	TIMEOUT_KEY
static String	UNCOVERED_INTERVALS_LIMIT_KEY
static String	USE_CACHE_KEY
static String	USE_FILTER_CNF_KEY
static String	USE_NESTED_FOR_UNKNOWN_TYPE_IN_SUBQUERY
static String	USE_RESULT_LEVEL_CACHE_KEY
static String	VECTOR_SIZE_KEY
static String	VECTORIZE_KEY
static String	VECTORIZE_VIRTUAL_COLUMNS_KEY
static String	WINDOWING_STRICT_VALIDATION

Method Summary

Modifier and Type	Method	Description
static void	addDefaults(Map<String,Object> context, Map<String,Object> defaults)
static BadQueryContextException	badTypeException(String key, String expected, Object actual)
static BadQueryContextException	badValueException(String key, String expected, Object actual)
static Boolean	getAsBoolean(String key, Object value)
static boolean	getAsBoolean(String key, Object value, boolean defaultValue)	Get the value of a context value as a boolean.
static <E extends Enum<E>> E	getAsEnum(String key, Object value, Class<E> clazz)
static <E extends Enum<E>> E	getAsEnum(String key, Object value, Class<E> clazz, E defaultValue)
static Float	getAsFloat(String key, Object value)	Get the value of a context value as an Float.
static float	getAsFloat(String key, Object value, float defaultValue)
static HumanReadableBytes	getAsHumanReadableBytes(String key, Object value, HumanReadableBytes defaultValue)
static Integer	getAsInt(String key, Object value)
static int	getAsInt(String key, Object value, int defaultValue)	Get the value of a context value as an int.
static Long	getAsLong(String key, Object value)
static long	getAsLong(String key, Object value, long defaultValue)	Get the value of a context value as an long.
static String	getAsString(String key, Object value, String defaultValue)
static Map<String,Object>	override(Map<String,Object> context, String key, Object value)	Insert, update or remove a single key to produce an overridden context.
static Map<String,Object>	override(Map<String,Object> context, Map<String,Object> overrides)	Insert or replace multiple keys to produce an overridden context.
static boolean	parseBoolean(Map<String,Object> context, String key, boolean defaultValue)
static float	parseFloat(Map<String,Object> context, String key, float defaultValue)
static int	parseInt(Map<String,Object> context, String key, int defaultValue)
static long	parseLong(Map<String,Object> context, String key, long defaultValue)
static String	parseString(Map<String,Object> context, String key)
static String	parseString(Map<String,Object> context, String key, String defaultValue)

Methods inherited from class java.lang.Object

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

Field Detail

FINALIZE_KEY

public static final String FINALIZE_KEY

See Also:

Constant Field Values

PRIORITY_KEY

public static final String PRIORITY_KEY

See Also:

Constant Field Values

LANE_KEY

public static final String LANE_KEY

See Also:

Constant Field Values

TIMEOUT_KEY

public static final String TIMEOUT_KEY

See Also:

Constant Field Values

MAX_SCATTER_GATHER_BYTES_KEY

public static final String MAX_SCATTER_GATHER_BYTES_KEY

See Also:

Constant Field Values

MAX_QUEUED_BYTES_KEY

public static final String MAX_QUEUED_BYTES_KEY

See Also:

Constant Field Values

DEFAULT_TIMEOUT_KEY

public static final String DEFAULT_TIMEOUT_KEY

See Also:

Constant Field Values

BROKER_PARALLEL_MERGE_KEY

public static final String BROKER_PARALLEL_MERGE_KEY

See Also:

Constant Field Values

BROKER_PARALLEL_MERGE_INITIAL_YIELD_ROWS_KEY

public static final String BROKER_PARALLEL_MERGE_INITIAL_YIELD_ROWS_KEY

See Also:

Constant Field Values

BROKER_PARALLEL_MERGE_SMALL_BATCH_ROWS_KEY

public static final String BROKER_PARALLEL_MERGE_SMALL_BATCH_ROWS_KEY

See Also:

Constant Field Values

BROKER_PARALLELISM

public static final String BROKER_PARALLELISM

See Also:

Constant Field Values

VECTORIZE_KEY

public static final String VECTORIZE_KEY

See Also:

Constant Field Values

VECTORIZE_VIRTUAL_COLUMNS_KEY

public static final String VECTORIZE_VIRTUAL_COLUMNS_KEY

See Also:

Constant Field Values

VECTOR_SIZE_KEY

public static final String VECTOR_SIZE_KEY

See Also:

Constant Field Values

MAX_SUBQUERY_ROWS_KEY

public static final String MAX_SUBQUERY_ROWS_KEY

See Also:

Constant Field Values

MAX_SUBQUERY_BYTES_KEY

public static final String MAX_SUBQUERY_BYTES_KEY

See Also:

Constant Field Values

USE_NESTED_FOR_UNKNOWN_TYPE_IN_SUBQUERY

public static final String USE_NESTED_FOR_UNKNOWN_TYPE_IN_SUBQUERY

See Also:

Constant Field Values

JOIN_FILTER_PUSH_DOWN_KEY

public static final String JOIN_FILTER_PUSH_DOWN_KEY

See Also:

Constant Field Values

JOIN_FILTER_REWRITE_ENABLE_KEY

public static final String JOIN_FILTER_REWRITE_ENABLE_KEY

See Also:

Constant Field Values

JOIN_FILTER_REWRITE_VALUE_COLUMN_FILTERS_ENABLE_KEY

public static final String JOIN_FILTER_REWRITE_VALUE_COLUMN_FILTERS_ENABLE_KEY

See Also:

Constant Field Values

REWRITE_JOIN_TO_FILTER_ENABLE_KEY

public static final String REWRITE_JOIN_TO_FILTER_ENABLE_KEY

See Also:

Constant Field Values

JOIN_FILTER_REWRITE_MAX_SIZE_KEY

public static final String JOIN_FILTER_REWRITE_MAX_SIZE_KEY

See Also:

Constant Field Values

MAX_NUMERIC_IN_FILTERS

public static final String MAX_NUMERIC_IN_FILTERS

See Also:

Constant Field Values

SQL_JOIN_LEFT_SCAN_DIRECT

public static final String SQL_JOIN_LEFT_SCAN_DIRECT

See Also:

Constant Field Values

USE_FILTER_CNF_KEY

public static final String USE_FILTER_CNF_KEY

See Also:

Constant Field Values

NUM_RETRIES_ON_MISSING_SEGMENTS_KEY

public static final String NUM_RETRIES_ON_MISSING_SEGMENTS_KEY

See Also:

Constant Field Values

RETURN_PARTIAL_RESULTS_KEY

public static final String RETURN_PARTIAL_RESULTS_KEY

See Also:

Constant Field Values

USE_CACHE_KEY

public static final String USE_CACHE_KEY

See Also:

Constant Field Values

SECONDARY_PARTITION_PRUNING_KEY

public static final String SECONDARY_PARTITION_PRUNING_KEY

See Also:

Constant Field Values

ENABLE_DEBUG

public static final String ENABLE_DEBUG

See Also:

Constant Field Values

BY_SEGMENT_KEY

public static final String BY_SEGMENT_KEY

See Also:

Constant Field Values

BROKER_SERVICE_NAME

public static final String BROKER_SERVICE_NAME

See Also:

Constant Field Values

IN_SUB_QUERY_THRESHOLD_KEY

public static final String IN_SUB_QUERY_THRESHOLD_KEY

See Also:

Constant Field Values

TIME_BOUNDARY_PLANNING_KEY

public static final String TIME_BOUNDARY_PLANNING_KEY

See Also:

Constant Field Values

POPULATE_CACHE_KEY

public static final String POPULATE_CACHE_KEY

See Also:

Constant Field Values

POPULATE_RESULT_LEVEL_CACHE_KEY

public static final String POPULATE_RESULT_LEVEL_CACHE_KEY

See Also:

Constant Field Values

USE_RESULT_LEVEL_CACHE_KEY

public static final String USE_RESULT_LEVEL_CACHE_KEY

See Also:

Constant Field Values

SERIALIZE_DATE_TIME_AS_LONG_KEY

public static final String SERIALIZE_DATE_TIME_AS_LONG_KEY

See Also:

Constant Field Values

SERIALIZE_DATE_TIME_AS_LONG_INNER_KEY

public static final String SERIALIZE_DATE_TIME_AS_LONG_INNER_KEY

See Also:

Constant Field Values

UNCOVERED_INTERVALS_LIMIT_KEY

public static final String UNCOVERED_INTERVALS_LIMIT_KEY

See Also:

Constant Field Values

MIN_TOP_N_THRESHOLD

public static final String MIN_TOP_N_THRESHOLD

See Also:

Constant Field Values

WINDOWING_STRICT_VALIDATION

public static final String WINDOWING_STRICT_VALIDATION

See Also:

Constant Field Values

QUERY_RESOURCE_ID

public static final String QUERY_RESOURCE_ID

See Also:

Constant Field Values

CTX_SQL_QUERY_ID

public static final String CTX_SQL_QUERY_ID

See Also:

Constant Field Values

CTX_SQL_STRINGIFY_ARRAYS

public static final String CTX_SQL_STRINGIFY_ARRAYS

See Also:

Constant Field Values

CTX_EXECUTION_MODE

public static final String CTX_EXECUTION_MODE

See Also:

Constant Field Values

DEFAULT_BY_SEGMENT

public static final boolean DEFAULT_BY_SEGMENT

See Also:

Constant Field Values

DEFAULT_POPULATE_CACHE

public static final boolean DEFAULT_POPULATE_CACHE

See Also:

Constant Field Values

DEFAULT_USE_CACHE

public static final boolean DEFAULT_USE_CACHE

See Also:

Constant Field Values

DEFAULT_POPULATE_RESULTLEVEL_CACHE

public static final boolean DEFAULT_POPULATE_RESULTLEVEL_CACHE

See Also:

Constant Field Values

DEFAULT_USE_RESULTLEVEL_CACHE

public static final boolean DEFAULT_USE_RESULTLEVEL_CACHE

See Also:

Constant Field Values

DEFAULT_VECTORIZE

public static final QueryContexts.Vectorize DEFAULT_VECTORIZE

DEFAULT_VECTORIZE_VIRTUAL_COLUMN

public static final QueryContexts.Vectorize DEFAULT_VECTORIZE_VIRTUAL_COLUMN

DEFAULT_PRIORITY

public static final int DEFAULT_PRIORITY

See Also:

Constant Field Values

DEFAULT_UNCOVERED_INTERVALS_LIMIT

public static final int DEFAULT_UNCOVERED_INTERVALS_LIMIT

See Also:

Constant Field Values

DEFAULT_TIMEOUT_MILLIS

public static final long DEFAULT_TIMEOUT_MILLIS

NO_TIMEOUT

public static final long NO_TIMEOUT

See Also:

Constant Field Values

DEFAULT_ENABLE_PARALLEL_MERGE

public static final boolean DEFAULT_ENABLE_PARALLEL_MERGE

See Also:

Constant Field Values

DEFAULT_ENABLE_JOIN_FILTER_PUSH_DOWN

public static final boolean DEFAULT_ENABLE_JOIN_FILTER_PUSH_DOWN

See Also:

Constant Field Values

DEFAULT_ENABLE_JOIN_FILTER_REWRITE

public static final boolean DEFAULT_ENABLE_JOIN_FILTER_REWRITE

See Also:

Constant Field Values

DEFAULT_ENABLE_JOIN_FILTER_REWRITE_VALUE_COLUMN_FILTERS

public static final boolean DEFAULT_ENABLE_JOIN_FILTER_REWRITE_VALUE_COLUMN_FILTERS

See Also:

Constant Field Values

DEFAULT_ENABLE_REWRITE_JOIN_TO_FILTER

public static final boolean DEFAULT_ENABLE_REWRITE_JOIN_TO_FILTER

See Also:

Constant Field Values

DEFAULT_ENABLE_JOIN_FILTER_REWRITE_MAX_SIZE

public static final long DEFAULT_ENABLE_JOIN_FILTER_REWRITE_MAX_SIZE

See Also:

Constant Field Values

DEFAULT_ENABLE_SQL_JOIN_LEFT_SCAN_DIRECT

public static final boolean DEFAULT_ENABLE_SQL_JOIN_LEFT_SCAN_DIRECT

See Also:

Constant Field Values

DEFAULT_USE_FILTER_CNF

public static final boolean DEFAULT_USE_FILTER_CNF

See Also:

Constant Field Values

DEFAULT_SECONDARY_PARTITION_PRUNING

public static final boolean DEFAULT_SECONDARY_PARTITION_PRUNING

See Also:

Constant Field Values

DEFAULT_ENABLE_DEBUG

public static final boolean DEFAULT_ENABLE_DEBUG

See Also:

Constant Field Values

DEFAULT_IN_SUB_QUERY_THRESHOLD

public static final int DEFAULT_IN_SUB_QUERY_THRESHOLD

See Also:

Constant Field Values

DEFAULT_ENABLE_TIME_BOUNDARY_PLANNING

public static final boolean DEFAULT_ENABLE_TIME_BOUNDARY_PLANNING

See Also:

Constant Field Values

DEFAULT_WINDOWING_STRICT_VALIDATION

public static final boolean DEFAULT_WINDOWING_STRICT_VALIDATION

See Also:

Constant Field Values

Method Detail

parseLong

public static long parseLong(Map<String,Object> context,
                             String key,
                             long defaultValue)

parseInt

public static int parseInt(Map<String,Object> context,
                           String key,
                           int defaultValue)

parseString

@Nullable
public static String parseString(Map<String,Object> context,
                                 String key)

parseBoolean

public static boolean parseBoolean(Map<String,Object> context,
                                   String key,
                                   boolean defaultValue)

parseString

public static String parseString(Map<String,Object> context,
                                 String key,
                                 String defaultValue)

parseFloat

public static float parseFloat(Map<String,Object> context,
                               String key,
                               float defaultValue)

getAsString

public static String getAsString(String key,
                                 Object value,
                                 String defaultValue)

getAsBoolean

@Nullable
public static Boolean getAsBoolean(String key,
                                   Object value)

getAsBoolean

public static boolean getAsBoolean(String key,
                                   Object value,
                                   boolean defaultValue)

Get the value of a context value as a boolean. The value is expected to be null, a string or a Boolean object.

getAsInt

@Nullable
public static Integer getAsInt(String key,
                               Object value)

getAsInt

public static int getAsInt(String key,
                           Object value,
                           int defaultValue)

Get the value of a context value as an int. The value is expected to be null, a string or a Number object.

getAsLong

@Nullable
public static Long getAsLong(String key,
                             Object value)

getAsLong

public static long getAsLong(String key,
                             Object value,
                             long defaultValue)

Get the value of a context value as an long. The value is expected to be null, a string or a Number object.

getAsFloat

public static Float getAsFloat(String key,
                               Object value)

Get the value of a context value as an Float. The value is expected to be null, a string or a Number object.

getAsFloat

public static float getAsFloat(String key,
                               Object value,
                               float defaultValue)

getAsHumanReadableBytes

public static HumanReadableBytes getAsHumanReadableBytes(String key,
                                                         Object value,
                                                         HumanReadableBytes defaultValue)

override

public static Map<String,Object> override(Map<String,Object> context,
                                                String key,
                                                Object value)

Insert, update or remove a single key to produce an overridden context. Leaves the original context unchanged.

Parameters:

context - context to override

key - key to insert, update or remove

value - if null, remove the key. Otherwise, insert or replace the key.

Returns:

a new context map

override

public static Map<String,Object> override(Map<String,Object> context,
                                                Map<String,Object> overrides)

Insert or replace multiple keys to produce an overridden context. Leaves the original context unchanged.

Parameters:

context - context to override

overrides - map of values to insert or replace

Returns:

a new context map

getAsEnum

public static <E extends Enum<E>> E getAsEnum(String key,
                                              Object value,
                                              Class<E> clazz,
                                              E defaultValue)

getAsEnum

@Nullable
public static <E extends Enum<E>> E getAsEnum(String key,
                                              Object value,
                                              Class<E> clazz)

badValueException

public static BadQueryContextException badValueException(String key,
                                                         String expected,
                                                         Object actual)

badTypeException

public static BadQueryContextException badTypeException(String key,
                                                        String expected,
                                                        Object actual)

addDefaults

public static void addDefaults(Map<String,Object> context,
                               Map<String,Object> defaults)