org.apache.arrow.plasma

Interface ObjectStoreLink

All Known Implementing Classes:

PlasmaClient

public interface ObjectStoreLink

Object store interface, which provides the capabilities to put and get raw byte array, and serves.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ObjectStoreLink.ObjectStoreData Tuple for data and metadata stored in Plasma.

Method Summary

Modifier and Type	Method and Description
boolean	contains(byte[] objectId) Check if the object is present and has been sealed in the PlasmaStore.
void	delete(byte[] objectId) Removes object with given objectId from plasma store.
long	evict(long numBytes) Evict some objects to recover given count of bytes.
List<ObjectStoreLink.ObjectStoreData>	get(byte[][] objectIds, int timeoutMs) Get buffer pairs (data & metadata) from the PlasmaStore based on objectIds.
List<byte[]>	get(byte[][] objectIds, int timeoutMs, boolean isMetadata) Get buffers from the PlasmaStore based on objectIds.
default byte[]	get(byte[] objectId, int timeoutMs, boolean isMetadata) Get a buffer from the PlasmaStore based on the objectId.
byte[]	hash(byte[] objectId) Compute the hash of an object in the object store.
List<byte[]>	list() List all objects in the PlasmaStore.
void	put(byte[] objectId, byte[] value, byte[] metadata) Put value in the local plasma store with object ID objectId.
void	release(byte[] objectId) Release the reference of the object.

Method Detail

put

void put(byte[] objectId,
         byte[] value,
         byte[] metadata)
  throws DuplicateObjectException,
         PlasmaOutOfMemoryException

Put value in the local plasma store with object ID objectId.

Parameters:

objectId - The object ID of the value to be put.

value - The value to put in the object store.

metadata - encodes whatever metadata the user wishes to encode.

Throws:

DuplicateObjectException

PlasmaOutOfMemoryException

get

default byte[] get(byte[] objectId,
                   int timeoutMs,
                   boolean isMetadata)

Get a buffer from the PlasmaStore based on the objectId.

Parameters:

objectId - The object ID used to identify the object.

timeoutMs - The number of milliseconds that the get call should block before timing out and returning. Pass -1 if the call should block and 0 if the call should return immediately.

isMetadata - false if get data, otherwise get metadata.

Returns:

A PlasmaBuffer wrapping the object.

get

List<byte[]> get(byte[][] objectIds,
                 int timeoutMs,
                 boolean isMetadata)

Get buffers from the PlasmaStore based on objectIds.

Parameters:

objectIds - List of object IDs used to identify some objects.

timeoutMs - The number of milliseconds that the get call should block before timing out and returning. Pass -1 if the call should block and 0 if the call should return immediately.

isMetadata - false if get data, otherwise get metadata.

Returns:

List of PlasmaBuffers wrapping objects.

get

List<ObjectStoreLink.ObjectStoreData> get(byte[][] objectIds,
                                          int timeoutMs)

Get buffer pairs (data & metadata) from the PlasmaStore based on objectIds.

Parameters:

objectIds - List of object IDs used to identify some objects.

timeoutMs - The number of milliseconds that the get call should block before timing out and returning. Pass -1 if the call should block and 0 if the call should return immediately.

Returns:

List of Pairs of PlasmaBuffer wrapping objects and its metadata.

hash

byte[] hash(byte[] objectId)

Compute the hash of an object in the object store.

Parameters:

objectId - The object ID used to identify the object.

Returns:

A digest byte array contains object's SHA256 hash. null means that the object isn't in the object store.

evict

long evict(long numBytes)

Evict some objects to recover given count of bytes.

Parameters:

numBytes - The number of bytes to attempt to recover.

Returns:

The number of bytes that have been evicted.

release

void release(byte[] objectId)

Release the reference of the object.

Parameters:

objectId - The object ID used to release the reference of the object.

delete

void delete(byte[] objectId)

Removes object with given objectId from plasma store.

Parameters:

objectId - used to identify an object.

contains

boolean contains(byte[] objectId)

Check if the object is present and has been sealed in the PlasmaStore.

Parameters:

objectId - used to identify an object.

list

List<byte[]> list()

List all objects in the PlasmaStore.