com.yahoo.bard.webservice.druid.model.query

Interface DruidAggregationQuery<Q extends DruidAggregationQuery<? super Q>>

Type Parameters:

Q - Type of DruidAggregationQuery this one extends. This allows the queries to nest their own type.

All Superinterfaces:

DruidFactQuery<Q>, DruidQuery<Q>

All Known Implementing Classes:

AbstractDruidAggregationQuery, GroupByQuery, LookbackQuery, SqlAggregationQuery, TemplateDruidQuery, TimeSeriesQuery, TopNQuery, WeightEvaluationQuery

public interface DruidAggregationQuery<Q extends DruidAggregationQuery<? super Q>>
extends DruidFactQuery<Q>

Common interface for Druid Query classes.

Method Summary

Modifier and Type	Method and Description
default Stream<Column>	buildSchemaColumns() Produce the schema-defining columns for a given druid query.
Set<Aggregation>	getAggregations() Returns the aggregations of the query.
default Set<String>	getDependentFieldNames() Retrieves a set of druid metric names associated with the query.
Collection<Dimension>	getDimensions() Returns the dimensions of the query if any.
default DruidAggregationQuery<?>	getInnermostQuery() If this structure is part of a query stack, return the lowest element.
default Optional<? extends DruidAggregationQuery>	getInnerQuery() If this query is nestable, and has a nested query return it.
default Set<Dimension>	getMetricDimensions() Get all the dimensions from Filtered Aggregations of a filtered metric.
Collection<PostAggregation>	getPostAggregations() Returns the post-aggregations of the query.
Q	withAggregations(Collection<Aggregation> aggregations) Returns a copy of this query with the specified aggregations.
Q	withPostAggregations(Collection<PostAggregation> postAggregations) Returns a copy of this query with the specified post aggregations.

Methods inherited from interface com.yahoo.bard.webservice.druid.model.query.DruidFactQuery

getFilter, getGranularity, getIntervals, withAllIntervals, withFilter, withGranularity, withIntervals

Methods inherited from interface com.yahoo.bard.webservice.druid.model.query.DruidQuery

getContext, getDataSource, getQueryType, withContext, withDataSource, withInnermostDataSource

Method Detail

getDependentFieldNames

default Set<String> getDependentFieldNames()

Retrieves a set of druid metric names associated with the query.

Returns:

set of druid metric names

getMetricDimensions

default Set<Dimension> getMetricDimensions()

Get all the dimensions from Filtered Aggregations of a filtered metric.

Returns:

Set of dimensions which are part of Filtered Aggregations in a filtered logical metric

getDimensions

Collection<Dimension> getDimensions()

Returns the dimensions of the query if any.

Returns:

the query dimensions

getAggregations

Set<Aggregation> getAggregations()

Returns the aggregations of the query.

Returns:

the query aggregations

getPostAggregations

Collection<PostAggregation> getPostAggregations()

Returns the post-aggregations of the query.

Returns:

the query post-aggregations

withAggregations

Q withAggregations(Collection<Aggregation> aggregations)

Returns a copy of this query with the specified aggregations.

Parameters:

aggregations - the new aggregations

Returns:

the query copy

withPostAggregations

Q withPostAggregations(Collection<PostAggregation> postAggregations)

Returns a copy of this query with the specified post aggregations.

Parameters:

postAggregations - the new post aggregations

Returns:

the query copy

getInnerQuery

default Optional<? extends DruidAggregationQuery> getInnerQuery()

Description copied from interface: DruidQuery

If this query is nestable, and has a nested query return it.

Specified by:

getInnerQuery in interface DruidFactQuery<Q extends DruidAggregationQuery<? super Q>>

Specified by:

getInnerQuery in interface DruidQuery<Q extends DruidAggregationQuery<? super Q>>

Returns:

the nested query or empty if there is no nested query

getInnermostQuery

default DruidAggregationQuery<?> getInnermostQuery()

Description copied from interface: DruidQuery

If this structure is part of a query stack, return the lowest element.

Specified by:

getInnermostQuery in interface DruidFactQuery<Q extends DruidAggregationQuery<? super Q>>

Specified by:

getInnermostQuery in interface DruidQuery<Q extends DruidAggregationQuery<? super Q>>

Returns:

Return the most nested inner query OR the object itself if it has no children

buildSchemaColumns

default Stream<Column> buildSchemaColumns()

Produce the schema-defining columns for a given druid query.

Returns:

A stream of columns based on the signature of the Druid Query.