org.apache.hadoop.hbase.master.janitor

Class CatalogJanitor

java.lang.Object

org.apache.hadoop.hbase.ScheduledChore

org.apache.hadoop.hbase.master.janitor.CatalogJanitor

All Implemented Interfaces:

Runnable

@InterfaceAudience.Private
public class CatalogJanitor
extends ScheduledChore

A janitor for the catalog tables. Scans the hbase:meta catalog table on a period. Makes a lastReport on state of hbase:meta. Looks for unused regions to garbage collect. Scan of hbase:meta runs if we are NOT in maintenance mode, if we are NOT shutting down, AND if the assignmentmanager is loaded. Playing it safe, we will garbage collect no-longer needed region references only if there are no regions-in-transition (RIT).

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_HBASE_CATALOGJANITOR_INTERVAL

Constructor Summary

Constructors

Constructor and Description
CatalogJanitor(MasterServices services)

Method Summary

Modifier and Type	Method and Description
protected void	chore()
boolean	getEnabled()
CatalogJanitorReport	getLastReport() Returns Returns last published Report that comes of last successful scan of hbase:meta.
protected boolean	initialChore()
static void	main(String[] args) For testing against a cluster.
int	scan() Run janitorial scan of catalog hbase:meta table looking for garbage to collect.
protected CatalogJanitorReport	scanForReport() Scan hbase:meta.
boolean	setEnabled(boolean enabled)

Methods inherited from class org.apache.hadoop.hbase.ScheduledChore

cancel, cancel, choreForTesting, cleanup, getInitialDelay, getName, getPeriod, getStopper, getTimeUnit, isInitialChoreComplete, isScheduled, run, shutdown, shutdown, toString, triggerNow

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_HBASE_CATALOGJANITOR_INTERVAL

public static final int DEFAULT_HBASE_CATALOGJANITOR_INTERVAL

See Also:

Constant Field Values

Constructor Detail

CatalogJanitor

public CatalogJanitor(MasterServices services)

Method Detail

initialChore

protected boolean initialChore()

Overrides:

initialChore in class ScheduledChore

setEnabled

public boolean setEnabled(boolean enabled)

getEnabled

public boolean getEnabled()

chore

protected void chore()

Specified by:

chore in class ScheduledChore

scan

public int scan()
         throws IOException

Run janitorial scan of catalog hbase:meta table looking for garbage to collect.

Returns:

How many items gc'd whether for merge or split. Returns -1 if previous scan is in progress.

Throws:

IOException

scanForReport

protected CatalogJanitorReport scanForReport()
                                      throws IOException

Scan hbase:meta.

Returns:

Return generated CatalogJanitorReport

Throws:

IOException

getLastReport

public CatalogJanitorReport getLastReport()

Returns Returns last published Report that comes of last successful scan of hbase:meta.

main

public static void main(String[] args)
                 throws IOException

For testing against a cluster. Doesn't have a MasterServices context so does not report on good vs bad servers.

Throws:

IOException