alluxio.master.metastore.rocks

Class RocksInodeStore

java.lang.Object

alluxio.master.metastore.rocks.RocksInodeStore

All Implemented Interfaces:

Checkpointed, InodeStore, ReadOnlyInodeStore, RocksCheckpointed, Closeable, AutoCloseable

@ThreadSafe
public class RocksInodeStore
extends Object
implements InodeStore, RocksCheckpointed

File store backed by RocksDB.

Nested Class Summary

Nested classes/interfaces inherited from interface alluxio.master.metastore.InodeStore

InodeStore.Factory, InodeStore.WriteBatch

Constructor Summary

Constructors

Constructor and Description
RocksInodeStore(String baseDir) Creates and initializes a rocks block store.

Method Summary

Modifier and Type	Method and Description
void	addChild(long parentId, String childName, Long childId) Makes an inode the child of the specified parent.
Set<EdgeEntry>	allEdges()
Set<MutableInode<?>>	allInodes()
void	clear() Removes all inodes and edges.
void	close()
InodeStore.WriteBatch	createWriteBatch() Creates a write batch.
CheckpointName	getCheckpointName()
Optional<Inode>	getChild(Long inodeId, String name, ReadOption option)
Optional<Long>	getChildId(Long inodeId, String name, ReadOption option)
CloseableIterator<Long>	getChildIds(Long inodeId, ReadOption option) Returns an iterable for the ids of the children of the given directory.
CloseableIterator<InodeView>	getCloseableIterator() Acquires an iterator to iterate all Inodes in RocksDB.
Pair<org.rocksdb.RocksDB,AtomicReference<org.rocksdb.ColumnFamilyHandle>>	getDBInodeColumn() A testing only method to access the internal objects.
Optional<MutableInode<?>>	getMutable(long id, ReadOption option) Gets a mutable representation of the specified inode.
RocksStore	getRocksStore()
boolean	hasChildren(InodeDirectoryView inode, ReadOption option)
void	remove(Long inodeId) Removes an inode from the inode store.
void	removeChild(long parentId, String name) Removes a child from a parent inode.
boolean	supportsBatchWrite()
String	toStringEntries()
void	writeInode(MutableInode<?> inode) Adds the given inode, or overwrites it if it already exists.

Methods inherited from class java.lang.Object

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

Methods inherited from interface alluxio.master.metastore.InodeStore

addChild, get, getInodePathString, getMutable, remove, removeInodeAndParentEdge, writeNewInode

Methods inherited from interface alluxio.master.metastore.ReadOnlyInodeStore

get, getChild, getChild, getChild, getChildId, getChildId, getChildIds, getChildIds, getChildren, getChildren, getChildren, getChildren, getChildrenFrom, getChildrenPrefix, getChildrenPrefixFrom, hasChildren

Methods inherited from interface alluxio.rocks.RocksCheckpointed

restoreFromCheckpoint, restoreFromCheckpoint, writeToCheckpoint, writeToCheckpoint

Constructor Detail

RocksInodeStore

public RocksInodeStore(String baseDir)

Creates and initializes a rocks block store.

Parameters:

baseDir - the base directory in which to store inode metadata

Method Detail

remove

public void remove(Long inodeId)

Description copied from interface: InodeStore

Removes an inode from the inode store. This does *not* remove the edge leading to the inode. This method requires an inode lock manager read or write lock on the removed inode.

Specified by:

remove in interface InodeStore

Parameters:

inodeId - an inode to remove

writeInode

public void writeInode(MutableInode<?> inode)

Description copied from interface: InodeStore

Adds the given inode, or overwrites it if it already exists. If it is known that the inode is new, prefer InodeStore.writeNewInode(MutableInode). This method requires an inode lock manager read or write lock on the written inode.

Specified by:

writeInode in interface InodeStore

Parameters:

inode - the inode to write

createWriteBatch

public InodeStore.WriteBatch createWriteBatch()

Description copied from interface: InodeStore

Creates a write batch. Not all implementations support this, so callers should first check InodeStore.supportsBatchWrite().

Specified by:

createWriteBatch in interface InodeStore

Returns:

a InodeStore.WriteBatch which can be used to perform a batched write

clear

public void clear()

Description copied from interface: InodeStore

Removes all inodes and edges.

Specified by:

clear in interface InodeStore

addChild

public void addChild(long parentId,
                     String childName,
                     Long childId)

Description copied from interface: InodeStore

Makes an inode the child of the specified parent. This method requires an inode lock manager read or write locks on the added edge.

Specified by:

addChild in interface InodeStore

Parameters:

parentId - the parent id

childName - the child name

childId - the child inode id

removeChild

public void removeChild(long parentId,
                        String name)

Description copied from interface: InodeStore

Removes a child from a parent inode. This method requires an inode lock manager read or write locks on the removed edge.

Specified by:

removeChild in interface InodeStore

Parameters:

parentId - the parent inode id

name - the child name

getMutable

public Optional<MutableInode<?>> getMutable(long id,
                                            ReadOption option)

Description copied from interface: InodeStore

Gets a mutable representation of the specified inode. Mutating the returned inode requires holding an inode lock manager read or write lock on the inode.

Specified by:

getMutable in interface InodeStore

Parameters:

id - an inode id

option - read options

Returns:

the inode with the given id, if it exists

getChildIds

public CloseableIterator<Long> getChildIds(Long inodeId,
                                           ReadOption option)

Description copied from interface: ReadOnlyInodeStore

Returns an iterable for the ids of the children of the given directory.

Specified by:

getChildIds in interface ReadOnlyInodeStore

Parameters:

inodeId - an inode id to list child ids for

option - the options

Returns:

the child ids iterable

getChildId

public Optional<Long> getChildId(Long inodeId,
                                 String name,
                                 ReadOption option)

Specified by:

getChildId in interface ReadOnlyInodeStore

Parameters:

inodeId - an inode id

name - an inode name

option - the options

Returns:

the id of the child of the inode with the given name

getChild

public Optional<Inode> getChild(Long inodeId,
                                String name,
                                ReadOption option)

Specified by:

getChild in interface ReadOnlyInodeStore

Parameters:

inodeId - an inode id

name - an inode name

option - the options

Returns:

the child of the inode with the given name

hasChildren

public boolean hasChildren(InodeDirectoryView inode,
                           ReadOption option)

Specified by:

hasChildren in interface ReadOnlyInodeStore

Parameters:

inode - an inode directory

option - the options

Returns:

whether the inode has any children

allEdges

public Set<EdgeEntry> allEdges()

Specified by:

allEdges in interface ReadOnlyInodeStore

Returns:

all edges in the inode store

allInodes

public Set<MutableInode<?>> allInodes()

Specified by:

allInodes in interface ReadOnlyInodeStore

Returns:

all inodes in the inode store

getCloseableIterator

public CloseableIterator<InodeView> getCloseableIterator()

Acquires an iterator to iterate all Inodes in RocksDB. A shared lock will be acquired when this iterator is created, and released when: 1. This iterator is complete. 2. At each step, the iterator finds the RocksDB is closing and aborts voluntarily. Except tests, this iterator is only used in: 1. AbstractJournalDumper which translates RocksDB checkpoints to a human-readable form.

Returns:

an iterator over stored inodes

supportsBatchWrite

public boolean supportsBatchWrite()

Specified by:

supportsBatchWrite in interface InodeStore

Returns:

whether the inode store implementation supports batch writes

getCheckpointName

public CheckpointName getCheckpointName()

Specified by:

getCheckpointName in interface Checkpointed

Returns:

a name for this checkpointed class

getRocksStore

public RocksStore getRocksStore()

Specified by:

getRocksStore in interface RocksCheckpointed

Returns:

the RocksStore that will produce a checkpoint

close

public void close()

Specified by:

close in interface InodeStore

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

toStringEntries

public String toStringEntries()

Returns:

a newline-delimited string representing the state of the inode store. This is useful for debugging purposes

getDBInodeColumn

public Pair<org.rocksdb.RocksDB,AtomicReference<org.rocksdb.ColumnFamilyHandle>> getDBInodeColumn()

A testing only method to access the internal objects. For simplicity, no thread safety is provided on the escaping objects.

Returns:

the RocksDB objects references the InodesColumn