alluxio.client.file.cache

Interface PageMetaStore

All Superinterfaces:

CacheStatus

All Known Implementing Classes:

DefaultPageMetaStore, QuotaPageMetaStore

public interface PageMetaStore
extends CacheStatus

The metadata store for pages stored in cache.

Method Summary

Modifier and Type	Method and Description
void	addPage(PageId pageId, PageInfo pageInfo) Adds a new page to the cache.
void	addTempPage(PageId pageId, PageInfo pageInfo) Adds a new temp page to the cache.
PageStoreDir	allocate(String fileId, long fileLength)
long	bytes()
void	commitFile(String fileId, String newFileId) Commits a temp file so that all its pages become permanent.
static PageMetaStore	create(CacheManagerOptions options)
PageInfo	evict(CacheScope cacheScope, PageStoreDir pageStoreDir)
default PageInfo	evict(PageStoreDir pageStoreDir)
Set<PageInfo>	getAllPagesByFileId(String fileId) Gets all pages by the specified File ID.
ReadWriteLock	getLock()
PageInfo	getPageInfo(PageId pageId)
PageStoreDir	getStoreDirOfFile(String fileId) Gets the store dir which the specified file is assigned to be cached in.
List<PageStoreDir>	getStoreDirs() Gets the storage directories.
boolean	hasPage(PageId pageId)
long	numPages()
PageInfo	removePage(PageId pageId) Removes a page.
PageInfo	removePage(PageId pageId, boolean isTemporary) Removes a page.
void	reset() Resets the meta store.

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

getUsage

Method Detail

create

static PageMetaStore create(CacheManagerOptions options)
                     throws IOException

Parameters:

options - the options of cache

Returns:

an instance of MetaStore

Throws:

IOException

getLock

ReadWriteLock getLock()

Returns:

the associated lock

hasPage

boolean hasPage(PageId pageId)

Parameters:

pageId - page identifier

Returns:

if a page is stored in cache

addPage

void addPage(PageId pageId,
             PageInfo pageInfo)

Adds a new page to the cache.

Parameters:

pageId - page identifier

pageInfo - info of the page

addTempPage

void addTempPage(PageId pageId,
                 PageInfo pageInfo)

Adds a new temp page to the cache.

Parameters:

pageId - page identifier

pageInfo - info of the page

commitFile

void commitFile(String fileId,
                String newFileId)
         throws PageNotFoundException

Commits a temp file so that all its pages become permanent.

Parameters:

fileId - the temp file to commit

newFileId - the new file name of the file after committing

Throws:

PageNotFoundException

getStoreDirOfFile

PageStoreDir getStoreDirOfFile(String fileId)
                        throws FileDoesNotExistException

Gets the store dir which the specified file is assigned to be cached in. Implementations should ensure that all pages of the same file are cached in the same directory, until all the pages of the file are evicted.

Parameters:

fileId - the file ID

Returns:

the store dir which caches the pages of the file

Throws:

FileDoesNotExistException - if the file is not being cached

getStoreDirs

List<PageStoreDir> getStoreDirs()

Gets the storage directories.

Returns:

the storage directories

allocate

PageStoreDir allocate(String fileId,
                      long fileLength)

Parameters:

fileId -

fileLength -

Returns:

the storage directory

getPageInfo

PageInfo getPageInfo(PageId pageId)
              throws PageNotFoundException

Parameters:

pageId - page identifier

Returns:

page info

Throws:

PageNotFoundException

removePage

PageInfo removePage(PageId pageId,
                    boolean isTemporary)
             throws PageNotFoundException

Removes a page.

Parameters:

pageId - page identifier

isTemporary - whether is it temporary page or not

Returns:

page info removed

Throws:

PageNotFoundException

removePage

PageInfo removePage(PageId pageId)
             throws PageNotFoundException

Removes a page.

Parameters:

pageId - page identifier

Returns:

page info removed

Throws:

PageNotFoundException

bytes

long bytes()

Returns:

the total size of pages stored in bytes

numPages

long numPages()

Returns:

the number of pages stored

reset

void reset()

Resets the meta store.

getAllPagesByFileId

Set<PageInfo> getAllPagesByFileId(String fileId)

Gets all pages by the specified File ID.

Parameters:

fileId - the target file id

Returns:

a set of PageInfo's of this file, otherwise an empty set if not found

evict

default PageInfo evict(PageStoreDir pageStoreDir)

Parameters:

pageStoreDir -

Returns:

a page to evict

evict

PageInfo evict(CacheScope cacheScope,
               PageStoreDir pageStoreDir)

Parameters:

cacheScope -

pageStoreDir -

Returns:

a page to evict