io.picodata.driver.api.metadata

Interface TarantoolIndexMetadata

public interface TarantoolIndexMetadata

Represents Tarantool index metadata (index ID, name, etc.)

Method Summary

Modifier and Type	Method and Description
int	getIndexId() Get index ID in the corresponding space on the Tarantool server
String	getIndexName() Get index name
TarantoolIndexOptions	getIndexOptions() Get index options
Optional<Integer>	getIndexPartPositionByFieldPosition(int fieldPosition) Get map of field positions to index parts positions
List<TarantoolIndexPartMetadata>	getIndexParts() Get index parts
Map<Integer,TarantoolIndexPartMetadata>	getIndexPartsByPosition() Get index parts by field indexes
TarantoolIndexType	getIndexType() Get index type
int	getSpaceId() Get ID of a space that this index is defined on
boolean	isPrimary() Returns true if this is a primary index, false otherwise.
boolean	isUnique() Returns true if this is a unique index, false otherwise.
void	setIndexOptions(TarantoolIndexOptions indexOptions) Set index options
void	setIndexParts(List<TarantoolIndexPartMetadata> indexParts) Set index parts
void	setIndexType(TarantoolIndexType indexType) Set index type

Method Detail

getSpaceId

int getSpaceId()

Get ID of a space that this index is defined on

Returns:

a number

getIndexId

int getIndexId()

Get index ID in the corresponding space on the Tarantool server

Returns:

a natural number

getIndexName

String getIndexName()

Get index name

Returns:

a non-empty String

getIndexType

TarantoolIndexType getIndexType()

Get index type

Returns:

the index type

setIndexType

void setIndexType(TarantoolIndexType indexType)

Set index type

Parameters:

indexType - a non-empty TarantoolIndexType

getIndexOptions

TarantoolIndexOptions getIndexOptions()

Get index options

Returns:

index options

setIndexOptions

void setIndexOptions(TarantoolIndexOptions indexOptions)

Set index options

Parameters:

indexOptions - a not-empty TarantoolIndexOptions

setIndexParts

void setIndexParts(List<TarantoolIndexPartMetadata> indexParts)

Set index parts

Parameters:

indexParts - a not-empty list of TarantoolIndexPartMetadata

getIndexParts

List<TarantoolIndexPartMetadata> getIndexParts()

Get index parts

Returns:

a not-empty list of TarantoolIndexPartMetadata

getIndexPartsByPosition

Map<Integer,TarantoolIndexPartMetadata> getIndexPartsByPosition()

Get index parts by field indexes

Returns:

a not-empty map of index positions to TarantoolIndexPartMetadata

getIndexPartPositionByFieldPosition

Optional<Integer> getIndexPartPositionByFieldPosition(int fieldPosition)

Get map of field positions to index parts positions

Parameters:

fieldPosition - field position in tuple, starting from 0

Returns:

field position

isPrimary

boolean isPrimary()

Returns true if this is a primary index, false otherwise.

Returns:

true if this is a primary index, false otherwise.

isUnique

boolean isUnique()

Returns true if this is a unique index, false otherwise.

Returns:

true if this is a unique index, false otherwise.