java.lang.Object
- org.apache.druid.query.BaseQuery<ResultRow>
- - org.apache.druid.query.groupby.GroupByQuery

All Implemented Interfaces:: Query<ResultRow>

public class GroupByQuery
extends BaseQuery<ResultRow>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class GroupByQuery.Builder

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`CTX_KEY_SORT_BY_DIMS_FIRST`
`static String`	`CTX_TIMESTAMP_RESULT_FIELD`
`static String`	`CTX_TIMESTAMP_RESULT_FIELD_GRANULARITY`
`static String`	`CTX_TIMESTAMP_RESULT_FIELD_INDEX`

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, WINDOW_OPERATOR

Constructor Summary

Constructors
Constructor	Description
`GroupByQuery(DataSource dataSource, QuerySegmentSpec querySegmentSpec, VirtualColumns virtualColumns, DimFilter dimFilter, Granularity granularity, List<DimensionSpec> dimensions, List<AggregatorFactory> aggregatorSpecs, List<PostAggregator> postAggregatorSpecs, HavingSpec havingSpec, LimitSpec limitSpec, List<List<String>> subtotalsSpec, Map<String,Object> context)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static GroupByQuery.Builder`	`builder()`
`boolean`	`equals(Object o)`
`List<AggregatorFactory>`	`getAggregatorSpecs()`
`boolean`	`getApplyLimitPushDownFromContext()`
`boolean`	`getContextSortByDimsFirst()`
`List<DimensionSpec>`	`getDimensions()`
`DimFilter`	`getDimFilter()`
`DimFilter`	`getFilter()`
`HavingSpec`	`getHavingSpec()`
`LimitSpec`	`getLimitSpec()`
`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`	`getResultOrdering()`	Default implementation of `Query.getResultOrdering()` that uses `Ordering.natural()`.
`int`	`getResultRowAggregatorStart()`	Returns the position of the first aggregator in ResultRows for this query.
`int`	`getResultRowDimensionStart()`	Returns the position of the first dimension in ResultRows for this query.
`boolean`	`getResultRowHasTimestamp()`	Returns true if ResultRows for this query include timestamps, false otherwise.
`int`	`getResultRowPostAggregatorStart()`	Returns the position of the first post-aggregator in ResultRows for this query.
`RowSignature`	`getResultRowSignature()`	Equivalent to `getResultRowSignature(Finalization.UNKNOWN)`.
`RowSignature`	`getResultRowSignature(RowSignature.Finalization finalization)`	Returns a result row signature, of the same size as `getResultRowSizeWithPostAggregators()`, in the order that they will appear in ResultRows for this query.
`int`	`getResultRowSizeWithoutPostAggregators()`	Returns the size of ResultRows for this query when they do not include post-aggregators.
`int`	`getResultRowSizeWithPostAggregators()`	Returns the size of ResultRows for this query when they include post-aggregators.
`com.google.common.collect.Ordering<ResultRow>`	`getRowOrdering(boolean granular)`
`List<List<String>>`	`getSubtotalsSpec()`	Subtotals spec may be empty which has a distinct meaning from `null`.
`String`	`getType()`
`org.joda.time.DateTime`	`getUniversalTimestamp()`	If this query has a single universal timestamp, return it.
`VirtualColumns`	`getVirtualColumns()`
`boolean`	`hasFilters()`
`int`	`hashCode()`
`boolean`	`isApplyLimitPushDown()`
`Sequence<ResultRow>`	`postProcess(Sequence<ResultRow> results)`	Apply the havingSpec and limitSpec.
`String`	`toString()`
`GroupByQuery`	`withAggregatorSpecs(List<AggregatorFactory> aggregatorSpecs)`
`Query<ResultRow>`	`withDataSource(DataSource dataSource)`
`GroupByQuery`	`withDimensionSpecs(List<DimensionSpec> dimensionSpecs)`
`GroupByQuery`	`withDimFilter(DimFilter dimFilter)`
`GroupByQuery`	`withLimitSpec(LimitSpec limitSpec)`
`GroupByQuery`	`withOverriddenContext(Map<String,Object> contextOverride)`
`GroupByQuery`	`withPostAggregatorSpecs(List<PostAggregator> postAggregatorSpecs)`
`GroupByQuery`	`withQuerySegmentSpec(QuerySegmentSpec spec)`	Returns a new query, identical to this one, but with a different associated `QuerySegmentSpec`.
`GroupByQuery`	`withSubtotalsSpec(List<List<String>> subtotalsSpec)`
`GroupByQuery`	`withVirtualColumns(VirtualColumns virtualColumns)`

Methods inherited from class org.apache.druid.query.BaseQuery
checkInterrupted, computeOverriddenContext, computeOverridenContext, context, getContext, getDataSource, getDuration, getGranularity, getId, getIntervals, getQuerySegmentSpec, getQuerySegmentSpecForLookUp, getRunner, getSubQueryId, getTimezone, isDescending, 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, getSqlQueryId, optimizeForSegment, withDefaultSubQueryId, withLane, withPriority

- Field Detail
  - CTX_KEY_SORT_BY_DIMS_FIRST
```
public static final String CTX_KEY_SORT_BY_DIMS_FIRST
```
    See Also:
    
    Constant Field Values
  - CTX_TIMESTAMP_RESULT_FIELD
```
public static final String CTX_TIMESTAMP_RESULT_FIELD
```
    See Also:
    
    Constant Field Values
  - CTX_TIMESTAMP_RESULT_FIELD_GRANULARITY
```
public static final String CTX_TIMESTAMP_RESULT_FIELD_GRANULARITY
```
    See Also:
    
    Constant Field Values
  - CTX_TIMESTAMP_RESULT_FIELD_INDEX
```
public static final String CTX_TIMESTAMP_RESULT_FIELD_INDEX
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - GroupByQuery
```
public GroupByQuery(DataSource dataSource,
                    QuerySegmentSpec querySegmentSpec,
                    VirtualColumns virtualColumns,
                    @Nullable
                    DimFilter dimFilter,
                    Granularity granularity,
                    List<DimensionSpec> dimensions,
                    List<AggregatorFactory> aggregatorSpecs,
                    List<PostAggregator> postAggregatorSpecs,
                    @Nullable
                    HavingSpec havingSpec,
                    @Nullable
                    LimitSpec limitSpec,
                    @Nullable
                    List<List<String>> subtotalsSpec,
                    Map<String,Object> context)
```
- Method Detail
  - builder
```
public static GroupByQuery.Builder builder()
```
  - getVirtualColumns
```
public VirtualColumns getVirtualColumns()
```
  - getDimFilter
```
@Nullable
public DimFilter getDimFilter()
```
  - getDimensions
```
public List<DimensionSpec> getDimensions()
```
  - getAggregatorSpecs
```
public List<AggregatorFactory> getAggregatorSpecs()
```
  - getPostAggregatorSpecs
```
public List<PostAggregator> getPostAggregatorSpecs()
```
  - getHavingSpec
```
public HavingSpec getHavingSpec()
```
  - getLimitSpec
```
public LimitSpec getLimitSpec()
```
  - getSubtotalsSpec
```
@Nullable
public List<List<String>> getSubtotalsSpec()
```
    Subtotals spec may be empty which has a distinct meaning from null.
  - getResultRowSignature
```
public RowSignature getResultRowSignature()
```
    Equivalent to getResultRowSignature(Finalization.UNKNOWN).
    
    See Also:
    
    for documentation about the order that fields will be in
  - getResultRowSignature
```
public RowSignature getResultRowSignature(RowSignature.Finalization finalization)
```
    Returns a result row signature, of the same size as getResultRowSizeWithPostAggregators(), in the order that they will appear in ResultRows for this query. Aggregator types in the signature depend on the value of finalization. If finalization is RowSignature.Finalization.UNKNOWN, this method returns a cached object.
    
    See Also:
    
    for documentation about the order that fields will be in
  - getResultRowSizeWithoutPostAggregators
```
public int getResultRowSizeWithoutPostAggregators()
```
    Returns the size of ResultRows for this query when they do not include post-aggregators.
  - getResultRowSizeWithPostAggregators
```
public int getResultRowSizeWithPostAggregators()
```
    Returns the size of ResultRows for this query when they include post-aggregators.
  - getUniversalTimestamp
```
@Nullable
public org.joda.time.DateTime getUniversalTimestamp()
```
    If this query has a single universal timestamp, return it. Otherwise return null. If BaseQuery.getIntervals() is empty, there are no results (or timestamps) so this method returns null. This method will return a nonnull timestamp in the following two cases: 1) CTX_KEY_FUDGE_TIMESTAMP is set (in which case this timestamp will be returned). 2) Granularity is "ALL". If this method returns null, then getResultRowHasTimestamp() will return true. The reverse is also true: if this method returns nonnull, then getResultRowHasTimestamp() will return false.
  - getResultRowHasTimestamp
```
public boolean getResultRowHasTimestamp()
```
    Returns true if ResultRows for this query include timestamps, false otherwise.
    
    See Also:
    
    for details about when timestamps are included in ResultRows
  - getResultRowDimensionStart
```
public int getResultRowDimensionStart()
```
    Returns the position of the first dimension in ResultRows for this query.
  - getResultRowAggregatorStart
```
public int getResultRowAggregatorStart()
```
    Returns the position of the first aggregator in ResultRows for this query.
  - getResultRowPostAggregatorStart
```
public int getResultRowPostAggregatorStart()
```
    Returns the position of the first post-aggregator in ResultRows for this query.
  - hasFilters
```
public boolean hasFilters()
```
  - getFilter
```
@Nullable
public DimFilter getFilter()
```
  - getType
```
public String getType()
```
  - getContextSortByDimsFirst
```
public boolean getContextSortByDimsFirst()
```
  - isApplyLimitPushDown
```
public boolean isApplyLimitPushDown()
```
  - getApplyLimitPushDownFromContext
```
public boolean getApplyLimitPushDownFromContext()
```
  - getResultOrdering
```
public com.google.common.collect.Ordering 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<ResultRow>
    
    Overrides:
    
    getResultOrdering in class BaseQuery<ResultRow>
  - getRowOrdering
```
public com.google.common.collect.Ordering<ResultRow> getRowOrdering(boolean granular)
```
  - postProcess
```
public Sequence<ResultRow> postProcess(Sequence<ResultRow> results)
```
    Apply the havingSpec and limitSpec. Because havingSpecs are not thread safe, and because they are applied during accumulation of the returned sequence, callers must take care to avoid accumulating two different Sequences returned by this method in two different threads.
    
    Parameters:
    
    results - sequence of rows to apply havingSpec and limitSpec to
    
    Returns:
    
    sequence of rows after applying havingSpec and limitSpec
  - 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.
  - withOverriddenContext
```
public GroupByQuery withOverriddenContext(Map<String,Object> contextOverride)
```
  - withQuerySegmentSpec
```
public GroupByQuery withQuerySegmentSpec(QuerySegmentSpec spec)
```
    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).
  - withVirtualColumns
```
public GroupByQuery withVirtualColumns(VirtualColumns virtualColumns)
```
  - withDimFilter
```
public GroupByQuery withDimFilter(@Nullable
                                  DimFilter dimFilter)
```
  - withDataSource
```
public Query<ResultRow> withDataSource(DataSource dataSource)
```
  - withDimensionSpecs
```
public GroupByQuery withDimensionSpecs(List<DimensionSpec> dimensionSpecs)
```
  - withLimitSpec
```
public GroupByQuery withLimitSpec(LimitSpec limitSpec)
```
  - withAggregatorSpecs
```
public GroupByQuery withAggregatorSpecs(List<AggregatorFactory> aggregatorSpecs)
```
  - withSubtotalsSpec
```
public GroupByQuery withSubtotalsSpec(@Nullable
                                      List<List<String>> subtotalsSpec)
```
  - withPostAggregatorSpecs
```
public GroupByQuery withPostAggregatorSpecs(List<PostAggregator> postAggregatorSpecs)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class BaseQuery<ResultRow>
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class BaseQuery<ResultRow>

Class GroupByQuery

Nested Class Summary

Field Summary

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

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

CTX_KEY_SORT_BY_DIMS_FIRST

CTX_TIMESTAMP_RESULT_FIELD

CTX_TIMESTAMP_RESULT_FIELD_GRANULARITY

CTX_TIMESTAMP_RESULT_FIELD_INDEX

Constructor Detail

GroupByQuery

Method Detail

builder

getVirtualColumns

getDimFilter

getDimensions

getAggregatorSpecs

getPostAggregatorSpecs

getHavingSpec

getLimitSpec

getSubtotalsSpec

getResultRowSignature

getResultRowSignature

getResultRowSizeWithoutPostAggregators

getResultRowSizeWithPostAggregators

getUniversalTimestamp

getResultRowHasTimestamp

getResultRowDimensionStart

getResultRowAggregatorStart

getResultRowPostAggregatorStart

hasFilters

getFilter

getType

getContextSortByDimsFirst

isApplyLimitPushDown

getApplyLimitPushDownFromContext

getResultOrdering

getRowOrdering

postProcess

getRequiredColumns

withOverriddenContext

withQuerySegmentSpec

withVirtualColumns

withDimFilter

withDataSource

withDimensionSpecs

withLimitSpec

withAggregatorSpecs

withSubtotalsSpec

withPostAggregatorSpecs

toString

equals

hashCode