org.apache.tephra.hbase.txprune

Class InvalidListPruningDebugTool

java.lang.Object

org.apache.tephra.hbase.txprune.InvalidListPruningDebugTool

All Implemented Interfaces:

InvalidListPruningDebug

public class InvalidListPruningDebugTool
extends Object
implements InvalidListPruningDebug

Invalid List Pruning Debug Tool.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InvalidListPruningDebugTool.RegionPruneInfoPretty Wrapper class around RegionPruneInfo to print human readable dates for timestamps.

Constructor Summary

Constructors

Constructor and Description
InvalidListPruningDebugTool()

Method Summary

Modifier and Type	Method and Description
void	destroy() Called once at the end to clean up the resources.
SortedSet<InvalidListPruningDebugTool.RegionPruneInfoPretty>	getIdleRegions(Integer numRegions, String time) Return a list of RegionPruneInfo.
InvalidListPruningDebugTool.RegionPruneInfoPretty	getRegionPruneInfo(String regionId) Return the prune upper bound value of a given region.
RegionsAtTime	getRegionsOnOrBeforeTime(String timeString)
Set<String>	getRegionsToBeCompacted(Integer numRegions, String time) Returns a set of regions that are live but are not empty nor have a prune upper bound recorded.
void	initialize(org.apache.hadoop.conf.Configuration conf) Initialize the Invalid List Debug Tool.
static void	main(String[] args)

Methods inherited from class java.lang.Object

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

Constructor Detail

InvalidListPruningDebugTool

public InvalidListPruningDebugTool()

Method Detail

initialize

public void initialize(org.apache.hadoop.conf.Configuration conf)
                throws IOException

Initialize the Invalid List Debug Tool.

Specified by:

initialize in interface InvalidListPruningDebug

Parameters:

conf - Configuration

Throws:

IOException - when not able to create an HBase connection

destroy

public void destroy()
             throws IOException

Description copied from interface: InvalidListPruningDebug

Called once at the end to clean up the resources.

Specified by:

destroy in interface InvalidListPruningDebug

Throws:

IOException - when not able to clean up resources.

getRegionsToBeCompacted

public Set<String> getRegionsToBeCompacted(Integer numRegions,
                                           String time)
                                    throws IOException

Returns a set of regions that are live but are not empty nor have a prune upper bound recorded. These regions will stop the progress of pruning.

Note that this can return false positives in the following case - At time 't' empty regions were recorded, and time 't+1' prune iteration was invoked. Since a new set of regions was recorded at time 't+1', all regions recorded as empty before time 't + 1' will now be reported as blocking the pruning, even though they are empty. This is because we cannot tell if those regions got any new data between time 't' and 't + 1'.

Specified by:

getRegionsToBeCompacted in interface InvalidListPruningDebug

Parameters:

numRegions - number of regions

time - time in milliseconds or relative time, regions recorded before the given time are returned

Returns:

Set of regions that needs to be compacted and flushed

Throws:

IOException

getIdleRegions

public SortedSet<InvalidListPruningDebugTool.RegionPruneInfoPretty> getIdleRegions(Integer numRegions,
                                                                                   String time)
                                                                            throws IOException

Return a list of RegionPruneInfo. These regions are the ones that have the lowest prune upper bounds. If -1 is passed in, all the regions and their prune upper bound will be returned. Note that only the regions that are known to be live will be returned.

Specified by:

getIdleRegions in interface InvalidListPruningDebug

Parameters:

numRegions - number of regions

time - time in milliseconds or relative time, regions recorded before the given time are returned

Returns:

Map of region name and its prune upper bound

Throws:

IOException

getRegionPruneInfo

@Nullable
public InvalidListPruningDebugTool.RegionPruneInfoPretty getRegionPruneInfo(String regionId)
                                                                               throws IOException

Return the prune upper bound value of a given region. If no prune upper bound has been written for this region yet, it will return a null.

Specified by:

getRegionPruneInfo in interface InvalidListPruningDebug

Parameters:

regionId - region id

Returns:

RegionPruneInfo of the region

Throws:

IOException - if there are any errors while trying to fetch the RegionPruneInfo

getRegionsOnOrBeforeTime

public RegionsAtTime getRegionsOnOrBeforeTime(String timeString)
                                       throws IOException

Specified by:

getRegionsOnOrBeforeTime in interface InvalidListPruningDebug

Parameters:

timeString - Given a time, provide the TimeRegions at or before that time. Time can be in milliseconds or relative time.

Returns:

transactional regions that are present at or before the given time

Throws:

IOException - if there are any errors while trying to fetch the TimeRegions

main

public static void main(String[] args)