org.apache.drill.exec.planner.index

Class DrillIndexDescriptor

java.lang.Object

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

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

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

All Implemented Interfaces:

IndexDefinition, IndexDescriptor

Direct Known Subclasses:

MapRDBIndexDescriptor

public class DrillIndexDescriptor
extends AbstractIndexDescriptor

Nested Class Summary

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

IndexDefinition.IndexType

Field Summary

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
DrillIndexDescriptor(DrillIndexDefinition def)
DrillIndexDescriptor(List<LogicalExpression> indexCols, CollationContext indexCollationContext, List<LogicalExpression> nonIndexCols, List<LogicalExpression> rowKeyColumns, String indexName, String tableName, IndexDefinition.IndexType type, org.apache.calcite.rel.RelFieldCollation.NullDirection nullsDirection)

Method Summary

Modifier and Type	Method and Description
DrillTable	getDrillTable() Get the drill table corresponding to the index descriptor
FunctionalIndexInfo	getFunctionalInfo() Get the functional index information associated with this index (Functional indexes are indexes involving expressions e.g CAST(a as INT).
IndexGroupScan	getIndexGroupScan() Get an instance of the group scan associated with this index descriptor
PluginCost	getPluginCostModel() Get the costing factors associated with the storage/format plugin
double	getRows(org.apache.calcite.rel.RelNode scan, org.apache.calcite.rex.RexNode indexCondition) Get the estimated row count for a single index condition
String	getStorageName() Get storage plugin name for this index descriptor
void	setDrillTable(DrillTable table) Set the drill table corresponding to the index
void	setStorageName(String storageName) Set the storage plugin name

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

getCost, isAsyncIndex, supportsFullTextSearch, supportsRowCountStats

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

allColumnsIndexed, columnsInIndexFields, equals, getCollation, getCollationMap, getIndexColumnOrdinal, getIndexColumns, getIndexName, getIndexType, getNonIndexColumns, getNullsOrderingDirection, getRowKeyColumns, getTableName, hashCode, isCoveringIndex, pathExactIn, someColumnsIndexed, 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

allColumnsIndexed, getCollation, getCollationMap, getIndexColumnOrdinal, getIndexColumns, getIndexName, getIndexType, getNonIndexColumns, getNullsOrderingDirection, getRowKeyColumns, getTableName, isCoveringIndex, someColumnsIndexed

Constructor Detail

DrillIndexDescriptor

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

DrillIndexDescriptor

public DrillIndexDescriptor(DrillIndexDefinition def)

Method Detail

getRows

public double getRows(org.apache.calcite.rel.RelNode scan,
                      org.apache.calcite.rex.RexNode indexCondition)

Description copied from interface: IndexDescriptor

Get the estimated row count for a single index condition

Specified by:

getRows in interface IndexDescriptor

Overrides:

getRows in class AbstractIndexDescriptor

Parameters:

scan - The rel node corresponding to the primary table

indexCondition - The index condition (e.g index_col1 < 10 AND index_col2 = 'abc')

Returns:

The estimated row count

getIndexGroupScan

public IndexGroupScan getIndexGroupScan()

Description copied from interface: IndexDescriptor

Get an instance of the group scan associated with this index descriptor

Specified by:

getIndexGroupScan in interface IndexDescriptor

Overrides:

getIndexGroupScan in class AbstractIndexDescriptor

Returns:

An instance of group scan for this index

setStorageName

public void setStorageName(String storageName)

Set the storage plugin name

Parameters:

storageName -

getStorageName

public String getStorageName()

Get storage plugin name for this index descriptor

Returns:

name of the storage plugin

setDrillTable

public void setDrillTable(DrillTable table)

Set the drill table corresponding to the index

Parameters:

table -

getDrillTable

public DrillTable getDrillTable()

Get the drill table corresponding to the index descriptor

Returns:

instance of DrillTable

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).

getPluginCostModel

public PluginCost getPluginCostModel()

Description copied from interface: IndexDescriptor

Get the costing factors associated with the storage/format plugin