Package org.apache.gravitino.rel.indexes

Class Indexes

java.lang.Object

org.apache.gravitino.rel.indexes.Indexes

public class Indexes
extends Object

Helper methods to create index to pass into Apache Gravitino.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Indexes.IndexImpl	The user side implementation of the index.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_PRIMARY_KEY_NAME	Name of the default primary key.
static final Index[]	EMPTY_INDEXES	An empty array of indexes.

Method Summary

Modifier and Type	Method	Description
static Index	createMysqlPrimaryKey(String[][] fieldNames)	To create a MySQL primary key, you need to use the default primary key name.
static Index	createMysqlPrimaryKey(String[][] fieldNames, Map<String,String> properties)	To create a MySQL primary key, you need to use the default primary key name.
static Index	of(Index.IndexType indexType, String name, String[][] fieldNames)
static Index	of(Index.IndexType indexType, String name, String[][] fieldNames, Map<String,String> properties)
static Index	primary(String name, String[][] fieldNames)	Create a primary index on columns.
static Index	primary(String name, String[][] fieldNames, Map<String,String> properties)	Create a primary index on columns.
static Index	unique(String name, String[][] fieldNames)	Create a unique index on columns.
static Index	unique(String name, String[][] fieldNames, Map<String,String> properties)	Create a unique index on columns.

Methods inherited from class java.lang.Object

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

Field Details

EMPTY_INDEXES

public static final Index[] EMPTY_INDEXES

An empty array of indexes.

DEFAULT_PRIMARY_KEY_NAME

public static final String DEFAULT_PRIMARY_KEY_NAME

Name of the default primary key. MySQL, ClickHouse, OceanBase and many other databases supports setting the name of the primary key and use it as primary key name.

See Also:

• Constant Field Values

Method Details

unique

public static Index unique(String name,
 String[][] fieldNames)

Create a unique index on columns. Like unique (a) or unique (a, b), for complex like unique

Parameters:

name - The name of the index

fieldNames - The field names under the table contained in the index.

Returns:

The unique index

unique

public static Index unique(String name,
 String[][] fieldNames,
 Map<String,String> properties)

Create a unique index on columns. Like unique (a) or unique (a, b), for complex like unique

Parameters:

name - The name of the index

fieldNames - The field names under the table contained in the index.

properties - Extra properties for index configuration

Returns:

The unique index

createMysqlPrimaryKey

public static Index createMysqlPrimaryKey(String[][] fieldNames)

To create a MySQL primary key, you need to use the default primary key name.

Parameters:

fieldNames - The field names under the table contained in the index.

Returns:

The primary key index

createMysqlPrimaryKey

public static Index createMysqlPrimaryKey(String[][] fieldNames,
 Map<String,String> properties)

To create a MySQL primary key, you need to use the default primary key name.

Parameters:

properties - Extra properties for index configuration

fieldNames - The field names under the table contained in the index.

Returns:

The primary key index

primary

public static Index primary(String name,
 String[][] fieldNames)

Create a primary index on columns. Like primary (a), for complex like primary

Parameters:

name - The name of the index

fieldNames - The field names under the table contained in the index.

Returns:

The primary index

primary

public static Index primary(String name,
 String[][] fieldNames,
 Map<String,String> properties)

Create a primary index on columns. Like primary (a), for complex like primary

Parameters:

name - The name of the index

fieldNames - The field names under the table contained in the index.

properties - Extra properties for index configuration

Returns:

The primary index

of

public static Index of(Index.IndexType indexType,
 String name,
 String[][] fieldNames)

Parameters:

indexType - The type of the index

name - The name of the index

fieldNames - The field names under the table contained in the index.

Returns:

An Index instance with empty properties

of

public static Index of(Index.IndexType indexType,
 String name,
 String[][] fieldNames,
 Map<String,String> properties)

Parameters:

indexType - The type of the index

name - The name of the index

fieldNames - The field names under the table contained in the index.

properties - Extra properties for index configuration

Returns:

The index