org.apache.hadoop.hbase.mapreduce

Class RowCounter

java.lang.Object

org.apache.hadoop.hbase.util.AbstractHBaseTool

org.apache.hadoop.hbase.mapreduce.RowCounter

All Implemented Interfaces:

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

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

A job with a just a map phase to count rows. Map outputs table rows IF the input row has columns that have content.

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
RowCounter()

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.
org.apache.hadoop.mapreduce.Job	createSubmittableJob(org.apache.hadoop.conf.Configuration conf) Sets up the actual job.
static org.apache.hadoop.mapreduce.Job	createSubmittableJob(org.apache.hadoop.conf.Configuration conf, String[] args) Deprecated. as of release 2.3.0. Will be removed on 4.0.0. Please use main method instead.
protected int	doWork() The "main function" of the tool
static void	main(String[] args) Main entry point.
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	printUsage(String usageStr, String usageHeader, String usageFooter)
protected void	processOldArgs(List<String> args) For backward compatibility.
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, getOptionAsLong, parseArgs, parseInt, parseLong, run, setConf

Methods inherited from class java.lang.Object

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

Constructor Detail

RowCounter

public RowCounter()

Method Detail

createSubmittableJob

public org.apache.hadoop.mapreduce.Job createSubmittableJob(org.apache.hadoop.conf.Configuration conf)
                                                     throws IOException

Sets up the actual job.

Parameters:

conf - The current configuration.

Returns:

The newly created job.

Throws:

IOException - When setting up the job fails.

createSubmittableJob

@Deprecated
public static org.apache.hadoop.mapreduce.Job createSubmittableJob(org.apache.hadoop.conf.Configuration conf,
                                                                               String[] args)
                                                                        throws IOException

Deprecated. as of release 2.3.0. Will be removed on 4.0.0. Please use main method instead.

Sets up the actual job.

Parameters:

conf - The current configuration.

args - The command line parameters.

Returns:

The newly created job.

Throws:

IOException - When setting up the job fails.

printUsage

protected void printUsage()

Overrides:

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

printUsage

protected void printUsage(String usageStr,
                          String usageHeader,
                          String usageFooter)

Overrides:

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

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

processOptions

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

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

Throws:

IllegalArgumentException

processOldArgs

protected void processOldArgs(List<String> args)

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

For backward compatibility. DO NOT use it for new tools. We have options in existing tools which can't be ported to Apache CLI's Option. (because they don't pass validation, for e.g. "-copy-to". "-" means short name which doesn't allow '-' in name). This function is to allow tools to have, for time being, parameters which can't be parsed using Option. Overrides should consume all valid legacy arguments. If the param 'args' is not empty on return, it means there were invalid options, in which case we'll exit from the tool. Note that it's called before AbstractHBaseTool.processOptions(CommandLine), which means new options' values will override old ones'.

Overrides:

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

doWork

protected int doWork()
              throws Exception

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:

Exception

main

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

Main entry point.

Parameters:

args - The command line parameters.

Throws:

Exception - When running the job fails.

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