Package org.apache.hadoop.hbase.io.hfile

Class HFilePrettyPrinter

java.lang.Object

org.apache.hadoop.conf.Configured

org.apache.hadoop.hbase.io.hfile.HFilePrettyPrinter

All Implemented Interfaces:

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

@LimitedPrivate("Tools")
@Evolving
public class HFilePrettyPrinter
extends org.apache.hadoop.conf.Configured
implements org.apache.hadoop.util.Tool

Implements pretty-printing functionality for HFiles.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	HFilePrettyPrinter.KeyValueStats	Holds a Histogram and supporting min/max and range buckets for analyzing distribution of key bytes, value bytes, row bytes, and row columns.
private static class	HFilePrettyPrinter.KeyValueStatsCollector
private static final class	HFilePrettyPrinter.SimpleReporter	Simple reporter which collects registered histograms for printing to an output stream in HFilePrettyPrinter.SimpleReporter.report().

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	checkFamily
private boolean	checkMobIntegrity
private boolean	checkRow
private int	count
private PrintStream	err
private List<org.apache.hadoop.fs.Path>	files
private static final int	FOUND_MOB_FILES_CACHE_CAPACITY
private static final String	FOUR_SPACES
private boolean	isSeekToRow
private static final org.slf4j.Logger	LOG
private static final int	MISSING_MOB_FILES_CACHE_CAPACITY
private Map<String,List<org.apache.hadoop.fs.Path>>	mobFileLocations
private org.apache.hbase.thirdparty.org.apache.commons.cli.Options	options
private PrintStream	out
private boolean	printBlockHeaders
private boolean	printBlockIndex
private boolean	printKey
private boolean	printStatRanges
private boolean	printStats
private boolean	printValue
private static final long[]	RANGES
private byte[]	row	The row which the user wants to specify and print all the KeyValues for.
private boolean	shouldPrintMeta
private static final com.codahale.metrics.MetricRegistry.MetricSupplier<com.codahale.metrics.Histogram>	UNIFORM_RESERVOIR
private boolean	verbose

Constructor Summary

Constructors

Constructor	Description
HFilePrettyPrinter()
HFilePrettyPrinter(org.apache.hadoop.conf.Configuration conf)

Method Summary

Modifier and Type	Method	Description
private static String	asSeparateLines(String keyValueStr)	Format a string of the form "k1=v1, k2=v2, ..." into separate lines with a four-space indentation.
private void	evictMobFilesIfNecessary(Set<String> mobFileNames, int limit)	Evicts the cached mob files if the set is larger than the limit.
private void	init()
static void	main(String[] args)
private boolean	mobFileExists(org.apache.hadoop.fs.FileSystem fs, TableName tn, String mobFileName, String family, Set<String> foundMobFiles, Set<String> missingMobFiles)	Checks whether the referenced mob file exists.
boolean	parseOptions(String[] args)
private void	printMeta(HFile.Reader reader, Map<byte[],byte[]> fileInfo)
int	processFile(org.apache.hadoop.fs.Path file, boolean checkRootDir)
int	run(String[] args)	Runs the command-line pretty-printer, and returns the desired command exit code (zero for success, non-zero for failure).
private void	scanKeysValues(org.apache.hadoop.fs.Path file, HFilePrettyPrinter.KeyValueStatsCollector fileStats, HFileScanner scanner, byte[] row)
void	setPrintStreams(PrintStream out, PrintStream err)

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 Details

LOG

private static final org.slf4j.Logger LOG

options

private org.apache.hbase.thirdparty.org.apache.commons.cli.Options options

verbose

private boolean verbose

printValue

private boolean printValue

printKey

private boolean printKey

shouldPrintMeta

private boolean shouldPrintMeta

printBlockIndex

private boolean printBlockIndex

printBlockHeaders

private boolean printBlockHeaders

printStats

private boolean printStats

printStatRanges

private boolean printStatRanges

checkRow

private boolean checkRow

checkFamily

private boolean checkFamily

isSeekToRow

private boolean isSeekToRow

checkMobIntegrity

private boolean checkMobIntegrity

mobFileLocations

private Map<String,List<org.apache.hadoop.fs.Path>> mobFileLocations

FOUND_MOB_FILES_CACHE_CAPACITY

private static final int FOUND_MOB_FILES_CACHE_CAPACITY

See Also:

• Constant Field Values

MISSING_MOB_FILES_CACHE_CAPACITY

private static final int MISSING_MOB_FILES_CACHE_CAPACITY

See Also:

• Constant Field Values

out

private PrintStream out

err

private PrintStream err

row

private byte[] row

The row which the user wants to specify and print all the KeyValues for.

files

private List<org.apache.hadoop.fs.Path> files

count

private int count

FOUR_SPACES

private static final String FOUR_SPACES

See Also:

• Constant Field Values

UNIFORM_RESERVOIR

private static final com.codahale.metrics.MetricRegistry.MetricSupplier<com.codahale.metrics.Histogram> UNIFORM_RESERVOIR

RANGES

private static final long[] RANGES

Constructor Details

HFilePrettyPrinter

public HFilePrettyPrinter()

HFilePrettyPrinter

public HFilePrettyPrinter(org.apache.hadoop.conf.Configuration conf)

Method Details

init

private void init()

setPrintStreams

public void setPrintStreams(PrintStream out,
 PrintStream err)

parseOptions

public boolean parseOptions(String[] args)
                     throws org.apache.hbase.thirdparty.org.apache.commons.cli.ParseException,
IOException

Throws:

org.apache.hbase.thirdparty.org.apache.commons.cli.ParseException

IOException

run

public int run(String[] args)

Runs the command-line pretty-printer, and returns the desired command exit code (zero for success, non-zero for failure).

Specified by:

run in interface org.apache.hadoop.util.Tool

processFile

public int processFile(org.apache.hadoop.fs.Path file,
 boolean checkRootDir)
                throws IOException

Throws:

IOException

scanKeysValues

private void scanKeysValues(org.apache.hadoop.fs.Path file,
 HFilePrettyPrinter.KeyValueStatsCollector fileStats,
 HFileScanner scanner,
 byte[] row)
                     throws IOException

Throws:

IOException

mobFileExists

private boolean mobFileExists(org.apache.hadoop.fs.FileSystem fs,
 TableName tn,
 String mobFileName,
 String family,
 Set<String> foundMobFiles,
 Set<String> missingMobFiles)
                       throws IOException

Checks whether the referenced mob file exists.

Throws:

IOException

evictMobFilesIfNecessary

private void evictMobFilesIfNecessary(Set<String> mobFileNames,
 int limit)

Evicts the cached mob files if the set is larger than the limit.

asSeparateLines

private static String asSeparateLines(String keyValueStr)

Format a string of the form "k1=v1, k2=v2, ..." into separate lines with a four-space indentation.

printMeta

private void printMeta(HFile.Reader reader,
 Map<byte[],byte[]> fileInfo)
                throws IOException

Throws:

IOException

main

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

Throws:

Exception