org.apache.hadoop.hive.ql.history

Interface HiveHistory

All Known Implementing Classes:

HiveHistoryImpl

public interface HiveHistory

HiveHistory. Logs information such as query, query plan, runtime statistics into a file. Each session uses a new object, which creates a new file.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	HiveHistory.Info Info.
static class	HiveHistory.Keys Keys.
static interface	HiveHistory.Listener Listener interface.
static class	HiveHistory.QueryInfo QueryInfo.
static class	HiveHistory.RecordTypes RecordTypes.
static class	HiveHistory.SessionInfo SessionInfo.
static class	HiveHistory.TaskInfo TaskInfo.

Method Summary

Modifier and Type	Method and Description
void	closeStream() Close the log file stream
void	endQuery(java.lang.String queryId) Called at the end of a query
void	endTask(java.lang.String queryId, Task<? extends java.io.Serializable> task) Called at the end of a task.
java.lang.String	getHistFileName()
void	logPlanProgress(QueryPlan plan) Logs the current plan state
void	printRowCount(java.lang.String queryId)
void	progressTask(java.lang.String queryId, Task<? extends java.io.Serializable> task) Logs progress of a task if ConfVars.HIVE_LOG_INCREMENTAL_PLAN_PROGRESS is set to true
void	setIdToTableMap(java.util.Map<java.lang.String,java.lang.String> map) Set the id to table name map
void	setQueryProperty(java.lang.String queryId, HiveHistory.Keys propName, java.lang.String propValue) Used to set query status and other attributes of a query
void	setTaskCounters(java.lang.String queryId, java.lang.String taskId, Counters ctrs) Serialize the task counters and set as a task property.
void	setTaskProperty(java.lang.String queryId, java.lang.String taskId, HiveHistory.Keys propName, java.lang.String propValue) Used to set task properties.
void	startQuery(java.lang.String cmd, java.lang.String id) Called at the start of query execution in Driver.execute().
void	startTask(java.lang.String queryId, Task<? extends java.io.Serializable> task, java.lang.String taskName) Called at the start of a task.

Method Detail

getHistFileName

java.lang.String getHistFileName()

Returns:

historyFileName

startQuery

void startQuery(java.lang.String cmd,
                java.lang.String id)

Called at the start of query execution in Driver.execute().

setQueryProperty

void setQueryProperty(java.lang.String queryId,
                      HiveHistory.Keys propName,
                      java.lang.String propValue)

Used to set query status and other attributes of a query

Parameters:

queryId -

propName -

propValue -

setTaskProperty

void setTaskProperty(java.lang.String queryId,
                     java.lang.String taskId,
                     HiveHistory.Keys propName,
                     java.lang.String propValue)

Used to set task properties.

Parameters:

taskId -

propName -

propValue -

setTaskCounters

void setTaskCounters(java.lang.String queryId,
                     java.lang.String taskId,
                     Counters ctrs)

Serialize the task counters and set as a task property.

Parameters:

queryId -

taskId -

ctrs -

printRowCount

void printRowCount(java.lang.String queryId)

endQuery

void endQuery(java.lang.String queryId)

Called at the end of a query

Parameters:

queryId -

startTask

void startTask(java.lang.String queryId,
               Task<? extends java.io.Serializable> task,
               java.lang.String taskName)

Called at the start of a task. Called by Driver.run() A query can have multiple tasks. Tasks will have multiple operator.

Parameters:

task -

endTask

void endTask(java.lang.String queryId,
             Task<? extends java.io.Serializable> task)

Called at the end of a task.

Parameters:

task -

progressTask

void progressTask(java.lang.String queryId,
                  Task<? extends java.io.Serializable> task)

Logs progress of a task if ConfVars.HIVE_LOG_INCREMENTAL_PLAN_PROGRESS is set to true

Parameters:

task -

logPlanProgress

void logPlanProgress(QueryPlan plan)
              throws java.io.IOException

Logs the current plan state

Parameters:

plan -

Throws:

java.io.IOException

setIdToTableMap

void setIdToTableMap(java.util.Map<java.lang.String,java.lang.String> map)

Set the id to table name map

Parameters:

map -

closeStream

void closeStream()

Close the log file stream