Package org.apache.gravitino.rel.indexes

Enum Class Index.IndexType

java.lang.Object

java.lang.Enum<Index.IndexType>

org.apache.gravitino.rel.indexes.Index.IndexType

All Implemented Interfaces:

Serializable, Comparable<Index.IndexType>, Constable

Enclosing interface:

Index

public static enum Index.IndexType
extends Enum<Index.IndexType>

The enum IndexType defines the type of the index. Currently, PRIMARY_KEY and UNIQUE_KEY are supported.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BITMAP	Bitmap index is a type of database index that uses bit arrays (bitmaps) to represent the presence or absence of values in a column, enabling efficient querying and data retrieval.
BTREE	BTREE index is a balanced tree data structure that maintains sorted data and allows for logarithmic time complexity for search, insert, and delete operations.
DATA_SKIPPING_BLOOM_FILTER	Bloom filter data skipping index
DATA_SKIPPING_MINMAX	minmax data skipping index
INVERTED	INVERTED index is a data structure used to optimize full-text searches by mapping terms to their locations within a dataset, allowing for quick retrieval of documents containing specific words or phrases.
IVF_FLAT	IVF_FLAT (Inverted File with Flat quantization) is an indexing method used for efficient
IVF_HNSW_PQ	IVF_HNSW_PQ
IVF_HNSW_SQ	IVF_HNSW_FLAT
IVF_PQ	IVF_PQ (Inverted File with Product Quantization) is an indexing method used for efficient
IVF_SQ	IVF_SQ (Inverted File with Scalar Quantization) is an indexing method used for efficient
LABEL_LIST	LABEL_LIST index is used to optimize searches on columns containing lists of labels or tags.
PRIMARY_KEY	PRIMARY KEY index in a relational database is a field or a combination of fields that uniquely identifies each record in a table.
SCALAR	SCALAR index is used to optimize searches on scalar data types such as integers, floats, strings, etc.
UNIQUE_KEY	UNIQUE KEY in a relational database is a field or a combination of fields that ensures each record in a table has a distinct value or combination of values.
VECTOR	VECTOR index is used to optimize similarity searches in high-dimensional vector spaces.

Method Summary

Modifier and Type	Method	Description
static Index.IndexType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Index.IndexType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PRIMARY_KEY

public static final Index.IndexType PRIMARY_KEY

PRIMARY KEY index in a relational database is a field or a combination of fields that uniquely identifies each record in a table. It serves as a unique identifier for each row, ensuring that no two rows have the same key. The PRIMARY KEY is used to establish relationships between tables and enforce the entity integrity of a database. Additionally, it helps in indexing and organizing the data for efficient retrieval and maintenance.

UNIQUE_KEY

public static final Index.IndexType UNIQUE_KEY

UNIQUE KEY in a relational database is a field or a combination of fields that ensures each record in a table has a distinct value or combination of values. Unlike a primary key, a UNIQUE KEY allows for the presence of null values, but it still enforces the constraint that no two records can have the same unique key value(s). UNIQUE KEYs are used to maintain data integrity by preventing duplicate entries in specific columns, and they can be applied to columns that are not designated as the primary key. The uniqueness constraint imposed by UNIQUE KEY helps in avoiding redundancy and ensuring data accuracy in the database.

SCALAR

public static final Index.IndexType SCALAR

SCALAR index is used to optimize searches on scalar data types such as integers, floats, strings, etc. Currently, this type is only applicable to Lance.

BTREE

public static final Index.IndexType BTREE

BTREE index is a balanced tree data structure that maintains sorted data and allows for logarithmic time complexity for search, insert, and delete operations. Currently, this type is only applicable to Lance.

BITMAP

public static final Index.IndexType BITMAP

Bitmap index is a type of database index that uses bit arrays (bitmaps) to represent the presence or absence of values in a column, enabling efficient querying and data retrieval. Currently, this type is only applicable to Lance.

LABEL_LIST

public static final Index.IndexType LABEL_LIST

LABEL_LIST index is used to optimize searches on columns containing lists of labels or tags. Currently, this type is only applicable to Lance.

INVERTED

public static final Index.IndexType INVERTED

INVERTED index is a data structure used to optimize full-text searches by mapping terms to their locations within a dataset, allowing for quick retrieval of documents containing specific words or phrases. Currently, this type is only applicable to Lance.

VECTOR

public static final Index.IndexType VECTOR

VECTOR index is used to optimize similarity searches in high-dimensional vector spaces. Currently, this type is only applicable to Lance.

IVF_FLAT

public static final Index.IndexType IVF_FLAT

IVF_FLAT (Inverted File with Flat quantization) is an indexing method used for efficient

IVF_SQ

public static final Index.IndexType IVF_SQ

IVF_SQ (Inverted File with Scalar Quantization) is an indexing method used for efficient

IVF_PQ

public static final Index.IndexType IVF_PQ

IVF_PQ (Inverted File with Product Quantization) is an indexing method used for efficient

IVF_HNSW_SQ

public static final Index.IndexType IVF_HNSW_SQ

IVF_HNSW_FLAT

IVF_HNSW_PQ

public static final Index.IndexType IVF_HNSW_PQ

IVF_HNSW_PQ

DATA_SKIPPING_MINMAX

public static final Index.IndexType DATA_SKIPPING_MINMAX

minmax data skipping index

DATA_SKIPPING_BLOOM_FILTER

public static final Index.IndexType DATA_SKIPPING_BLOOM_FILTER

Bloom filter data skipping index

Method Details

values

public static Index.IndexType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Index.IndexType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null