org.apache.gravitino.rel.indexes

Enum Index.IndexType

java.lang.Object

java.lang.Enum<Index.IndexType>

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Index.IndexType>

Enclosing interface:

Index

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

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
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.
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.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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.

Method Detail

values

public static Index.IndexType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Index.IndexType c : Index.IndexType.values())
    System.out.println(c);

Returns:

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

valueOf

public static Index.IndexType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null