Package org.apache.drill.exec.planner.index

Class DrillIndexDefinition

java.lang.Object

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

All Implemented Interfaces:

IndexDefinition

Direct Known Subclasses:

AbstractIndexDescriptor

public class DrillIndexDefinition
extends Object
implements IndexDefinition

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	Description
protected final Set<LogicalExpression>	allIndexColumns
protected final CollationContext	indexCollationContext
protected final List<LogicalExpression>	indexColumns	The indexColumns is the list of column(s) on which this index is created.
protected final String	indexName	indexName: name of the index that should be unique within the scope of a table
protected final IndexDefinition.IndexType	indexType
protected final List<LogicalExpression>	nonIndexColumns	nonIndexColumns: the list of columns that are included in the index as 'covering' columns but are not themselves indexed.
protected final org.apache.calcite.rel.RelFieldCollation.NullDirection	nullsDirection
protected final List<LogicalExpression>	rowKeyColumns
protected final String	tableName

Constructor Summary

Constructors

Constructor	Description
DrillIndexDefinition(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	Description
boolean	allColumnsIndexed(Collection<LogicalExpression> columns)	Check if this index have all the columns specified in the supplied list of columns indexed
protected boolean	columnsInIndexFields(Collection<LogicalExpression> columns, Collection<LogicalExpression> indexFields)
boolean	equals(Object o)
org.apache.calcite.rel.RelCollation	getCollation()	Get the collation property (physical ordering) of the index.
Map<LogicalExpression,org.apache.calcite.rel.RelFieldCollation>	getCollationMap()	Get a mapping of the LogicalExpresion/SchemaPath to its field collation - e.g Ascending/Descending, Nulls First/Nulls Last
int	getIndexColumnOrdinal(LogicalExpression path)	Check to see if the field name is an index column and if so return the ordinal position in the index
List<LogicalExpression>	getIndexColumns()	Get the list of columns in the index key.
String	getIndexName()	Get the name of the index
IndexDefinition.IndexType	getIndexType()	Get the type of this index based on IndexDefinition.IndexType
List<LogicalExpression>	getNonIndexColumns()	Get the list of columns that are in the 'included' or 'covered' fields.
org.apache.calcite.rel.RelFieldCollation.NullDirection	getNullsOrderingDirection()	Get the nulls ordering of this index
List<LogicalExpression>	getRowKeyColumns()	Get the list of columns (typically 1 column) that constitute the row key (primary key)
String	getTableName()	Get the name of the table this index is associated with
int	hashCode()
boolean	isCoveringIndex(List<LogicalExpression> columns)	Check if this index 'covers' all the columns specified in the supplied list of columns
boolean	pathExactIn(SchemaPath path, Collection<LogicalExpression> exprs)
boolean	someColumnsIndexed(Collection<LogicalExpression> columns)	Check if this index has some columns specified in the supplied list of columns indexed
protected boolean	someColumnsInIndexFields(Collection<LogicalExpression> columns, Collection<LogicalExpression> indexFields)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

indexColumns

protected final List<LogicalExpression> indexColumns

The indexColumns is the list of column(s) on which this index is created. If there is more than 1 column, the order of the columns is important: index on {a, b} is not the same as index on {b, a} NOTE: the indexed column could be of type columnfamily.column

nonIndexColumns

protected final List<LogicalExpression> nonIndexColumns

nonIndexColumns: the list of columns that are included in the index as 'covering' columns but are not themselves indexed. These are useful for covering indexes where the query request can be satisfied directly by the index and avoid accessing the table altogether.

allIndexColumns

protected final Set<LogicalExpression> allIndexColumns

rowKeyColumns

protected final List<LogicalExpression> rowKeyColumns

indexCollationContext

protected final CollationContext indexCollationContext

indexName

protected final String indexName

indexName: name of the index that should be unique within the scope of a table

tableName

protected final String tableName

indexType

protected final IndexDefinition.IndexType indexType

nullsDirection

protected final org.apache.calcite.rel.RelFieldCollation.NullDirection nullsDirection

Constructor Details

DrillIndexDefinition

public DrillIndexDefinition(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 Details

getIndexColumnOrdinal

public int getIndexColumnOrdinal(LogicalExpression path)

Description copied from interface: IndexDefinition

Check to see if the field name is an index column and if so return the ordinal position in the index

Specified by:

getIndexColumnOrdinal in interface IndexDefinition

Parameters:

path - The field path you want to compare to index column names.

Returns:

Return ordinal of the indexed column if valid, otherwise return -1

isCoveringIndex

public boolean isCoveringIndex(List<LogicalExpression> columns)

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

Parameters:

columns -

Returns:

True for covering index, False for non-covering

allColumnsIndexed

public boolean allColumnsIndexed(Collection<LogicalExpression> columns)

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

Parameters:

columns -

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

Parameters:

columns -

Returns:

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

pathExactIn

public boolean pathExactIn(SchemaPath path,
 Collection<LogicalExpression> exprs)

columnsInIndexFields

protected boolean columnsInIndexFields(Collection<LogicalExpression> columns,
 Collection<LogicalExpression> indexFields)

someColumnsInIndexFields

protected boolean someColumnsInIndexFields(Collection<LogicalExpression> columns,
 Collection<LogicalExpression> indexFields)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getIndexName

public String getIndexName()

Description copied from interface: IndexDefinition

Get the name of the index

Specified by:

getIndexName in interface IndexDefinition

getTableName

public String getTableName()

Description copied from interface: IndexDefinition

Get the name of the table this index is associated with

Specified by:

getTableName in interface IndexDefinition

getIndexType

public IndexDefinition.IndexType getIndexType()

Description copied from interface: IndexDefinition

Get the type of this index based on IndexDefinition.IndexType

Specified by:

getIndexType in interface IndexDefinition

Returns:

one of the values in IndexDefinition.IndexType

getRowKeyColumns

public List<LogicalExpression> getRowKeyColumns()

Description copied from interface: IndexDefinition

Get the list of columns (typically 1 column) that constitute the row key (primary key)

Specified by:

getRowKeyColumns in interface IndexDefinition

Returns:

getIndexColumns

public List<LogicalExpression> getIndexColumns()

Description copied from interface: IndexDefinition

Get the list of columns in the index key.

Specified by:

getIndexColumns in interface IndexDefinition

getNonIndexColumns

public List<LogicalExpression> getNonIndexColumns()

Description copied from interface: IndexDefinition

Get the list of columns that are in the 'included' or 'covered' fields.

Specified by:

getNonIndexColumns in interface IndexDefinition

getCollation

public org.apache.calcite.rel.RelCollation getCollation()

Description copied from interface: IndexDefinition

Get the collation property (physical ordering) of the index.

Specified by:

getCollation in interface IndexDefinition

getCollationMap

public Map<LogicalExpression,org.apache.calcite.rel.RelFieldCollation> getCollationMap()

Description copied from interface: IndexDefinition

Get a mapping of the LogicalExpresion/SchemaPath to its field collation - e.g Ascending/Descending, Nulls First/Nulls Last

Specified by:

getCollationMap in interface IndexDefinition

getNullsOrderingDirection

public org.apache.calcite.rel.RelFieldCollation.NullDirection getNullsOrderingDirection()

Description copied from interface: IndexDefinition

Get the nulls ordering of this index

Specified by:

getNullsOrderingDirection in interface IndexDefinition

Returns:

True, if nulls first. False otherwise