org.apache.pig.backend.executionengine
Interface ExecJob

All Known Implementing Classes:
HJob

public interface ExecJob

Abstraction on a job that the execution engine runs. It allows the front-end to retrieve information on job status and manage a running job.


Nested Class Summary
static class ExecJob.JOB_STATUS
           
 
Field Summary
static String PROGRESS_KEY
           
 
Method Summary
 void completionNotification(Object cookie)
          hook for asynchronous notification of job completion pushed from the back-end
 String getAlias()
          Returns the alias of relation generated by this job
 Properties getConfiguration()
          Get configuration information
 Exception getException()
          Get exceptions that happened during execution
 void getLogs(OutputStream log)
          Collecting various forms of outputs
 POStore getPOStore()
           
 Iterator<Tuple> getResults()
          if query has executed successfully we want to retrieve the results via iterating over them.
 PigStats getStatistics()
          Can be information about the state (not submitted, e.g.
 ExecJob.JOB_STATUS getStatus()
           
 void getSTDError(OutputStream error)
           
 void getSTDOut(OutputStream out)
           
 boolean hasCompleted()
          true is the physical plan has executed successfully and results are ready to be retrieved
 void kill()
          Kills current job.
 

Field Detail

PROGRESS_KEY

static final String PROGRESS_KEY
See Also:
Constant Field Values
Method Detail

getStatus

ExecJob.JOB_STATUS getStatus()

hasCompleted

boolean hasCompleted()
                     throws ExecException
true is the physical plan has executed successfully and results are ready to be retrieved

Returns:
true if execution has completed, false otherwise.
Throws:
ExecException

getResults

Iterator<Tuple> getResults()
                           throws ExecException
if query has executed successfully we want to retrieve the results via iterating over them.

Returns:
iterator for resulting tuples
Throws:
ExecException

getAlias

String getAlias()
                throws ExecException
Returns the alias of relation generated by this job

Throws:
ExecException

getConfiguration

Properties getConfiguration()
Get configuration information

Returns:
configuration information for the execution engine

getStatistics

PigStats getStatistics()
Can be information about the state (not submitted, e.g. the execute method has not been called yet; not running, e.g. execute has been issued, but job is waiting; running...; completed; aborted...; progress information

Returns:
statistics relevant to the execution engine

getPOStore

POStore getPOStore()
Returns:
POStore object associated with the store

completionNotification

void completionNotification(Object cookie)
hook for asynchronous notification of job completion pushed from the back-end


kill

void kill()
          throws ExecException
Kills current job.

Throws:
ExecException

getLogs

void getLogs(OutputStream log)
             throws ExecException
Collecting various forms of outputs

Throws:
ExecException

getSTDOut

void getSTDOut(OutputStream out)
               throws ExecException
Throws:
ExecException

getSTDError

void getSTDError(OutputStream error)
                 throws ExecException
Throws:
ExecException

getException

Exception getException()
Get exceptions that happened during execution



Copyright © 2007-2012 The Apache Software Foundation