org.apache.hadoop.mapred

Class OutputCommitter

java.lang.Object

org.apache.hadoop.mapreduce.OutputCommitter

org.apache.hadoop.mapred.OutputCommitter

Direct Known Subclasses:

FileOutputCommitter

public abstract class OutputCommitter
extends OutputCommitter

OutputCommitter describes the commit of task output for a Map-Reduce job.

The Map-Reduce framework relies on the OutputCommitter of the job to:

1. Setup the job during initialization. For example, create the temporary output directory for the job during the initialization of the job.
2. Cleanup the job after the job completion. For example, remove the temporary output directory after the job completion.
3. Setup the task temporary output.
4. Check whether a task needs a commit. This is to avoid the commit procedure if a task does not need commit.
5. Commit of the task output.
6. Discard the task commit.

See Also:

FileOutputCommitter, JobContext, TaskAttemptContext

Constructor Summary

Constructors

Constructor and Description
OutputCommitter()

Method Summary

Methods

Modifier and Type	Method and Description
void	abortJob(JobContext jobContext, int status) For cleaning up the job's output after job failure.
void	abortJob(JobContext context, JobStatus.State runState) This method implements the new interface by calling the old method.
abstract void	abortTask(TaskAttemptContext taskContext) Discard the task output
void	abortTask(TaskAttemptContext taskContext) This method implements the new interface by calling the old method.
void	cleanupJob(JobContext jobContext) Deprecated. use commitJob(JobContext) or abortJob(JobContext, int) instead
void	cleanupJob(JobContext context) Deprecated.
void	commitJob(JobContext jobContext) For committing job's output after successful job completion.
void	commitJob(JobContext context) This method implements the new interface by calling the old method.
abstract void	commitTask(TaskAttemptContext taskContext) To promote the task's temporary output to final output location The task's output is moved to the job's output directory.
void	commitTask(TaskAttemptContext taskContext) This method implements the new interface by calling the old method.
abstract boolean	needsTaskCommit(TaskAttemptContext taskContext) Check whether task needs a commit
boolean	needsTaskCommit(TaskAttemptContext taskContext) This method implements the new interface by calling the old method.
abstract void	setupJob(JobContext jobContext) For the framework to setup the job output during initialization
void	setupJob(JobContext jobContext) This method implements the new interface by calling the old method.
abstract void	setupTask(TaskAttemptContext taskContext) Sets up output for the task.
void	setupTask(TaskAttemptContext taskContext) This method implements the new interface by calling the old method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OutputCommitter

public OutputCommitter()

Method Detail

setupJob

public abstract void setupJob(JobContext jobContext)
                       throws java.io.IOException

For the framework to setup the job output during initialization

Parameters:

jobContext - Context of the job whose output is being written.

Throws:

java.io.IOException - if temporary output could not be created

cleanupJob

@Deprecated
public void cleanupJob(JobContext jobContext)
                throws java.io.IOException

Deprecated. use commitJob(JobContext) or abortJob(JobContext, int) instead

For cleaning up the job's output after job completion

Throws:

java.io.IOException

commitJob

public void commitJob(JobContext jobContext)
               throws java.io.IOException

For committing job's output after successful job completion. Note that this is invoked for jobs with final run state as JobStatus.SUCCEEDED.

Parameters:

jobContext - Context of the job whose output is being written.

Throws:

java.io.IOException

abortJob

public void abortJob(JobContext jobContext,
            int status)
              throws java.io.IOException

For cleaning up the job's output after job failure.

Parameters:

jobContext - Context of the job whose output is being written.

status - Final run state of the job, should be JobStatus.KILLED or JobStatus.FAILED

Throws:

java.io.IOException

setupTask

public abstract void setupTask(TaskAttemptContext taskContext)
                        throws java.io.IOException

Sets up output for the task.

Parameters:

taskContext - Context of the task whose output is being written.

Throws:

java.io.IOException

needsTaskCommit

public abstract boolean needsTaskCommit(TaskAttemptContext taskContext)
                                 throws java.io.IOException

Check whether task needs a commit

Parameters:

taskContext -

Returns:

true/false

Throws:

java.io.IOException

commitTask

public abstract void commitTask(TaskAttemptContext taskContext)
                         throws java.io.IOException

To promote the task's temporary output to final output location The task's output is moved to the job's output directory.

Parameters:

taskContext - Context of the task whose output is being written.

Throws:

java.io.IOException - if commit is not

abortTask

public abstract void abortTask(TaskAttemptContext taskContext)
                        throws java.io.IOException

Discard the task output

Parameters:

taskContext -

Throws:

java.io.IOException

setupJob

public final void setupJob(JobContext jobContext)
                    throws java.io.IOException

This method implements the new interface by calling the old method. Note that the input types are different between the new and old apis and this is a bridge between the two.

Specified by:

setupJob in class OutputCommitter

Parameters:

jobContext - Context of the job whose output is being written.

Throws:

java.io.IOException - if temporary output could not be created

cleanupJob

@Deprecated
public final void cleanupJob(JobContext context)
                      throws java.io.IOException

Deprecated.

This method implements the new interface by calling the old method. Note that the input types are different between the new and old apis and this is a bridge between the two.

Overrides:

cleanupJob in class OutputCommitter

Throws:

java.io.IOException

commitJob

public final void commitJob(JobContext context)
                     throws java.io.IOException

This method implements the new interface by calling the old method. Note that the input types are different between the new and old apis and this is a bridge between the two.

Overrides:

commitJob in class OutputCommitter

Parameters:

context - Context of the job whose output is being written.

Throws:

java.io.IOException

abortJob

public final void abortJob(JobContext context,
            JobStatus.State runState)
                    throws java.io.IOException

This method implements the new interface by calling the old method. Note that the input types are different between the new and old apis and this is a bridge between the two.

Overrides:

abortJob in class OutputCommitter

Parameters:

context - Context of the job whose output is being written.

runState - final run state of the job, should be either JobStatus.State.KILLED or JobStatus.State.FAILED

Throws:

java.io.IOException

setupTask

public final void setupTask(TaskAttemptContext taskContext)
                     throws java.io.IOException

This method implements the new interface by calling the old method. Note that the input types are different between the new and old apis and this is a bridge between the two.

Specified by:

setupTask in class OutputCommitter

Parameters:

taskContext - Context of the task whose output is being written.

Throws:

java.io.IOException

needsTaskCommit

public final boolean needsTaskCommit(TaskAttemptContext taskContext)
                              throws java.io.IOException

This method implements the new interface by calling the old method. Note that the input types are different between the new and old apis and this is a bridge between the two.

Specified by:

needsTaskCommit in class OutputCommitter

Returns:

true/false

Throws:

java.io.IOException

commitTask

public final void commitTask(TaskAttemptContext taskContext)
                      throws java.io.IOException

This method implements the new interface by calling the old method. Note that the input types are different between the new and old apis and this is a bridge between the two.

Specified by:

commitTask in class OutputCommitter

Parameters:

taskContext - Context of the task whose output is being written.

Throws:

java.io.IOException - if commit is not

abortTask

public final void abortTask(TaskAttemptContext taskContext)
                     throws java.io.IOException

This method implements the new interface by calling the old method. Note that the input types are different between the new and old apis and this is a bridge between the two.

Specified by:

abortTask in class OutputCommitter

Throws:

java.io.IOException