Package org.apache.gravitino.rel.indexes

Interface Index

All Known Implementing Classes:

IndexDTO, Indexes.IndexImpl

@Evolving
public interface Index

The Index interface defines methods for implementing table index columns. Currently, settings for PRIMARY_KEY and UNIQUE_KEY are provided.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Index.IndexType	The enum IndexType defines the type of the index.

Method Summary

Modifier and Type	Method	Description
String[][]	fieldNames()
String	name()
default Map<String,String>	properties()
Index.IndexType	type()

Method Details

type

Index.IndexType type()

Returns:

The type of the index. eg: PRIMARY_KEY and UNIQUE_KEY.

name

String name()

Returns:

The name of the index.

fieldNames

String[][] fieldNames()

Returns:

The field name under the table contained in the index. it is the column names, could be "a.b.c" for nested column, but normally it could only be "a".

properties

default Map<String,String> properties()

Returns:

Extra properties for index configuration