alluxio.client.keyvalue

Interface KeyValueSystem

All Known Implementing Classes:

BaseKeyValueSystem

@PublicApi
public interface KeyValueSystem

Client to access or create key-value stores in Alluxio.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	KeyValueSystem.Factory Factory for the KeyValueSystem.

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.

Method Detail

openStore

KeyValueStoreReader openStore(AlluxioURI uri)
                       throws IOException,
                              AlluxioException

Gets a reader to access a key-value store.

Parameters:

uri - AlluxioURI to the store

Returns:

BaseKeyValueStoreReader instance

Throws:

IOException

AlluxioException

createStore

KeyValueStoreWriter createStore(AlluxioURI uri)
                         throws IOException,
                                AlluxioException

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

Parameters:

uri - AlluxioURI to the store

Returns:

BaseKeyValueStoreWriter instance

Throws:

IOException

AlluxioException

renameStore

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

Rename a completed key-value store.

Parameters:

oldUri - the old AlluxioURI to the store

newUri - the new AlluxioURI to the store

Throws:

IOException

AlluxioException

deleteStore

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

Deletes a completed key-value store.

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

mergeStore

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

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.

Parameters:

fromUri - the AlluxioURI to the store to be merged

toUri - the AlluxioURI to the store to be merged to

Throws:

IOException

AlluxioException