HBASE-20386 [DOC] Align WALPlayer help text and refguide
Project: http://git-wip-us.apache.org/repos/asf/hbase/repo Commit: http://git-wip-us.apache.org/repos/asf/hbase/commit/eb40e6df Tree: http://git-wip-us.apache.org/repos/asf/hbase/tree/eb40e6df Diff: http://git-wip-us.apache.org/repos/asf/hbase/diff/eb40e6df Branch: refs/heads/HBASE-19064 Commit: eb40e6dfaa26dec85fc07a9cebedb7dcdc62874a Parents: 3eda9f1 Author: Balazs Meszaros <balazs.mesza...@cloudera.com> Authored: Wed Apr 11 09:59:12 2018 +0200 Committer: Michael Stack <st...@apache.org> Committed: Wed Apr 11 09:32:55 2018 -0700 ---------------------------------------------------------------------- .../hadoop/hbase/mapreduce/WALPlayer.java | 27 +++++++++------ src/main/asciidoc/_chapters/ops_mgt.adoc | 35 ++++++++++++++++++++ 2 files changed, 51 insertions(+), 11 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/hbase/blob/eb40e6df/hbase-mapreduce/src/main/java/org/apache/hadoop/hbase/mapreduce/WALPlayer.java ---------------------------------------------------------------------- diff --git a/hbase-mapreduce/src/main/java/org/apache/hadoop/hbase/mapreduce/WALPlayer.java b/hbase-mapreduce/src/main/java/org/apache/hadoop/hbase/mapreduce/WALPlayer.java index 057127c..fe8ff94 100644 --- a/hbase-mapreduce/src/main/java/org/apache/hadoop/hbase/mapreduce/WALPlayer.java +++ b/hbase-mapreduce/src/main/java/org/apache/hadoop/hbase/mapreduce/WALPlayer.java @@ -349,24 +349,29 @@ public class WALPlayer extends Configured implements Tool { System.err.println("ERROR: " + errorMsg); } System.err.println("Usage: " + NAME + " [options] <wal inputdir> <tables> [<tableMappings>]"); - System.err.println("Read all WAL entries for <tables>."); - System.err.println("If no tables (\"\") are specific, all tables are imported."); - System.err.println("(Careful, even hbase:meta entries will be imported" + " in that case.)"); - System.err.println("Otherwise <tables> is a comma separated list of tables.\n"); - System.err.println("The WAL entries can be mapped to new set of tables via <tableMapping>."); - System.err.println("<tableMapping> is a command separated list of targettables."); + System.err.println("Replay all WAL files into HBase."); + System.err.println("<tables> is a comma separated list of tables."); + System.err.println("If no tables (\"\") are specified, all tables are imported."); + System.err.println("(Be careful, hbase:meta entries will be imported in this case.)\n"); + System.err.println("WAL entries can be mapped to new set of tables via <tableMappings>."); + System.err.println("<tableMappings> is a comma separated list of target tables."); System.err.println("If specified, each table in <tables> must have a mapping.\n"); System.err.println("By default " + NAME + " will load data directly into HBase."); - System.err.println("To generate HFiles for a bulk data load instead, pass the option:"); + System.err.println("To generate HFiles for a bulk data load instead, pass the following option:"); System.err.println(" -D" + BULK_OUTPUT_CONF_KEY + "=/path/for/output"); System.err.println(" (Only one table can be specified, and no mapping is allowed!)"); - System.err.println("Other options: (specify time range to WAL edit to consider)"); + System.err.println("Time range options:"); System.err.println(" -D" + WALInputFormat.START_TIME_KEY + "=[date|ms]"); System.err.println(" -D" + WALInputFormat.END_TIME_KEY + "=[date|ms]"); - System.err.println(" -D " + JOB_NAME_CONF_KEY - + "=jobName - use the specified mapreduce job name for the wal player"); + System.err.println(" (The start and the end date of timerange. The dates can be expressed"); + System.err.println(" in milliseconds since epoch or in yyyy-MM-dd'T'HH:mm:ss.SS format."); + System.err.println(" E.g. 1234567890120 or 2009-02-13T23:32:30.12)"); + System.err.println("Other options:"); + System.err.println(" -D" + JOB_NAME_CONF_KEY + "=jobName"); + System.err.println(" Use the specified mapreduce job name for the wal player"); System.err.println("For performance also consider the following options:\n" - + " -Dmapreduce.map.speculative=false\n" + " -Dmapreduce.reduce.speculative=false"); + + " -Dmapreduce.map.speculative=false\n" + + " -Dmapreduce.reduce.speculative=false"); } /** http://git-wip-us.apache.org/repos/asf/hbase/blob/eb40e6df/src/main/asciidoc/_chapters/ops_mgt.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/_chapters/ops_mgt.adoc b/src/main/asciidoc/_chapters/ops_mgt.adoc index 816773e..82badb4 100644 --- a/src/main/asciidoc/_chapters/ops_mgt.adoc +++ b/src/main/asciidoc/_chapters/ops_mgt.adoc @@ -684,6 +684,7 @@ Assuming you're running HDFS with permissions enabled, those permissions will ne For more information about bulk-loading HFiles into HBase, see <<arch.bulk.load,arch.bulk.load>>. +[[walplayer]] === WALPlayer WALPlayer is a utility to replay WAL files into HBase. @@ -708,6 +709,40 @@ $ bin/hbase org.apache.hadoop.hbase.mapreduce.WALPlayer /backuplogdir oldTable1, WALPlayer, by default, runs as a mapreduce job. To NOT run WALPlayer as a mapreduce job on your cluster, force it to run all in the local process by adding the flags `-Dmapreduce.jobtracker.address=local` on the command line. +[[walplayer.options]] +==== WALPlayer Options + +Running `WALPlayer` with no arguments prints brief usage information: + +---- +Usage: WALPlayer [options] <wal inputdir> <tables> [<tableMappings>] +Replay all WAL files into HBase. +<tables> is a comma separated list of tables. +If no tables ("") are specified, all tables are imported. +(Be careful, hbase:meta entries will be imported in this case.) + +WAL entries can be mapped to new set of tables via <tableMappings>. +<tableMappings> is a comma separated list of target tables. +If specified, each table in <tables> must have a mapping. + +By default WALPlayer will load data directly into HBase. +To generate HFiles for a bulk data load instead, pass the following option: + -Dwal.bulk.output=/path/for/output + (Only one table can be specified, and no mapping is allowed!) +Time range options: + -Dwal.start.time=[date|ms] + -Dwal.end.time=[date|ms] + (The start and the end date of timerange. The dates can be expressed + in milliseconds since epoch or in yyyy-MM-dd'T'HH:mm:ss.SS format. + E.g. 1234567890120 or 2009-02-13T23:32:30.12) +Other options: + -Dmapreduce.job.name=jobName + Use the specified mapreduce job name for the wal player +For performance also consider the following options: + -Dmapreduce.map.speculative=false + -Dmapreduce.reduce.speculative=false +---- + [[rowcounter]] === RowCounter and CellCounter