org.apache.calcite.adapter.druid

Class DruidQuery

java.lang.Object

org.apache.calcite.rel.AbstractRelNode

org.apache.calcite.adapter.druid.DruidQuery

All Implemented Interfaces:

Cloneable, BindableRel, InterpretableRel, RelOptNode, RelNode, ArrayBindable, Bindable<Object[]>, Typed

public class DruidQuery
extends AbstractRelNode
implements BindableRel

Relational expression representing a scan of a Druid data set.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	DruidQuery.DruidQueryNode Interpreter node that executes a Druid query and sends the results to a Sink.
private static interface	DruidQuery.Json Object that knows how to write itself to a JsonGenerator.
private static class	DruidQuery.JsonAggregation Aggregation element of a Druid "groupBy" or "topN" query.
private static class	DruidQuery.JsonBound Bound filter.
private static class	DruidQuery.JsonCardinalityAggregation Aggregation element that calls the "cardinality" function.
private static class	DruidQuery.JsonCollation Collation element of a Druid "groupBy" query.
private static class	DruidQuery.JsonCompositeFilter Filter that combines other filters using a boolean operator.
private static class	DruidQuery.JsonFilter Filter element of a Druid "groupBy" or "topN" query.
private static class	DruidQuery.JsonLimit Collation element of a Druid "groupBy" query.
private static class	DruidQuery.JsonSelector Equality filter.
static class	DruidQuery.QuerySpec Druid query specification.
private static class	DruidQuery.Translator Translates scalar expressions to Druid field references.

Nested classes/interfaces inherited from interface org.apache.calcite.interpreter.InterpretableRel

InterpretableRel.InterpreterImplementor

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DRUID_QUERY_FETCH
(package private) DruidTable	druidTable
(package private) com.google.common.collect.ImmutableList<org.joda.time.Interval>	intervals
protected DruidQuery.QuerySpec	querySpec
(package private) com.google.common.collect.ImmutableList<RelNode>	rels
(package private) RelOptTable	table
private static Pattern	VALID_SIG

Fields inherited from class org.apache.calcite.rel.AbstractRelNode

digest, id, rowType, traitSet

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DruidQuery(RelOptCluster cluster, RelTraitSet traitSet, RelOptTable table, DruidTable druidTable, List<org.joda.time.Interval> intervals, List<RelNode> rels) Creates a DruidQuery.

Method Summary

Modifier and Type	Method and Description
private boolean	areValidFilters(List<RexNode> es)
Enumerable<Object[]>	bind(DataContext dataContext)
RelOptCost	computeSelfCost(RelOptPlanner planner, RelMetadataQuery mq)
RelNode	copy(RelTraitSet traitSet, List<RelNode> inputs)
private static DruidQuery	create(RelOptCluster cluster, RelTraitSet traitSet, RelOptTable table, DruidTable druidTable, List<org.joda.time.Interval> intervals, List<RelNode> rels) Creates a DruidQuery.
static DruidQuery	create(RelOptCluster cluster, RelTraitSet traitSet, RelOptTable table, DruidTable druidTable, List<RelNode> rels) Creates a DruidQuery.
protected DruidQuery.QuerySpec	deriveQuerySpec()
RelDataType	deriveRowType()
RelWriter	explainTerms(RelWriter pw)
static DruidQuery	extendQuery(DruidQuery query, List<org.joda.time.Interval> intervals) Extends a DruidQuery.
static DruidQuery	extendQuery(DruidQuery query, RelNode r) Extends a DruidQuery.
DruidTable	getDruidTable()
Class<Object[]>	getElementType()
protected DruidQuery.JsonAggregation	getJsonAggregation(List<String> fieldNames, String name, AggregateCall aggCall)
protected DruidQuery.QuerySpec	getQuery(RelDataType rowType, RexNode filter, List<RexNode> projects, ImmutableBitSet groupSet, List<AggregateCall> aggCalls, List<String> aggNames, List<Integer> collationIndexes, List<RelFieldCollation.Direction> collationDirections, Integer fetch)
DruidQuery.QuerySpec	getQuerySpec()
String	getQueryString()
QueryType	getQueryType()
RelOptTable	getTable()
TableScan	getTableScan()
RelNode	getTopNode()
Node	implement(InterpretableRel.InterpreterImplementor implementor)
boolean	isValid(Litmus litmus)
(package private) boolean	isValidFilter(RexNode e)
(package private) static boolean	isValidSignature(String signature) Returns whether a signature represents an sequence of relational operators that can be translated into a valid Druid query.
(package private) static String	metadataQuery(String dataSourceName, List<org.joda.time.Interval> intervals) Generates a JSON string to query metadata about a data source.
void	register(RelOptPlanner planner)
(package private) String	signature() Returns a string describing the operations inside this query.
protected static void	writeArray(com.fasterxml.jackson.core.JsonGenerator generator, List<?> elements)
protected static void	writeField(com.fasterxml.jackson.core.JsonGenerator generator, String fieldName, Object o)
protected static void	writeFieldIf(com.fasterxml.jackson.core.JsonGenerator generator, String fieldName, Object o)
protected static void	writeObject(com.fasterxml.jackson.core.JsonGenerator generator, Object o)

Methods inherited from class org.apache.calcite.rel.AbstractRelNode

accept, accept, childrenAccept, collectVariablesSet, collectVariablesUsed, computeDigest, computeSelfCost, estimateRowCount, explain, getChildExps, getCluster, getCollationList, getConvention, getCorrelVariable, getDescription, getDigest, getExpectedInputRowType, getId, getInput, getInputs, getQuery, getRelTypeName, getRows, getRowType, getTraitSet, getVariablesSet, getVariablesStopped, isDistinct, isKey, isValid, metadata, onRegister, recomputeDigest, replaceInput, sole, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.calcite.rel.RelNode

accept, accept, childrenAccept, collectVariablesSet, collectVariablesUsed, computeSelfCost, estimateRowCount, explain, getChildExps, getCollationList, getConvention, getCorrelVariable, getExpectedInputRowType, getInput, getInputs, getQuery, getRelTypeName, getRows, getRowType, getVariablesSet, getVariablesStopped, isDistinct, isKey, isValid, metadata, onRegister, recomputeDigest, replaceInput

Methods inherited from interface org.apache.calcite.plan.RelOptNode

getCluster, getDescription, getDigest, getId, getTraitSet

Field Detail

querySpec

protected DruidQuery.QuerySpec querySpec

table

final RelOptTable table

druidTable

final DruidTable druidTable

intervals

final com.google.common.collect.ImmutableList<org.joda.time.Interval> intervals

rels

final com.google.common.collect.ImmutableList<RelNode> rels

VALID_SIG

private static final Pattern VALID_SIG

DRUID_QUERY_FETCH

protected static final String DRUID_QUERY_FETCH

See Also:

Constant Field Values

Constructor Detail

DruidQuery

protected DruidQuery(RelOptCluster cluster,
                     RelTraitSet traitSet,
                     RelOptTable table,
                     DruidTable druidTable,
                     List<org.joda.time.Interval> intervals,
                     List<RelNode> rels)

Creates a DruidQuery.

Parameters:

cluster - Cluster

traitSet - Traits

table - Table

druidTable - Druid table

intervals - Intervals for the query

rels - Internal relational expressions

Method Detail

signature

String signature()

Returns a string describing the operations inside this query.

For example, "sfpal" means TableScan (s) followed by Filter (f) followed by Project (p) followed by Aggregate (a) followed by Sort (l).

See Also:

isValidSignature(String)

isValid

public boolean isValid(Litmus litmus)

Specified by:

isValid in interface RelNode

Overrides:

isValid in class AbstractRelNode

isValidFilter

boolean isValidFilter(RexNode e)

areValidFilters

private boolean areValidFilters(List<RexNode> es)

isValidSignature

static boolean isValidSignature(String signature)

Returns whether a signature represents an sequence of relational operators that can be translated into a valid Druid query.

create

public static DruidQuery create(RelOptCluster cluster,
                                RelTraitSet traitSet,
                                RelOptTable table,
                                DruidTable druidTable,
                                List<RelNode> rels)

Creates a DruidQuery.

create

private static DruidQuery create(RelOptCluster cluster,
                                 RelTraitSet traitSet,
                                 RelOptTable table,
                                 DruidTable druidTable,
                                 List<org.joda.time.Interval> intervals,
                                 List<RelNode> rels)

Creates a DruidQuery.

extendQuery

public static DruidQuery extendQuery(DruidQuery query,
                                     RelNode r)

Extends a DruidQuery.

extendQuery

public static DruidQuery extendQuery(DruidQuery query,
                                     List<org.joda.time.Interval> intervals)

Extends a DruidQuery.

copy

public RelNode copy(RelTraitSet traitSet,
                    List<RelNode> inputs)

Specified by:

copy in interface RelNode

Overrides:

copy in class AbstractRelNode

deriveRowType

public RelDataType deriveRowType()

Overrides:

deriveRowType in class AbstractRelNode

getTableScan

public TableScan getTableScan()

getTopNode

public RelNode getTopNode()

getTable

public RelOptTable getTable()

Specified by:

getTable in interface RelNode

Overrides:

getTable in class AbstractRelNode

getDruidTable

public DruidTable getDruidTable()

explainTerms

public RelWriter explainTerms(RelWriter pw)

Overrides:

explainTerms in class AbstractRelNode

computeSelfCost

public RelOptCost computeSelfCost(RelOptPlanner planner,
                                  RelMetadataQuery mq)

Specified by:

computeSelfCost in interface RelNode

Overrides:

computeSelfCost in class AbstractRelNode

register

public void register(RelOptPlanner planner)

Specified by:

register in interface RelNode

Overrides:

register in class AbstractRelNode

getElementType

public Class<Object[]> getElementType()

Specified by:

getElementType in interface ArrayBindable

Specified by:

getElementType in interface Typed

bind

public Enumerable<Object[]> bind(DataContext dataContext)

Specified by:

bind in interface Bindable<Object[]>

implement

public Node implement(InterpretableRel.InterpreterImplementor implementor)

Specified by:

implement in interface InterpretableRel

getQuerySpec

public DruidQuery.QuerySpec getQuerySpec()

deriveQuerySpec

protected DruidQuery.QuerySpec deriveQuerySpec()

getQueryType

public QueryType getQueryType()

getQueryString

public String getQueryString()

getQuery

protected DruidQuery.QuerySpec getQuery(RelDataType rowType,
                                        RexNode filter,
                                        List<RexNode> projects,
                                        ImmutableBitSet groupSet,
                                        List<AggregateCall> aggCalls,
                                        List<String> aggNames,
                                        List<Integer> collationIndexes,
                                        List<RelFieldCollation.Direction> collationDirections,
                                        Integer fetch)

getJsonAggregation

protected DruidQuery.JsonAggregation getJsonAggregation(List<String> fieldNames,
                                                        String name,
                                                        AggregateCall aggCall)

writeField

protected static void writeField(com.fasterxml.jackson.core.JsonGenerator generator,
                                 String fieldName,
                                 Object o)
                          throws IOException

Throws:

IOException

writeFieldIf

protected static void writeFieldIf(com.fasterxml.jackson.core.JsonGenerator generator,
                                   String fieldName,
                                   Object o)
                            throws IOException

Throws:

IOException

writeArray

protected static void writeArray(com.fasterxml.jackson.core.JsonGenerator generator,
                                 List<?> elements)
                          throws IOException

Throws:

IOException

writeObject

protected static void writeObject(com.fasterxml.jackson.core.JsonGenerator generator,
                                  Object o)
                           throws IOException

Throws:

IOException

metadataQuery

static String metadataQuery(String dataSourceName,
                            List<org.joda.time.Interval> intervals)

Generates a JSON string to query metadata about a data source.