org.apache.druid.sql.calcite.rel

Class VirtualColumnRegistry

java.lang.Object

org.apache.druid.sql.calcite.rel.VirtualColumnRegistry

public class VirtualColumnRegistry
extends Object

Provides facilities to create and re-use VirtualColumn definitions for dimensions, filters, and filtered aggregators while constructing a DruidQuery.

Method Summary

Modifier and Type	Method and Description
static VirtualColumnRegistry	create(RowSignature rowSignature, ExprMacroTable macroTable, boolean forceExpressionVirtualColumns)
List<DruidExpression>	findVirtualColumnExpressions(List<String> allColumns) Given a list of column names, find any corresponding VirtualColumn with the same name
List<VirtualColumn>	findVirtualColumns(List<String> allColumns) Deprecated. use findVirtualColumnExpressions(List) instead
Collection<? extends VirtualColumn>	getAllVirtualColumns(List<String> requiredColumns)
RowSignature	getFullRowSignature() Get a signature representing the base signature plus all registered virtual columns.
String	getOrCreateVirtualColumnForExpression(DruidExpression expression, ColumnType typeHint) Get existing or create new VirtualColumn for a given DruidExpression and hinted ColumnType.
String	getOrCreateVirtualColumnForExpression(DruidExpression expression, org.apache.calcite.rel.type.RelDataType typeHint) Get existing or create new VirtualColumn for a given DruidExpression and RelDataType
VirtualColumn	getOrCreateVirtualColumnForExpression(PlannerContext plannerContext, DruidExpression expression, ColumnType valueType) Deprecated. use getOrCreateVirtualColumnForExpression(DruidExpression, ColumnType) instead
VirtualColumn	getOrCreateVirtualColumnForExpression(PlannerContext plannerContext, DruidExpression expression, org.apache.calcite.rel.type.RelDataType dataType) Deprecated. use getOrCreateVirtualColumnForExpression(DruidExpression, RelDataType) instead
VirtualColumn	getVirtualColumn(String virtualColumnName) Get existing virtual column by column name.
String	getVirtualColumnByExpression(DruidExpression expression, org.apache.calcite.rel.type.RelDataType typeHint)
VirtualColumn	getVirtualColumnByExpression(String expression, org.apache.calcite.rel.type.RelDataType type) Deprecated. use getVirtualColumnByExpression(DruidExpression, RelDataType) instead
boolean	isVirtualColumnDefined(String virtualColumnName) Check if a VirtualColumn is defined by column name
void	visitAllSubExpressions(DruidExpression.DruidExpressionShuttle shuttle)

Methods inherited from class java.lang.Object

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

Method Detail

create

public static VirtualColumnRegistry create(RowSignature rowSignature,
                                           ExprMacroTable macroTable,
                                           boolean forceExpressionVirtualColumns)

isVirtualColumnDefined

public boolean isVirtualColumnDefined(String virtualColumnName)

Check if a VirtualColumn is defined by column name

getOrCreateVirtualColumnForExpression

public String getOrCreateVirtualColumnForExpression(DruidExpression expression,
                                                    ColumnType typeHint)

Get existing or create new VirtualColumn for a given DruidExpression and hinted ColumnType.

getOrCreateVirtualColumnForExpression

public String getOrCreateVirtualColumnForExpression(DruidExpression expression,
                                                    org.apache.calcite.rel.type.RelDataType typeHint)

Get existing or create new VirtualColumn for a given DruidExpression and RelDataType

getVirtualColumn

@Nullable
public VirtualColumn getVirtualColumn(String virtualColumnName)

Get existing virtual column by column name.

Returns:

null if a virtual column for the given name does not exist.

getVirtualColumnByExpression

@Nullable
public String getVirtualColumnByExpression(DruidExpression expression,
                                                     org.apache.calcite.rel.type.RelDataType typeHint)

getFullRowSignature

public RowSignature getFullRowSignature()

Get a signature representing the base signature plus all registered virtual columns.

findVirtualColumnExpressions

public List<DruidExpression> findVirtualColumnExpressions(List<String> allColumns)

Given a list of column names, find any corresponding VirtualColumn with the same name

visitAllSubExpressions

public void visitAllSubExpressions(DruidExpression.DruidExpressionShuttle shuttle)

getAllVirtualColumns

public Collection<? extends VirtualColumn> getAllVirtualColumns(List<String> requiredColumns)

findVirtualColumns

@Deprecated
public List<VirtualColumn> findVirtualColumns(List<String> allColumns)

Deprecated. use findVirtualColumnExpressions(List) instead

getOrCreateVirtualColumnForExpression

@Deprecated
public VirtualColumn getOrCreateVirtualColumnForExpression(PlannerContext plannerContext,
                                                                       DruidExpression expression,
                                                                       ColumnType valueType)

Deprecated. use getOrCreateVirtualColumnForExpression(DruidExpression, ColumnType) instead

getOrCreateVirtualColumnForExpression

@Deprecated
public VirtualColumn getOrCreateVirtualColumnForExpression(PlannerContext plannerContext,
                                                                       DruidExpression expression,
                                                                       org.apache.calcite.rel.type.RelDataType dataType)

Deprecated. use getOrCreateVirtualColumnForExpression(DruidExpression, RelDataType) instead

getVirtualColumnByExpression

@Deprecated
 @Nullable
public VirtualColumn getVirtualColumnByExpression(String expression,
                                                                         org.apache.calcite.rel.type.RelDataType type)

Deprecated. use getVirtualColumnByExpression(DruidExpression, RelDataType) instead