alluxio.client.keyvalue

Class BaseKeyValueSystem

java.lang.Object

alluxio.client.keyvalue.BaseKeyValueSystem

All Implemented Interfaces:

KeyValueSystem

@PublicApi
 @ThreadSafe
public final class BaseKeyValueSystem
extends Object
implements KeyValueSystem

Default implementation of the KeyValueSystem interface. Developers can extend this class instead of implementing the interface. This implementation reads and writes key-value data through BaseKeyValueStoreReader and BaseKeyValueStoreWriter.

Nested Class Summary

Nested classes/interfaces inherited from interface alluxio.client.keyvalue.KeyValueSystem

KeyValueSystem.Factory

Constructor Summary

Constructors

Constructor and Description
BaseKeyValueSystem() Constructs a new BaseKeyValueSystem.

Method Summary

Modifier and Type	Method and Description
KeyValueStoreWriter	createStore(AlluxioURI uri) Gets a writer to create a new key-value store.
void	deleteStore(AlluxioURI uri) Deletes a completed key-value store.
void	mergeStore(AlluxioURI fromUri, AlluxioURI toUri) Merges one completed key-value store to another completed key-value store.
KeyValueStoreReader	openStore(AlluxioURI uri) Gets a reader to access a key-value store.
void	renameStore(AlluxioURI oldUri, AlluxioURI newUri) Rename a completed key-value store.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseKeyValueSystem

public BaseKeyValueSystem()

Constructs a new BaseKeyValueSystem.

Method Detail

openStore

public KeyValueStoreReader openStore(AlluxioURI uri)
                              throws IOException,
                                     AlluxioException

Description copied from interface: KeyValueSystem

Gets a reader to access a key-value store.

Specified by:

openStore in interface KeyValueSystem

Parameters:

uri - AlluxioURI to the store

Returns:

BaseKeyValueStoreReader instance

Throws:

IOException

AlluxioException

createStore

public KeyValueStoreWriter createStore(AlluxioURI uri)
                                throws IOException,
                                       AlluxioException

Description copied from interface: KeyValueSystem

Gets a writer to create a new key-value store.

Specified by:

createStore in interface KeyValueSystem

Parameters:

uri - AlluxioURI to the store

Returns:

BaseKeyValueStoreWriter instance

Throws:

IOException

AlluxioException

deleteStore

public void deleteStore(AlluxioURI uri)
                 throws IOException,
                        InvalidPathException,
                        FileDoesNotExistException,
                        AlluxioException

Description copied from interface: KeyValueSystem

Deletes a completed key-value store.

Specified by:

deleteStore in interface KeyValueSystem

Parameters:

uri - AlluxioURI to the store

Throws:

InvalidPathException - if the uri exists but is not a key-value store

FileDoesNotExistException - if the uri does not exist

IOException

AlluxioException

renameStore

public void renameStore(AlluxioURI oldUri,
                        AlluxioURI newUri)
                 throws IOException,
                        AlluxioException

Description copied from interface: KeyValueSystem

Rename a completed key-value store.

Specified by:

renameStore in interface KeyValueSystem

Parameters:

oldUri - the old AlluxioURI to the store

newUri - the new AlluxioURI to the store

Throws:

IOException

AlluxioException

mergeStore

public void mergeStore(AlluxioURI fromUri,
                       AlluxioURI toUri)
                throws IOException,
                       AlluxioException

Description copied from interface: KeyValueSystem

Merges one completed key-value store to another completed key-value store. If there are the same keys from both stores, they are merged too, for these keys, whose value will be retrieved is undetermined.

Specified by:

mergeStore in interface KeyValueSystem

Parameters:

fromUri - the AlluxioURI to the store to be merged

toUri - the AlluxioURI to the store to be merged to

Throws:

IOException

AlluxioException