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

Interface SupportsIndex

All Superinterfaces:

Table

@Evolving
public interface SupportsIndex
extends Table

Table methods for working with index

Since:

3.3.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROP_TYPE	A reserved property to specify the index type.

Method Summary

Modifier and Type	Method	Description
void	createIndex(String indexName, NamedReference[] columns, Map<NamedReference,Map<String,String>> columnsProperties, Map<String,String> properties)	Creates an index.
void	dropIndex(String indexName)	Drops the index with the given name.
boolean	indexExists(String indexName)	Checks whether an index exists in this table.
TableIndex[]	listIndexes()	Lists all the indexes in this table.

Methods inherited from interface org.apache.spark.sql.connector.catalog.Table

capabilities, columns, name, partitioning, properties, schema

Field Details

PROP_TYPE

static final String PROP_TYPE

A reserved property to specify the index type.

See Also:

• Constant Field Values

Method Details

createIndex

void createIndex(String indexName,
 NamedReference[] columns,
 Map<NamedReference,Map<String,String>> columnsProperties,
 Map<String,String> properties)
          throws org.apache.spark.sql.catalyst.analysis.IndexAlreadyExistsException

Creates an index.

Parameters:

indexName - the name of the index to be created

columns - the columns on which index to be created

columnsProperties - the properties of the columns on which index to be created

properties - the properties of the index to be created

Throws:

org.apache.spark.sql.catalyst.analysis.IndexAlreadyExistsException - If the index already exists.

dropIndex

void dropIndex(String indexName)
        throws org.apache.spark.sql.catalyst.analysis.NoSuchIndexException

Drops the index with the given name.

Parameters:

indexName - the name of the index to be dropped.

Throws:

org.apache.spark.sql.catalyst.analysis.NoSuchIndexException - If the index does not exist.

indexExists

boolean indexExists(String indexName)

Checks whether an index exists in this table.

Parameters:

indexName - the name of the index

Returns:

true if the index exists, false otherwise

listIndexes

TableIndex[] listIndexes()

Lists all the indexes in this table.