io.picodata.driver.api.metadata

Interface TarantoolSpaceMetadata

All Superinterfaces:

Serializable

All Known Implementing Classes:

TarantoolSpaceMetadataImpl

public interface TarantoolSpaceMetadata
extends Serializable

Method Summary

Modifier and Type	Method and Description
Optional<TarantoolFieldMetadata>	getFieldByName(String fieldName) Get field metadata by name
Optional<TarantoolFieldMetadata>	getFieldByPosition(int fieldPosition) Get field metadata by position
Optional<String>	getFieldNameByPosition(int fieldPosition) Get field name by position
int	getFieldPositionByName(String fieldName) Get field position in space by name starts with 0, or -1 if this field not found in format metadata
int	getOwnerId() Get owner ID
Map<String,TarantoolFieldMetadata>	getSpaceFormatMetadata() Get map with metadata of fields
int	getSpaceId() Get space ID on the Tarantool server
String	getSpaceName() Get space name

Method Detail

getSpaceId

int getSpaceId()

Get space ID on the Tarantool server

Returns:

a number

getOwnerId

int getOwnerId()

Get owner ID

Returns:

a number

getSpaceName

String getSpaceName()

Get space name

Returns:

a non-empty String

getSpaceFormatMetadata

Map<String,TarantoolFieldMetadata> getSpaceFormatMetadata()

Get map with metadata of fields

Returns:

map whose key is field name and value is TarantoolFieldMetadata

getFieldByName

Optional<TarantoolFieldMetadata> getFieldByName(String fieldName)

Get field metadata by name

Parameters:

fieldName - field name

Returns:

field position by name starting with 0, or -1 if this field not found in format metadata

getFieldByPosition

Optional<TarantoolFieldMetadata> getFieldByPosition(int fieldPosition)

Get field metadata by position

Parameters:

fieldPosition - field position starting with 0

Returns:

field name or null if this field not found in format metadata

getFieldPositionByName

int getFieldPositionByName(String fieldName)

Get field position in space by name starts with 0, or -1 if this field not found in format metadata

Parameters:

fieldName - field name

Returns:

field position by name starting with 0, or -1 if this field not found in format metadata

getFieldNameByPosition

Optional<String> getFieldNameByPosition(int fieldPosition)

Get field name by position

Parameters:

fieldPosition - field position starting with 0

Returns:

field name or null if this field not found in format metadata