org.apache.hadoop.hbase.snapshot

Class SnapshotInfo

java.lang.Object

org.apache.hadoop.hbase.util.AbstractHBaseTool

org.apache.hadoop.hbase.snapshot.SnapshotInfo

All Implemented Interfaces:

org.apache.hadoop.conf.Configurable, org.apache.hadoop.util.Tool

@InterfaceAudience.Public
public final class SnapshotInfo
extends org.apache.hadoop.hbase.util.AbstractHBaseTool

Tool for dumping snapshot information.

1. Table Descriptor
2. Snapshot creation time, type, format version, ...
3. List of hfiles and wals
4. Stats about hfiles and logs sizes, percentage of shared with the source table, ...

Field Summary

Fields inherited from class org.apache.hadoop.hbase.util.AbstractHBaseTool

cmdLineArgs, conf, EXIT_FAILURE, EXIT_SUCCESS, LONG_HELP_OPTION, options, SHORT_HELP_OPTION

Constructor Summary

Constructors

Constructor and Description
SnapshotInfo()

Method Summary

Modifier and Type	Method and Description
protected void	addOptions() Override this to add command-line options using AbstractHBaseTool.addOptWithArg(java.lang.String, java.lang.String) and similar methods.
int	doWork() The "main function" of the tool
static List<SnapshotDescription>	getSnapshotList(org.apache.hadoop.conf.Configuration conf) Returns the list of available snapshots in the specified location
static Map<org.apache.hadoop.fs.Path,Integer>	getSnapshotsFilesMap(org.apache.hadoop.conf.Configuration conf, AtomicLong uniqueHFilesArchiveSize, AtomicLong uniqueHFilesSize, AtomicLong uniqueHFilesMobSize) Returns the map of store files based on path for all snapshots
static org.apache.hadoop.hbase.snapshot.SnapshotInfo.SnapshotStats	getSnapshotStats(org.apache.hadoop.conf.Configuration conf, SnapshotDescription snapshot) Returns the snapshot stats
static org.apache.hadoop.hbase.snapshot.SnapshotInfo.SnapshotStats	getSnapshotStats(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshotDesc, Map<org.apache.hadoop.fs.Path,Integer> filesMap) Returns the snapshot stats
static void	main(String[] args)
protected org.apache.hbase.thirdparty.org.apache.commons.cli.CommandLineParser	newParser() Create the parser to use for parsing and validating the command line.
protected void	printUsage()
protected void	processOptions(org.apache.hbase.thirdparty.org.apache.commons.cli.CommandLine cmd) This method is called to process the options after they have been parsed.

Methods inherited from class org.apache.hadoop.hbase.util.AbstractHBaseTool

addOption, addOptNoArg, addOptNoArg, addOptWithArg, addOptWithArg, addRequiredOption, addRequiredOptWithArg, addRequiredOptWithArg, doStaticMain, getConf, getOptionAsDouble, getOptionAsInt, getOptionAsInt, getOptionAsLong, getOptionAsLong, parseArgs, parseInt, parseLong, printUsage, processOldArgs, run, setConf

Methods inherited from class java.lang.Object

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

Constructor Detail

SnapshotInfo

public SnapshotInfo()

Method Detail

doWork

public int doWork()
           throws IOException,
                  InterruptedException

Description copied from class: org.apache.hadoop.hbase.util.AbstractHBaseTool

The "main function" of the tool

Specified by:

doWork in class org.apache.hadoop.hbase.util.AbstractHBaseTool

Throws:

IOException

InterruptedException

addOptions

protected void addOptions()

Description copied from class: org.apache.hadoop.hbase.util.AbstractHBaseTool

Override this to add command-line options using AbstractHBaseTool.addOptWithArg(java.lang.String, java.lang.String) and similar methods.

Specified by:

addOptions in class org.apache.hadoop.hbase.util.AbstractHBaseTool

newParser

protected org.apache.hbase.thirdparty.org.apache.commons.cli.CommandLineParser newParser()

Description copied from class: org.apache.hadoop.hbase.util.AbstractHBaseTool

Create the parser to use for parsing and validating the command line. Since commons-cli lacks the capability to validate arbitrary combination of options, it may be helpful to bake custom logic into a specialized parser implementation. See LoadTestTool for examples.

Overrides:

newParser in class org.apache.hadoop.hbase.util.AbstractHBaseTool

Returns:

a new parser specific to the current tool

processOptions

protected void processOptions(org.apache.hbase.thirdparty.org.apache.commons.cli.CommandLine cmd)

Description copied from class: org.apache.hadoop.hbase.util.AbstractHBaseTool

This method is called to process the options after they have been parsed.

Specified by:

processOptions in class org.apache.hadoop.hbase.util.AbstractHBaseTool

printUsage

protected void printUsage()

Overrides:

printUsage in class org.apache.hadoop.hbase.util.AbstractHBaseTool

getSnapshotStats

public static org.apache.hadoop.hbase.snapshot.SnapshotInfo.SnapshotStats getSnapshotStats(org.apache.hadoop.conf.Configuration conf,
                                                                                           SnapshotDescription snapshot)
                                                                                    throws IOException

Returns the snapshot stats

Parameters:

conf - the Configuration to use

snapshot - SnapshotDescription to get stats from

Returns:

the snapshot stats

Throws:

IOException

getSnapshotStats

public static org.apache.hadoop.hbase.snapshot.SnapshotInfo.SnapshotStats getSnapshotStats(org.apache.hadoop.conf.Configuration conf,
                                                                                           org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshotDesc,
                                                                                           Map<org.apache.hadoop.fs.Path,Integer> filesMap)
                                                                                    throws IOException

Returns the snapshot stats

Parameters:

conf - the Configuration to use

snapshotDesc - HBaseProtos.SnapshotDescription to get stats from

filesMap - Map store files map for all snapshots, it may be null

Returns:

the snapshot stats

Throws:

IOException

getSnapshotList

public static List<SnapshotDescription> getSnapshotList(org.apache.hadoop.conf.Configuration conf)
                                                 throws IOException

Returns the list of available snapshots in the specified location

Parameters:

conf - the Configuration to use

Returns:

the list of snapshots

Throws:

IOException

getSnapshotsFilesMap

public static Map<org.apache.hadoop.fs.Path,Integer> getSnapshotsFilesMap(org.apache.hadoop.conf.Configuration conf,
                                                                          AtomicLong uniqueHFilesArchiveSize,
                                                                          AtomicLong uniqueHFilesSize,
                                                                          AtomicLong uniqueHFilesMobSize)
                                                                   throws IOException

Returns the map of store files based on path for all snapshots

Parameters:

conf - the Configuration to use

uniqueHFilesArchiveSize - pass out the size for store files in archive

uniqueHFilesSize - pass out the size for store files shared

uniqueHFilesMobSize - pass out the size for mob store files shared

Returns:

the map of store files

Throws:

IOException

main

public static void main(String[] args)