HBASE-11204 Document bandwidth consumption limit feature for ExportSnapshot (Misty Stanley-Jones)

This commit is contained in:
Ted Yu 2014-06-04 04:33:24 +00:00
parent 5419bfdc8e
commit d20feaf1e7
2 changed files with 8 additions and 0 deletions

View File

@ -888,6 +888,7 @@ public final class ExportSnapshot extends Configured implements Tool {
"to the specified one.");
System.err.println(" -mappers Number of mappers to use during the " +
"copy (mapreduce.job.maps).");
System.err.println(" -bandwidth Limit bandwidth to this value in MB/second.");
System.err.println();
System.err.println("Examples:");
System.err.println(" hbase " + getClass().getName() + " \\");

View File

@ -1273,6 +1273,13 @@ hbase> restore_snapshot 'myTableSnapshot-122112'
<para>To copy a snapshot called MySnapshot to an HBase cluster srv2 (hdfs:///srv2:8082/hbase)
using 16 mappers:</para>
<programlisting>$ bin/hbase class org.apache.hadoop.hbase.snapshot.ExportSnapshot -snapshot MySnapshot -copy-to hdfs://srv2:8082/hbase -mappers 16</programlisting>
<formalpara>
<title>Limiting Bandwidth Consumption</title>
<para>You can limit the bandwidth consumption when exporting a snapshot, by specifying the
<code>-bandwidth</code> parameter, which expects an integer representing megabytes per
second. The following example limits the above example to 200 MB/sec.</para>
</formalpara>
<programlisting>$ bin/hbase class org.apache.hadoop.hbase.snapshot.ExportSnapshot -snapshot MySnapshot -copy-to hdfs://srv2:8082/hbase -mappers 16 -bandwidth 200</programlisting>
</section>
</section>
<!-- snapshots -->