diff --git a/src/main/docbkx/ops_mgt.xml b/src/main/docbkx/ops_mgt.xml index 94d67cd6c1f..841ad89342f 100644 --- a/src/main/docbkx/ops_mgt.xml +++ b/src/main/docbkx/ops_mgt.xml @@ -39,7 +39,48 @@ xml:id="tools"> HBase Tools and Utilities - Here we list HBase tools for administration, analysis, fixup, and debugging. + HBase provides several tools for administration, analysis, and debugging of your cluster. + The entry-point to most of these tools is the bin/hbase command, though + some tools are available in the dev-support/ directory. + To see usage instructions for bin/hbase command, run it with no + arguments, or with the argument. These are the usage instructions for + HBase 0.98.x. Some commands, such as version, pe, + ltt, clean, are not available in previous + versions. + +$ bin/hbase +] []]]> +Options: + --config DIR Configuration direction to use. Default: ./conf + --hosts HOSTS Override the list in 'regionservers' file + +Commands: +Some commands take arguments. Pass no args or -h for usage. + shell Run the HBase shell + hbck Run the hbase 'fsck' tool + hlog Write-ahead-log analyzer + hfile Store file analyzer + zkcli Run the ZooKeeper shell + upgrade Upgrade hbase + master Run an HBase HMaster node + regionserver Run an HBase HRegionServer node + zookeeper Run a Zookeeper server + rest Run an HBase REST server + thrift Run the HBase Thrift server + thrift2 Run the HBase Thrift2 server + clean Run the HBase clean up script + classpath Dump hbase CLASSPATH + mapredcp Dump CLASSPATH entries required by mapreduce + pe Run PerformanceEvaluation + ltt Run LoadTestTool + version Print the version + CLASSNAME Run the class named CLASSNAME + + Some of the tools and utilities below are Java classes which are passed directly to the + bin/hbase command, as referred to in the last line of the usage + instructions. Others, such as hbase shell (), + hbase upgrade (), and hbase + thrift (), are documented elsewhere in this guide.
Canary @@ -566,6 +607,32 @@ row10 c1 c2
+
+ <command>hbase clean</command> + The hbase clean command cleans HBase data from ZooKeeper, HDFS, or + both. It is appropriate to use for testing. Run it with no options for usage instructions. + The hbase clean command was introduced in HBase 0.98. + +$ bin/hbase clean +Usage: hbase clean (--cleanZk|--cleanHdfs|--cleanAll) +Options: + --cleanZk cleans hbase related data from zookeeper. + --cleanHdfs cleans hbase related data from hdfs. + --cleanAll cleans hbase related data from both zookeeper and hdfs. + +
+
+ <command>hbase pe</command> + The hbase pe command is a shortcut provided to run the + org.apache.hadoop.hbase.PerformanceEvaluation tool, which is used for + testing. The hbase pe command was introduced in HBase 0.98. +
+
+ <command>hbase ltt</command> + The hbase ltt command is a shortcut provided to run the + rg.apache.hadoop.hbase.util.LoadTestTool utility, which is used for + testing. The hbase ltt command was introduced in HBase 0.98. +