alluxio.master.metastore.rocks

Class RocksBlockMetaStore

java.lang.Object

alluxio.master.metastore.rocks.RocksBlockMetaStore

All Implemented Interfaces:

Checkpointed, BlockMetaStore, RocksCheckpointed

@ThreadSafe
public class RocksBlockMetaStore
extends Object
implements BlockMetaStore, RocksCheckpointed

Block store backed by RocksDB.

Nested Class Summary

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

BlockMetaStore.Block, BlockMetaStore.Factory

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addLocation(long id, Block.BlockLocation location) Adds a new block location.
void	clear() Removes all metadata from the block store.
void	close() Closes the block store and releases all resources.
Optional<Block.BlockMeta>	getBlock(long id)
CheckpointName	getCheckpointName()
CloseableIterator<BlockMetaStore.Block>	getCloseableIterator() Gets a CloseableIterator over the blocks.
List<Block.BlockLocation>	getLocations(long id) Gets locations for a block.
RocksStore	getRocksStore()
void	putBlock(long id, Block.BlockMeta meta) Adds block metadata to the block store.
void	removeBlock(long id) Removes a block, or does nothing if the block does not exist.
void	removeLocation(long blockId, long workerId) Removes a block location.
long	size()

Methods inherited from class java.lang.Object

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

Methods inherited from interface alluxio.rocks.RocksCheckpointed

restoreFromCheckpoint, restoreFromCheckpoint, writeToCheckpoint, writeToCheckpoint

Constructor Detail

RocksBlockMetaStore

public RocksBlockMetaStore(String baseDir)

Creates and initializes a rocks block store.

Parameters:

baseDir - the base directory in which to store block store metadata

Method Detail

getBlock

public Optional<Block.BlockMeta> getBlock(long id)

Specified by:

getBlock in interface BlockMetaStore

Parameters:

id - a block id

Returns:

the block's metadata, or empty if the block does not exist

putBlock

public void putBlock(long id,
                     Block.BlockMeta meta)

Description copied from interface: BlockMetaStore

Adds block metadata to the block store. If the block already exists, its metadata will be updated to the given metadata.

Specified by:

putBlock in interface BlockMetaStore

Parameters:

id - the block id

meta - the block metadata

removeBlock

public void removeBlock(long id)

Description copied from interface: BlockMetaStore

Removes a block, or does nothing if the block does not exist.

Specified by:

removeBlock in interface BlockMetaStore

Parameters:

id - a block id to remove

clear

public void clear()

Description copied from interface: BlockMetaStore

Removes all metadata from the block store.

Specified by:

clear in interface BlockMetaStore

size

public long size()

Specified by:

size in interface BlockMetaStore

Returns:

size of the block store

close

public void close()

Description copied from interface: BlockMetaStore

Closes the block store and releases all resources.

Specified by:

close in interface BlockMetaStore

getLocations

public List<Block.BlockLocation> getLocations(long id)

Description copied from interface: BlockMetaStore

Gets locations for a block. If the block does not exist or has no locations, an empty list is returned.

Specified by:

getLocations in interface BlockMetaStore

Parameters:

id - a block id

Returns:

the locations of the block

addLocation

public void addLocation(long id,
                        Block.BlockLocation location)

Description copied from interface: BlockMetaStore

Adds a new block location. If the location already exists, this method is a no-op.

Specified by:

addLocation in interface BlockMetaStore

Parameters:

id - a block id

location - a block location

removeLocation

public void removeLocation(long blockId,
                           long workerId)

Description copied from interface: BlockMetaStore

Removes a block location. If the location doesn't exist, this method is a no-op.

Specified by:

removeLocation in interface BlockMetaStore

Parameters:

blockId - a block id

workerId - a worker id

getCloseableIterator

public CloseableIterator<BlockMetaStore.Block> getCloseableIterator()

Description copied from interface: BlockMetaStore

Gets a CloseableIterator over the blocks. The iterator must be closed properly. One option is to follow the below idiom:

   try (CloseableIterator<Block> iter =
       mBlockStore.getCloseableIterator()) {
     while (iter.hasNext()) {
       // take the element and perform operations
     }
   }
 

If the iterator must be passed to other methods, it must be closed at the end of operation or on exceptions. Otherwise there can be a leak!

Specified by:

getCloseableIterator in interface BlockMetaStore

Returns:

a CloseableIterator over the blocks

getRocksStore

public RocksStore getRocksStore()

Specified by:

getRocksStore in interface RocksCheckpointed

Returns:

the RocksStore that will produce a checkpoint

getCheckpointName

public CheckpointName getCheckpointName()

Specified by:

getCheckpointName in interface Checkpointed

Returns:

a name for this checkpointed class