Package org.apache.spark.sql.connector.catalog.index

Class TableIndex

Object

org.apache.spark.sql.connector.catalog.index.TableIndex

@Evolving
public final class TableIndex
extends Object

Index in a table

Since:

3.3.0

Constructor Summary

Constructors

Constructor	Description
TableIndex(String indexName, String indexType, NamedReference[] columns, Map<NamedReference,Properties> columnProperties, Properties properties)

Method Summary

Modifier and Type	Method	Description
Map<NamedReference,Properties>	columnProperties()
NamedReference[]	columns()
String	indexName()
String	indexType()
Properties	properties()	Returns the index properties.

Methods inherited from class java.lang.Object

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

Constructor Details

TableIndex

public TableIndex(String indexName,
 String indexType,
 NamedReference[] columns,
 Map<NamedReference,Properties> columnProperties,
 Properties properties)

Method Details

indexName

public String indexName()

Returns:

the Index name.

indexType

public String indexType()

Returns:

the indexType of this Index.

columns

public NamedReference[] columns()

Returns:

the column(s) this Index is on. Could be multi columns (a multi-column index).

columnProperties

public Map<NamedReference,Properties> columnProperties()

Returns:

the map of column and column property map.

properties

public Properties properties()

Returns the index properties.