Package org.apache.druid.query.timeseries

Class TimeseriesQuery

java.lang.Object

org.apache.druid.query.BaseQuery<Result<TimeseriesResultValue>>

org.apache.druid.query.timeseries.TimeseriesQuery

All Implemented Interfaces:

Query<Result<TimeseriesResultValue>>

public class TimeseriesQuery
extends BaseQuery<Result<TimeseriesResultValue>>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CTX_GRAND_TOTAL
static final String	CTX_TIMESTAMP_RESULT_FIELD
static final String	SKIP_EMPTY_BUCKETS

Fields inherited from class org.apache.druid.query.BaseQuery

QUERY_ID, SQL_QUERY_ID, SUB_QUERY_ID

Fields inherited from interface org.apache.druid.query.Query

DATASOURCE_METADATA, GROUP_BY, SCAN, SEARCH, SEGMENT_METADATA, SELECT, TIME_BOUNDARY, TIMESERIES, TOPN, UNION_QUERY, WINDOW_OPERATOR

Constructor Summary

Constructors

Constructor	Description
TimeseriesQuery(DataSource dataSource, QuerySegmentSpec querySegmentSpec, boolean descending, VirtualColumns virtualColumns, DimFilter dimFilter, Granularity granularity, List<AggregatorFactory> aggregatorSpecs, List<PostAggregator> postAggregatorSpecs, int limit, Map<String,Object> context)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
List<AggregatorFactory>	getAggregatorSpecs()
DimFilter	getDimensionsFilter()
DimFilter	getFilter()
int	getLimit()
List<PostAggregator>	getPostAggregatorSpecs()
Set<String>	getRequiredColumns()	Returns the set of columns that this query will need to access out of its datasource.
com.google.common.collect.Ordering<Result<TimeseriesResultValue>>	getResultOrdering()	Default implementation of Query.getResultOrdering() that uses Ordering.natural().
RowSignature	getResultRowSignature(RowSignature.Finalization finalization)
String	getTimestampResultField()
String	getType()
VirtualColumns	getVirtualColumns()
boolean	hasFilters()
int	hashCode()
boolean	isDescending()
boolean	isGrandTotal()
boolean	isSkipEmptyBuckets()
Query<Result<TimeseriesResultValue>>	optimizeForSegment(PerSegmentQueryOptimizationContext optimizationContext)
String	toString()
TimeseriesQuery	withAggregatorSpecs(List<AggregatorFactory> aggregatorSpecs)
Query<Result<TimeseriesResultValue>>	withDataSource(DataSource dataSource)
TimeseriesQuery	withDimFilter(DimFilter dimFilter)
TimeseriesQuery	withOverriddenContext(Map<String,Object> contextOverrides)
TimeseriesQuery	withPostAggregatorSpecs(List<PostAggregator> postAggregatorSpecs)
TimeseriesQuery	withQuerySegmentSpec(QuerySegmentSpec querySegmentSpec)	Returns a new query, identical to this one, but with a different associated QuerySegmentSpec.

Methods inherited from class org.apache.druid.query.BaseQuery

calculateDuration, checkInterrupted, computeOverriddenContext, computeOverridenContext, context, getContext, getDataSource, getDuration, getGranularity, getId, getIntervals, getQuerySegmentSpec, getRunner, getSubQueryId, getTimezone, withId, withSqlQueryId, withSubQueryId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.druid.query.Query

getContextBoolean, getContextHumanReadableBytes, getContextValue, getMostSpecificId, getResultRowSignature, getSingleInterval, getSqlQueryId, mayCollapseQueryDataSource, withDefaultSubQueryId, withLane, withPriority

Field Details

CTX_GRAND_TOTAL

public static final String CTX_GRAND_TOTAL

See Also:

• Constant Field Values

SKIP_EMPTY_BUCKETS

public static final String SKIP_EMPTY_BUCKETS

See Also:

• Constant Field Values

CTX_TIMESTAMP_RESULT_FIELD

public static final String CTX_TIMESTAMP_RESULT_FIELD

See Also:

• Constant Field Values

Constructor Details

TimeseriesQuery

public TimeseriesQuery(DataSource dataSource,
 QuerySegmentSpec querySegmentSpec,
 boolean descending,
 VirtualColumns virtualColumns,
 DimFilter dimFilter,
 Granularity granularity,
 List<AggregatorFactory> aggregatorSpecs,
 List<PostAggregator> postAggregatorSpecs,
 int limit,
 Map<String,Object> context)

Method Details

hasFilters

public boolean hasFilters()

getFilter

public DimFilter getFilter()

getType

public String getType()

getVirtualColumns

public VirtualColumns getVirtualColumns()

getDimensionsFilter

public DimFilter getDimensionsFilter()

getAggregatorSpecs

public List<AggregatorFactory> getAggregatorSpecs()

getPostAggregatorSpecs

public List<PostAggregator> getPostAggregatorSpecs()

isDescending

public boolean isDescending()

getLimit

public int getLimit()

isGrandTotal

public boolean isGrandTotal()

getTimestampResultField

public String getTimestampResultField()

isSkipEmptyBuckets

public boolean isSkipEmptyBuckets()

getResultRowSignature

public RowSignature getResultRowSignature(RowSignature.Finalization finalization)

getRequiredColumns

@Nullable
public Set<String> getRequiredColumns()

Description copied from interface: Query

Returns the set of columns that this query will need to access out of its datasource.

This method does not "look into" what the datasource itself is doing. For example, if a query is built on a QueryDataSource, this method will not return the columns used by that subquery. As another example, if a query is built on a JoinDataSource, this method will not return the columns from the underlying datasources that are used by the join condition, unless those columns are also used by this query in other ways.

Returns null if the set of required columns cannot be known ahead of time.

getResultOrdering

public com.google.common.collect.Ordering<Result<TimeseriesResultValue>> getResultOrdering()

Description copied from class: BaseQuery

Default implementation of Query.getResultOrdering() that uses Ordering.natural(). If your query result type T is not Comparable, you must override this method.

Specified by:

getResultOrdering in interface Query<Result<TimeseriesResultValue>>

Overrides:

getResultOrdering in class BaseQuery<Result<TimeseriesResultValue>>

withQuerySegmentSpec

public TimeseriesQuery withQuerySegmentSpec(QuerySegmentSpec querySegmentSpec)

Description copied from interface: Query

Returns a new query, identical to this one, but with a different associated QuerySegmentSpec.

This often changes the behavior of Query.getRunner(QuerySegmentWalker), since most queries inherit that method from BaseQuery, which implements it by calling QuerySegmentSpec.lookup(org.apache.druid.query.Query<T>, org.apache.druid.query.QuerySegmentWalker).

withDataSource

public Query<Result<TimeseriesResultValue>> withDataSource(DataSource dataSource)

optimizeForSegment

public Query<Result<TimeseriesResultValue>> optimizeForSegment(PerSegmentQueryOptimizationContext optimizationContext)

withOverriddenContext

public TimeseriesQuery withOverriddenContext(Map<String,Object> contextOverrides)

withDimFilter

public TimeseriesQuery withDimFilter(DimFilter dimFilter)

withAggregatorSpecs

public TimeseriesQuery withAggregatorSpecs(List<AggregatorFactory> aggregatorSpecs)

withPostAggregatorSpecs

public TimeseriesQuery withPostAggregatorSpecs(List<PostAggregator> postAggregatorSpecs)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class BaseQuery<Result<TimeseriesResultValue>>

hashCode

public int hashCode()

Overrides:

hashCode in class BaseQuery<Result<TimeseriesResultValue>>