org.apache.drill.exec.planner.index

Class MapRDBIndexDescriptor

java.lang.Object

org.apache.drill.exec.planner.index.DrillIndexDefinition

org.apache.drill.exec.planner.index.AbstractIndexDescriptor

org.apache.drill.exec.planner.index.DrillIndexDescriptor

org.apache.drill.exec.planner.index.MapRDBIndexDescriptor

All Implemented Interfaces:

IndexDefinition, IndexDescriptor

public class MapRDBIndexDescriptor
extends DrillIndexDescriptor

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.drill.exec.planner.index.IndexDefinition

IndexDefinition.IndexType

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<LogicalExpression>	allFields
protected Object	desc
protected MapRDBFunctionalIndexInfo	functionalInfo
protected Set<LogicalExpression>	indexedFields
protected PluginCost	pluginCost

Fields inherited from class org.apache.drill.exec.planner.index.DrillIndexDefinition

allIndexColumns, indexCollationContext, indexColumns, indexName, indexType, nonIndexColumns, nullsDirection, rowKeyColumns, tableName

Constructor Summary

Constructors

Constructor and Description
MapRDBIndexDescriptor(List<LogicalExpression> indexCols, CollationContext indexCollationContext, List<LogicalExpression> nonIndexCols, List<LogicalExpression> rowKeyColumns, String indexName, String tableName, IndexDefinition.IndexType type, Object desc, DbGroupScan scan, org.apache.calcite.rel.RelFieldCollation.NullDirection nullsDirection)

Method Summary

Modifier and Type	Method and Description
boolean	allColumnsIndexed(Collection<LogicalExpression> expressions) Check if this index have all the columns specified in the supplied list of columns indexed
org.apache.calcite.plan.RelOptCost	getCost(IndexProperties indexProps, org.apache.calcite.plan.RelOptPlanner planner, int numProjectedFields, GroupScan primaryTableGroupScan) Get the total cost of index access (I/O, CPU) in the context of the current query
FunctionalIndexInfo	getFunctionalInfo() Get the functional index information associated with this index (Functional indexes are indexes involving expressions e.g CAST(a as INT).
Object	getOriginalDesc()
PluginCost	getPluginCostModel() Get the costing factors associated with the storage/format plugin
boolean	isCoveringIndex(List<LogicalExpression> expressions) Check if this index 'covers' all the columns specified in the supplied list of columns
boolean	someColumnsIndexed(Collection<LogicalExpression> columns) Check if this index has some columns specified in the supplied list of columns indexed

Methods inherited from class org.apache.drill.exec.planner.index.DrillIndexDescriptor

getDrillTable, getIndexGroupScan, getRows, getStorageName, setDrillTable, setStorageName

Methods inherited from class org.apache.drill.exec.planner.index.AbstractIndexDescriptor

isAsyncIndex, supportsFullTextSearch, supportsRowCountStats

Methods inherited from class org.apache.drill.exec.planner.index.DrillIndexDefinition

columnsInIndexFields, equals, getCollation, getCollationMap, getIndexColumnOrdinal, getIndexColumns, getIndexName, getIndexType, getNonIndexColumns, getNullsOrderingDirection, getRowKeyColumns, getTableName, hashCode, pathExactIn, someColumnsInIndexFields, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.drill.exec.planner.index.IndexDefinition

getCollation, getCollationMap, getIndexColumnOrdinal, getIndexColumns, getIndexName, getIndexType, getNonIndexColumns, getNullsOrderingDirection, getRowKeyColumns, getTableName

Field Detail

desc

protected final Object desc

allFields

protected final Set<LogicalExpression> allFields

indexedFields

protected final Set<LogicalExpression> indexedFields

functionalInfo

protected MapRDBFunctionalIndexInfo functionalInfo

pluginCost

protected PluginCost pluginCost

Constructor Detail

MapRDBIndexDescriptor

public MapRDBIndexDescriptor(List<LogicalExpression> indexCols,
                             CollationContext indexCollationContext,
                             List<LogicalExpression> nonIndexCols,
                             List<LogicalExpression> rowKeyColumns,
                             String indexName,
                             String tableName,
                             IndexDefinition.IndexType type,
                             Object desc,
                             DbGroupScan scan,
                             org.apache.calcite.rel.RelFieldCollation.NullDirection nullsDirection)

Method Detail

getOriginalDesc

public Object getOriginalDesc()

isCoveringIndex

public boolean isCoveringIndex(List<LogicalExpression> expressions)

Description copied from interface: IndexDefinition

Check if this index 'covers' all the columns specified in the supplied list of columns

Specified by:

isCoveringIndex in interface IndexDefinition

Overrides:

isCoveringIndex in class DrillIndexDefinition

Returns:

True for covering index, False for non-covering

allColumnsIndexed

public boolean allColumnsIndexed(Collection<LogicalExpression> expressions)

Description copied from interface: IndexDefinition

Check if this index have all the columns specified in the supplied list of columns indexed

Specified by:

allColumnsIndexed in interface IndexDefinition

Overrides:

allColumnsIndexed in class DrillIndexDefinition

Returns:

True if all fields are indexed, False for some or all fields is not indexed

someColumnsIndexed

public boolean someColumnsIndexed(Collection<LogicalExpression> columns)

Description copied from interface: IndexDefinition

Check if this index has some columns specified in the supplied list of columns indexed

Specified by:

someColumnsIndexed in interface IndexDefinition

Overrides:

someColumnsIndexed in class DrillIndexDefinition

Returns:

True if some fields are indexed, False if none of the fields are indexed

getFunctionalInfo

public FunctionalIndexInfo getFunctionalInfo()

Description copied from interface: IndexDescriptor

Get the functional index information associated with this index (Functional indexes are indexes involving expressions e.g CAST(a as INT).

Specified by:

getFunctionalInfo in interface IndexDescriptor

Overrides:

getFunctionalInfo in class DrillIndexDescriptor

getCost

public org.apache.calcite.plan.RelOptCost getCost(IndexProperties indexProps,
                                                  org.apache.calcite.plan.RelOptPlanner planner,
                                                  int numProjectedFields,
                                                  GroupScan primaryTableGroupScan)

Description copied from interface: IndexDescriptor

Get the total cost of index access (I/O, CPU) in the context of the current query

Specified by:

getCost in interface IndexDescriptor

Overrides:

getCost in class AbstractIndexDescriptor

Parameters:

indexProps - properties (metrics) of a single index in the context of current query

planner - Planner instance

numProjectedFields - Number of projected fields

primaryTableGroupScan - Primary table's GroupScan instance

Returns:

a RelOptCost instance representing the total cost

getPluginCostModel

public PluginCost getPluginCostModel()

Description copied from interface: IndexDescriptor

Get the costing factors associated with the storage/format plugin

Specified by:

getPluginCostModel in interface IndexDescriptor

Overrides:

getPluginCostModel in class DrillIndexDescriptor