Repository: hbase Updated Branches: refs/heads/master 7e30436e3 -> 4beefd8ce
HBASE-14574 TableOutputFormat#getRecordWriter javadoc misleads Project: http://git-wip-us.apache.org/repos/asf/hbase/repo Commit: http://git-wip-us.apache.org/repos/asf/hbase/commit/12cc2005 Tree: http://git-wip-us.apache.org/repos/asf/hbase/tree/12cc2005 Diff: http://git-wip-us.apache.org/repos/asf/hbase/diff/12cc2005 Branch: refs/heads/master Commit: 12cc2005c163216c508074dccb239b3fb8bcdc58 Parents: 7e30436 Author: stack <[email protected]> Authored: Wed Oct 7 15:00:43 2015 -0700 Committer: stack <[email protected]> Committed: Thu Oct 8 13:02:59 2015 -0700 ---------------------------------------------------------------------- .../hadoop/hbase/mapred/TableOutputFormat.java | 15 +++++++++++++++ .../hadoop/hbase/mapreduce/TableOutputFormat.java | 5 +++++ 2 files changed, 20 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/hbase/blob/12cc2005/hbase-server/src/main/java/org/apache/hadoop/hbase/mapred/TableOutputFormat.java ---------------------------------------------------------------------- diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/mapred/TableOutputFormat.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/mapred/TableOutputFormat.java index 6e0d9e7..dd72939 100644 --- a/hbase-server/src/main/java/org/apache/hadoop/hbase/mapred/TableOutputFormat.java +++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/mapred/TableOutputFormat.java @@ -71,6 +71,21 @@ public class TableOutputFormat extends FileOutputFormat<ImmutableBytesWritable, } } + /** + * Creates a new record writer. + * + * Be aware that the baseline javadoc gives the impression that there is a single + * {@link RecordWriter} per job but in HBase, it is more natural if we give you a new + * RecordWriter per call of this method. You must close the returned RecordWriter when done. + * Failure to do so will drop writes. + * + * @param ignored Ignored filesystem + * @param job Current JobConf + * @param name Name of the job + * @param progress + * @return The newly created writer instance. + * @throws IOException When creating the writer fails. + */ @Override public RecordWriter getRecordWriter(FileSystem ignored, JobConf job, String name, Progressable progress) http://git-wip-us.apache.org/repos/asf/hbase/blob/12cc2005/hbase-server/src/main/java/org/apache/hadoop/hbase/mapreduce/TableOutputFormat.java ---------------------------------------------------------------------- diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/mapreduce/TableOutputFormat.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/mapreduce/TableOutputFormat.java index 6e4b470..7a13750 100644 --- a/hbase-server/src/main/java/org/apache/hadoop/hbase/mapreduce/TableOutputFormat.java +++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/mapreduce/TableOutputFormat.java @@ -131,6 +131,11 @@ implements Configurable { /** * Creates a new record writer. + * + * Be aware that the baseline javadoc gives the impression that there is a single + * {@link RecordWriter} per job but in HBase, it is more natural if we give you a new + * RecordWriter per call of this method. You must close the returned RecordWriter when done. + * Failure to do so will drop writes. * * @param context The current task context. * @return The newly created writer instance.
