alluxio.client.file.cache.store

Class RocksPageStore

java.lang.Object

alluxio.client.file.cache.store.RocksPageStore

All Implemented Interfaces:

PageStore, AutoCloseable

@NotThreadSafe
public class RocksPageStore
extends Object
implements PageStore

A page store implementation which utilizes rocksDB to persist the data. This implementation will not be included to client jar by default to reduce client jar size.

Method Summary

Modifier and Type	Method and Description
void	close()
static RocksPageStore	create(RocksPageStoreOptions options)
void	delete(PageId pageId, long pageSize) Deletes a page from the store.
ReadableByteChannel	get(PageId pageId, int pageOffset) Gets part of a page from the store to the destination channel.
long	getCacheSize()
java.util.stream.Stream<PageInfo>	getPages() Gets a stream of all pages from the page store.
void	put(PageId pageId, byte[] page) Writes a new page from a source channel to the store.

Methods inherited from class java.lang.Object

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

Methods inherited from interface alluxio.client.file.cache.PageStore

create, get, getStorePath, initialize

Method Detail

create

public static RocksPageStore create(RocksPageStoreOptions options)
                             throws IOException

Parameters:

options - options for the rocks page store

Returns:

a new instance of PageStore backed by RocksDB

Throws:

IOException - if I/O error happens

put

public void put(PageId pageId,
                byte[] page)
         throws IOException

Description copied from interface: PageStore

Writes a new page from a source channel to the store.

Specified by:

put in interface PageStore

Parameters:

pageId - page identifier

page - page data

Throws:

IOException

get

public ReadableByteChannel get(PageId pageId,
                               int pageOffset)
                        throws IOException,
                               PageNotFoundException

Description copied from interface: PageStore

Gets part of a page from the store to the destination channel.

Specified by:

get in interface PageStore

Parameters:

pageId - page identifier

pageOffset - offset within page

Returns:

the number of bytes read

Throws:

IOException - when the store fails to read this page

PageNotFoundException - when the page isn't found in the store

delete

public void delete(PageId pageId,
                   long pageSize)
            throws PageNotFoundException

Description copied from interface: PageStore

Deletes a page from the store.

Specified by:

delete in interface PageStore

Parameters:

pageId - page identifier

pageSize - page size in bytes

Throws:

PageNotFoundException - when the page isn't found in the store

close

public void close()

Specified by:

close in interface AutoCloseable

getPages

public java.util.stream.Stream<PageInfo> getPages()

Description copied from interface: PageStore

Gets a stream of all pages from the page store. This stream needs to be closed as it may open IO resources.

Specified by:

getPages in interface PageStore

Returns:

a stream of all pages from page store

getCacheSize

public long getCacheSize()

Specified by:

getCacheSize in interface PageStore

Returns:

an estimated cache size in bytes