SnapshotInfo (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.conf.Configured
- - org.apache.hadoop.hbase.snapshot.SnapshotInfo

All Implemented Interfaces:

org.apache.hadoop.conf.Configurable, org.apache.hadoop.util.Tool
```
@InterfaceAudience.Public
@InterfaceStability.Evolving
public final class SnapshotInfo
extends org.apache.hadoop.conf.Configured
implements org.apache.hadoop.util.Tool
```
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, ...

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SnapshotInfo.SnapshotStats` Statistics about the snapshot How many store files and logs are in the archive How many store files and logs are shared with the table Total store files and logs size and shared amount

Field Summary

Fields
Modifier and Type	Field and Description
`private org.apache.hadoop.fs.FileSystem`	`fs`
`private static org.apache.commons.logging.Log`	`LOG`
`private boolean`	`printSizeInBytes`
`private org.apache.hadoop.fs.Path`	`rootDir`
`private SnapshotManifest`	`snapshotManifest`

Constructor Summary

Constructors
Constructor and Description

SnapshotInfo()

Constructors
Constructor and Description
`SnapshotInfo()`

Method Summary

Methods
Modifier and Type	Method and Description
`private String`	`fileSizeToString(long size)`
`static List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription>`	`getSnapshotList(org.apache.hadoop.conf.Configuration conf)` Returns the list of available snapshots in the specified location
`static SnapshotInfo.SnapshotStats`	`getSnapshotStats(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot)` Returns the snapshot stats
`(package private) static int`	`innerMain(String[] args)` The guts of the `main(java.lang.String[])` method.
`private boolean`	`loadSnapshotInfo(String snapshotName)` Load snapshot info and table descriptor for the specified snapshot
`static void`	`main(String[] args)`
`private void`	`printFiles(boolean showFiles, boolean showStats)` Collect the hfiles and logs statistics of the snapshot and dump the file list if requested and the collected information.
`private void`	`printInfo()` Dump the `HBaseProtos.SnapshotDescription`
`private void`	`printSchema()` Dump the `HTableDescriptor`
`private void`	`printUsageAndExit()`
`int`	`run(String[] args)`

Methods inherited from class org.apache.hadoop.conf.Configured
getConf, setConf

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.hadoop.conf.Configurable
getConf, setConf

Field Detail

LOG

private static final org.apache.commons.logging.Log LOG

printSizeInBytes
```
private boolean printSizeInBytes
```

fs

private org.apache.hadoop.fs.FileSystem fs

rootDir

private org.apache.hadoop.fs.Path rootDir

snapshotManifest

private SnapshotManifest snapshotManifest

Constructor Detail
- SnapshotInfo
```
public SnapshotInfo()
```

Method Detail

run

public int run(String[] args)
        throws IOException,
               InterruptedException

Specified by:: run in interface org.apache.hadoop.util.Tool
Throws:: IOException; InterruptedException

loadSnapshotInfo
```
private boolean loadSnapshotInfo(String snapshotName)
                          throws IOException
```
Load snapshot info and table descriptor for the specified snapshot

Parameters:
snapshotName - name of the snapshot to load

Returns:
false if snapshot is not found

Throws:

IOException

printInfo
```
private void printInfo()
```
Dump the HBaseProtos.SnapshotDescription

printSchema
```
private void printSchema()
```
Dump the HTableDescriptor

printFiles
```
private void printFiles(boolean showFiles,
              boolean showStats)
                 throws IOException
```
Collect the hfiles and logs statistics of the snapshot and dump the file list if requested and the collected information.

Throws:

IOException

fileSizeToString

private String fileSizeToString(long size)

printUsageAndExit
```
private void printUsageAndExit()
```

getSnapshotStats

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

Returns the snapshot stats

Parameters:: conf - the Configuration to use; snapshot - HBaseProtos.SnapshotDescription to get stats from
Returns:: the snapshot stats
Throws:: IOException

getSnapshotList

public static List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.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

innerMain
```
static int innerMain(String[] args)
              throws Exception
```
The guts of the main(java.lang.String[]) method. Call this method to avoid the main(String[]) System.exit.

Parameters:
args -

Returns:
errCode

Throws:

Exception

main

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

Throws:: Exception

Class SnapshotInfo

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.hadoop.conf.Configured

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.hadoop.conf.Configurable

Field Detail

LOG

printSizeInBytes

fs

rootDir

snapshotManifest

Constructor Detail

SnapshotInfo

Method Detail

run

loadSnapshotInfo

printInfo

printSchema

printFiles

fileSizeToString

printUsageAndExit

getSnapshotStats

getSnapshotList

innerMain

main