org.apache.hadoop.hbase.mapreduce.IdentityTableReducer Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of hbase-mapreduce Show documentation

This module contains implementations of InputFormat, OutputFormat, Mapper, Reducer, etc which are needed for running MR jobs on tables, WALs, HFiles and other HBase specific constructs. It also contains a bunch of tools: RowCounter, ImportTsv, Import, Export, CompactionTool, ExportSnapshot, WALPlayer, etc

There is a newer version: 3.0.0-beta-1

Show newest version

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.hadoop.hbase.mapreduce;

import java.io.IOException;
import org.apache.hadoop.hbase.client.Mutation;
import org.apache.hadoop.io.Writable;
import org.apache.yetus.audience.InterfaceAudience;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Convenience class that simply writes all values (which must be
 * {@link org.apache.hadoop.hbase.client.Put Put} or {@link org.apache.hadoop.hbase.client.Delete
 * Delete} instances) passed to it out to the configured HBase table. This works in combination with
 * {@link TableOutputFormat} which actually does the writing to HBase.
 * 
 * Keys are passed along but ignored in TableOutputFormat. However, they can be used to control how
 * your values will be divided up amongst the specified number of reducers.
 * 

 * You can also use the {@link TableMapReduceUtil} class to set up the two classes in one step:
 * 

 * TableMapReduceUtil.initTableReducerJob("table", IdentityTableReducer.class, job);
 *  This will also set the proper {@link TableOutputFormat} which is given the
 * table parameter. The {@link org.apache.hadoop.hbase.client.Put Put} or
 * {@link org.apache.hadoop.hbase.client.Delete Delete} define the row and columns implicitly.
 */
@InterfaceAudience.Public
public class IdentityTableReducer extends TableReducer {

  @SuppressWarnings("unused")
  private static final Logger LOG = LoggerFactory.getLogger(IdentityTableReducer.class);

  /**
   * Writes each given record, consisting of the row key and the given values, to the configured
   * {@link org.apache.hadoop.mapreduce.OutputFormat}. It is emitting the row key and each
   * {@link org.apache.hadoop.hbase.client.Put Put} or {@link org.apache.hadoop.hbase.client.Delete
   * Delete} as separate pairs.
   * @param key     The current row key.
   * @param values  The {@link org.apache.hadoop.hbase.client.Put Put} or
   *                {@link org.apache.hadoop.hbase.client.Delete Delete} list for the given row.
   * @param context The context of the reduce.
   * @throws IOException          When writing the record fails.
   * @throws InterruptedException When the job gets interrupted.
   */
  @Override
  public void reduce(Writable key, Iterable values, Context context)
    throws IOException, InterruptedException {
    for (Mutation putOrDelete : values) {
      context.write(key, putOrDelete);
    }
  }
}