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 and Description
TableIndex(String indexName, String indexType, NamedReference[] columns, java.util.Map<NamedReference,java.util.Properties> columnProperties, java.util.Properties properties)

Method Summary

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

Methods inherited from class Object

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

Constructor Detail

TableIndex

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

Method Detail

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 java.util.Map<NamedReference,java.util.Properties> columnProperties()

Returns:

the map of column and column property map.

properties

public java.util.Properties properties()

Returns the index properties.