org.apache.tephra.txprune.hbase

Interface InvalidListPruningDebug

All Known Implementing Classes:

InvalidListPruningDebugTool

public interface InvalidListPruningDebug

Interface to debug transaction pruning progress.

Method Summary

Modifier and Type	Method and Description
void	destroy() Called once at the end to clean up the resources.
SortedSet<? extends RegionPruneInfo>	getIdleRegions(Integer numRegions, String time) Return a list of RegionPruneInfo.
RegionPruneInfo	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) Called once at the beginning to initialize the instance.

Method Detail

initialize

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

Called once at the beginning to initialize the instance.

Parameters:

conf - Configuration

Throws:

IOException - when not able to initialize.

destroy

void destroy()
      throws IOException

Called once at the end to clean up the resources.

Throws:

IOException - when not able to clean up resources.

getRegionsToBeCompacted

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'.

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

SortedSet<? extends RegionPruneInfo> 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.

Parameters:

numRegions - number of regions

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

Returns:

Set of region name and its prune upper bound

Throws:

IOException

getRegionPruneInfo

@Nullable
RegionPruneInfo 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.

Parameters:

regionId - region id

Returns:

RegionPruneInfo of the region

Throws:

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

getRegionsOnOrBeforeTime

RegionsAtTime getRegionsOnOrBeforeTime(String timeString)
                                throws IOException

Parameters:

timeString - Given a time, provide the regions 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 region list