org.apache.calcite.adapter.druid

Class DruidTable

java.lang.Object

org.apache.calcite.schema.impl.AbstractTable

org.apache.calcite.adapter.druid.DruidTable

All Implemented Interfaces:

Table, TranslatableTable, Wrapper

public class DruidTable
extends AbstractTable
implements TranslatableTable

Table mapped onto a Druid table.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	DruidTable.MapRelProtoDataType Creates a RelDataType from a map of field names and types.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) com.google.common.collect.ImmutableMap<String,SqlTypeName>	allFields
(package private) com.google.common.collect.ImmutableMap<String,List<ComplexMetric>>	complexMetrics
(package private) String	dataSource
static org.joda.time.Interval	DEFAULT_INTERVAL
static String	DEFAULT_TIMESTAMP_COLUMN
(package private) com.google.common.collect.ImmutableList<org.joda.time.Interval>	intervals
(package private) com.google.common.collect.ImmutableSet<String>	metricFieldNames
(package private) RelProtoDataType	protoRowType
(package private) DruidSchema	schema
(package private) String	timestampFieldName

Constructor Summary

Constructors

Constructor and Description
DruidTable(DruidSchema schema, String dataSource, RelProtoDataType protoRowType, Set<String> metricFieldNames, String timestampFieldName, List<org.joda.time.Interval> intervals, Map<String,List<ComplexMetric>> complexMetrics, Map<String,SqlTypeName> allFields) Creates a Druid table.

Method Summary

Modifier and Type	Method and Description
(package private) static Table	create(DruidSchema druidSchema, String dataSourceName, List<org.joda.time.Interval> intervals, Map<String,SqlTypeName> fieldMap, Set<String> metricNameSet, String timestampColumnName, DruidConnectionImpl connection, Map<String,List<ComplexMetric>> complexMetrics) Creates a DruidTable by using the given DruidConnectionImpl to populate the other parameters.
(package private) static Table	create(DruidSchema druidSchema, String dataSourceName, List<org.joda.time.Interval> intervals, Map<String,SqlTypeName> fieldMap, Set<String> metricNameSet, String timestampColumnName, Map<String,List<ComplexMetric>> complexMetrics) Creates a DruidTable by copying the given parameters.
List<ComplexMetric>	getComplexMetricsFrom(String alias) Returns the list of ComplexMetric that match the given alias if it exists, otherwise returns an empty list, never null
RelDataType	getRowType(RelDataTypeFactory typeFactory)
boolean	isComplexMetric(String alias) Returns true if and only if the given alias is a reference to a registered ComplexMetric
private boolean	isCountDistinct(SqlCall call)
boolean	isMetric(String name)
boolean	isRolledUp(String column)
private boolean	isSupportedPostAggOperation(SqlKind kind)
private boolean	isValidParentKind(SqlNode node)
ComplexMetric	resolveComplexMetric(String alias, AggregateCall call) Returns the appropriate ComplexMetric that is mapped from the given alias if it exists, and is used in the expected context with the given AggregateCall.
boolean	rolledUpColumnValidInsideAgg(String column, SqlCall call, SqlNode parent, CalciteConnectionConfig config)
RelNode	toRel(RelOptTable.ToRelContext context, RelOptTable relOptTable)

Methods inherited from class org.apache.calcite.schema.impl.AbstractTable

getJdbcTableType, getStatistic, unwrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.calcite.schema.Table

getJdbcTableType, getStatistic

Field Detail

DEFAULT_TIMESTAMP_COLUMN

public static final String DEFAULT_TIMESTAMP_COLUMN

See Also:

Constant Field Values

DEFAULT_INTERVAL

public static final org.joda.time.Interval DEFAULT_INTERVAL

schema

final DruidSchema schema

dataSource

final String dataSource

protoRowType

final RelProtoDataType protoRowType

metricFieldNames

final com.google.common.collect.ImmutableSet<String> metricFieldNames

intervals

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

timestampFieldName

final String timestampFieldName

complexMetrics

final com.google.common.collect.ImmutableMap<String,List<ComplexMetric>> complexMetrics

allFields

final com.google.common.collect.ImmutableMap<String,SqlTypeName> allFields

Constructor Detail

DruidTable

public DruidTable(DruidSchema schema,
                  String dataSource,
                  RelProtoDataType protoRowType,
                  Set<String> metricFieldNames,
                  String timestampFieldName,
                  List<org.joda.time.Interval> intervals,
                  Map<String,List<ComplexMetric>> complexMetrics,
                  Map<String,SqlTypeName> allFields)

Creates a Druid table.

Parameters:

schema - Druid schema that contains this table

dataSource - Druid data source name

protoRowType - Field names and types

metricFieldNames - Names of fields that are metrics

intervals - Default interval if query does not constrain the time, or null

timestampFieldName - Name of the column that contains the time

Method Detail

create

static Table create(DruidSchema druidSchema,
                    String dataSourceName,
                    List<org.joda.time.Interval> intervals,
                    Map<String,SqlTypeName> fieldMap,
                    Set<String> metricNameSet,
                    String timestampColumnName,
                    DruidConnectionImpl connection,
                    Map<String,List<ComplexMetric>> complexMetrics)

Creates a DruidTable by using the given DruidConnectionImpl to populate the other parameters. The parameters may be partially populated.

Parameters:

druidSchema - Druid schema

dataSourceName - Data source name in Druid, also table name

intervals - Intervals, or null to use default

fieldMap - Partially populated map of fields (dimensions plus metrics)

metricNameSet - Partially populated set of metric names

timestampColumnName - Name of timestamp column, or null

connection - Connection used to find column definitions; Must be non-null

complexMetrics - List of complex metrics in Druid (thetaSketch, hyperUnique)

Returns:

A table

create

static Table create(DruidSchema druidSchema,
                    String dataSourceName,
                    List<org.joda.time.Interval> intervals,
                    Map<String,SqlTypeName> fieldMap,
                    Set<String> metricNameSet,
                    String timestampColumnName,
                    Map<String,List<ComplexMetric>> complexMetrics)

Creates a DruidTable by copying the given parameters.

Parameters:

druidSchema - Druid schema

dataSourceName - Data source name in Druid, also table name

intervals - Intervals, or null to use default

fieldMap - Fully populated map of fields (dimensions plus metrics)

metricNameSet - Fully populated set of metric names

timestampColumnName - Name of timestamp column, or null

complexMetrics - List of complex metrics in Druid (thetaSketch, hyperUnique)

Returns:

A table

resolveComplexMetric

public ComplexMetric resolveComplexMetric(String alias,
                                          AggregateCall call)

Returns the appropriate ComplexMetric that is mapped from the given alias if it exists, and is used in the expected context with the given AggregateCall. Otherwise returns null.

isRolledUp

public boolean isRolledUp(String column)

Specified by:

isRolledUp in interface Table

Overrides:

isRolledUp in class AbstractTable

rolledUpColumnValidInsideAgg

public boolean rolledUpColumnValidInsideAgg(String column,
                                            SqlCall call,
                                            SqlNode parent,
                                            CalciteConnectionConfig config)

Specified by:

rolledUpColumnValidInsideAgg in interface Table

Overrides:

rolledUpColumnValidInsideAgg in class AbstractTable

isValidParentKind

private boolean isValidParentKind(SqlNode node)

isCountDistinct

private boolean isCountDistinct(SqlCall call)

isSupportedPostAggOperation

private boolean isSupportedPostAggOperation(SqlKind kind)

getComplexMetricsFrom

public List<ComplexMetric> getComplexMetricsFrom(String alias)

Returns the list of ComplexMetric that match the given alias if it exists, otherwise returns an empty list, never null

isComplexMetric

public boolean isComplexMetric(String alias)

Returns true if and only if the given alias is a reference to a registered ComplexMetric

getRowType

public RelDataType getRowType(RelDataTypeFactory typeFactory)

Specified by:

getRowType in interface Table

toRel

public RelNode toRel(RelOptTable.ToRelContext context,
                     RelOptTable relOptTable)

Specified by:

toRel in interface TranslatableTable

isMetric

public boolean isMetric(String name)