org.apache.hadoop.hive.ql.exec

Class ExplainTask

java.lang.Object

org.apache.hadoop.hive.ql.exec.Task<ExplainWork>

org.apache.hadoop.hive.ql.exec.ExplainTask

All Implemented Interfaces:

Serializable, Node

public class ExplainTask
extends Task<ExplainWork>
implements Serializable

ExplainTask implementation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ExplainTask.MethodComparator MethodComparator.

Nested classes/interfaces inherited from class org.apache.hadoop.hive.ql.exec.Task

Task.FeedType, Task.TaskState

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXPL_COLUMN_NAME
static String	STAGE_DEPENDENCIES

Fields inherited from class org.apache.hadoop.hive.ql.exec.Task

BACKUP_COMMON_JOIN, backupChildrenTasks, backupTask, childTasks, clonedConf, COMMON_JOIN, conf, console, context, CONVERTED_MAPJOIN, CONVERTED_MAPJOIN_LOCAL, CONVERTED_SORTMERGEJOIN, deferredWorkContext, feedSubscribers, HINTED_MAPJOIN, HINTED_MAPJOIN_LOCAL, id, jobID, MAPJOIN_ONLY_NOBACKUP, NO_TAG, parentTasks, queryDisplay, queryPlan, queryState, rootTask, taskCounters, taskHandle, taskQueue, taskTag, work

Constructor Summary

Constructors

Constructor and Description
ExplainTask()

Method Summary

Modifier and Type	Method and Description
void	addConstraints(Table tbl, List<String> constraints, Set<String> allTableNames, DDLPlanUtils ddlPlanUtils)
void	addCreateTableStatement(Table table, List<String> tableCreateStmt, DDLPlanUtils ddlPlanUtils)
void	addExplain(String sql, List<String> explainStmt, DDLPlanUtils ddlPlanUtils)
void	addPKandBasicStats(Table tbl, List<String> basicDef, DDLPlanUtils ddlPlanUtils)
void	addStats(Table table, List<String> alterTableStmt, Map<String,List<Partition>> tablePartitionsMap, DDLPlanUtils ddlPlanUtils)
boolean	canExecuteInParallel()
int	execute() This method is overridden in each Task.
void	getDDLPlan(PrintStream out)
static String	getExplainOutput(BaseSemanticAnalyzer sem, QueryPlan plan, ASTNode astTree, QueryState queryState, Context context, HiveConf conf) Returns EXPLAIN EXTENDED output for a semantically analyzed query.
org.json.JSONObject	getJSONCBOPlan(PrintStream out, ExplainWork work)
org.json.JSONObject	getJSONLogicalPlan(PrintStream out, ExplainWork work)
org.json.JSONObject	getJSONPlan(PrintStream out, ExplainWork work)
org.json.JSONObject	getJSONPlan(PrintStream out, ExplainWork work, String stageIdRearrange)
org.json.JSONObject	getJSONPlan(PrintStream out, List<Task<?>> tasks, Task<?> fetchTask, boolean jsonOutput, boolean isExtended, boolean appendTaskType, String cboInfo, String cboPlan, String optimizedSQL)
org.json.JSONObject	getJSONPlan(PrintStream out, List<Task<?>> tasks, Task<?> fetchTask, boolean jsonOutput, boolean isExtended, boolean appendTaskType, String cboInfo, String cboPlan, String optimizedSQL, String stageIdRearrange)
String	getName()
static List<org.apache.hadoop.hive.metastore.api.FieldSchema>	getResultSchema()
StageType	getType() Should be overridden to return the type of the specific task among the types in StageType.
String	outputAST(String treeString, PrintStream out, boolean jsonOutput, int indent)
org.json.JSONObject	outputDependencies(PrintStream out, boolean jsonOutput, boolean appendTaskType, List<Task> tasks)
org.json.JSONObject	outputPlan(Object work, PrintStream out, boolean extended, boolean jsonOutput, int indent, String appendToHeader, boolean inTest)
org.json.JSONObject	outputStagePlans(PrintStream out, List<Task> tasks, boolean jsonOutput, boolean isExtended)

Methods inherited from class org.apache.hadoop.hive.ql.exec.Task

addDependentTask, cloneConf, done, equals, executeTask, findLeafs, getAndInitBackupTask, getBackupChildrenTasks, getBackupTask, getChildren, getChildTasks, getConf, getContext, getCounters, getDeferredWorkContext, getDependentTasks, getDiagnosticsMessage, getException, getExternalHandle, getFeedSubscribers, getHive, getId, getInitialized, getJobID, getMapWork, getNumChild, getNumParent, getParentTasks, getQueryPlan, getQueryState, getQueued, getReducer, getStatusMessage, getTaskHandle, getTaskQueue, getTaskState, getTaskTag, getTopOperators, getTxnMgr, getWork, hashCode, hasReduce, initialize, isFetchSource, isLocalMode, isMapRedLocalTask, isMapRedTask, isNotInitialized, isRootTask, isRunnable, pushFeed, receiveFeed, removeDependentTask, removeFromChildrenTasks, requireLock, setBackupChildrenTasks, setBackupTask, setChildTasks, setConf, setConsole, setDeferredWorkContext, setDiagnosticMessage, setDone, setException, setFeedSubscribers, setFetchSource, setId, setInitialized, setLocalMode, setParentTasks, setQueryDisplay, setQueryPlan, setQueued, setRootTask, setStarted, setState, setStatusMessage, setTaskQueue, setTaskTag, setWork, shutdown, started, subscribeFeed, toString, updateStatusInQueryDisplay, updateTaskMetrics

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

STAGE_DEPENDENCIES

public static final String STAGE_DEPENDENCIES

See Also:

Constant Field Values

EXPL_COLUMN_NAME

public static final String EXPL_COLUMN_NAME

See Also:

Constant Field Values

Constructor Detail

ExplainTask

public ExplainTask()

Method Detail

getJSONCBOPlan

public org.json.JSONObject getJSONCBOPlan(PrintStream out,
                                          ExplainWork work)

getJSONLogicalPlan

public org.json.JSONObject getJSONLogicalPlan(PrintStream out,
                                              ExplainWork work)
                                       throws Exception

Throws:

Exception

getJSONPlan

public org.json.JSONObject getJSONPlan(PrintStream out,
                                       ExplainWork work)
                                throws Exception

Throws:

Exception

getJSONPlan

public org.json.JSONObject getJSONPlan(PrintStream out,
                                       ExplainWork work,
                                       String stageIdRearrange)
                                throws Exception

Throws:

Exception

getJSONPlan

public org.json.JSONObject getJSONPlan(PrintStream out,
                                       List<Task<?>> tasks,
                                       Task<?> fetchTask,
                                       boolean jsonOutput,
                                       boolean isExtended,
                                       boolean appendTaskType,
                                       String cboInfo,
                                       String cboPlan,
                                       String optimizedSQL)
                                throws Exception

Throws:

Exception

getJSONPlan

public org.json.JSONObject getJSONPlan(PrintStream out,
                                       List<Task<?>> tasks,
                                       Task<?> fetchTask,
                                       boolean jsonOutput,
                                       boolean isExtended,
                                       boolean appendTaskType,
                                       String cboInfo,
                                       String cboPlan,
                                       String optimizedSQL,
                                       String stageIdRearrange)
                                throws Exception

Throws:

Exception

addCreateTableStatement

public void addCreateTableStatement(Table table,
                                    List<String> tableCreateStmt,
                                    DDLPlanUtils ddlPlanUtils)

addPKandBasicStats

public void addPKandBasicStats(Table tbl,
                               List<String> basicDef,
                               DDLPlanUtils ddlPlanUtils)

addConstraints

public void addConstraints(Table tbl,
                           List<String> constraints,
                           Set<String> allTableNames,
                           DDLPlanUtils ddlPlanUtils)

addStats

public void addStats(Table table,
                     List<String> alterTableStmt,
                     Map<String,List<Partition>> tablePartitionsMap,
                     DDLPlanUtils ddlPlanUtils)
              throws HiveException,
                     org.apache.hadoop.hive.metastore.api.MetaException

Throws:

HiveException

org.apache.hadoop.hive.metastore.api.MetaException

addExplain

public void addExplain(String sql,
                       List<String> explainStmt,
                       DDLPlanUtils ddlPlanUtils)

getDDLPlan

public void getDDLPlan(PrintStream out)
                throws Exception

Throws:

Exception

execute

public int execute()

Description copied from class: Task

This method is overridden in each Task. TODO execute should return a TaskHandle.

Specified by:

execute in class Task<ExplainWork>

Returns:

status of executing the task

outputPlan

public org.json.JSONObject outputPlan(Object work,
                                      PrintStream out,
                                      boolean extended,
                                      boolean jsonOutput,
                                      int indent,
                                      String appendToHeader,
                                      boolean inTest)
                               throws Exception

Throws:

Exception

outputAST

public String outputAST(String treeString,
                        PrintStream out,
                        boolean jsonOutput,
                        int indent)
                 throws org.json.JSONException

Throws:

org.json.JSONException

outputDependencies

public org.json.JSONObject outputDependencies(PrintStream out,
                                              boolean jsonOutput,
                                              boolean appendTaskType,
                                              List<Task> tasks)
                                       throws Exception

Throws:

Exception

outputStagePlans

public org.json.JSONObject outputStagePlans(PrintStream out,
                                            List<Task> tasks,
                                            boolean jsonOutput,
                                            boolean isExtended)
                                     throws Exception

Throws:

Exception

getType

public StageType getType()

Description copied from class: Task

Should be overridden to return the type of the specific task among the types in StageType.

Specified by:

getType in class Task<ExplainWork>

Returns:

StageType.* or null if not overridden

getName

public String getName()

Specified by:

getName in interface Node

getResultSchema

public static List<org.apache.hadoop.hive.metastore.api.FieldSchema> getResultSchema()

canExecuteInParallel

public boolean canExecuteInParallel()

Overrides:

canExecuteInParallel in class Task<ExplainWork>

getExplainOutput

public static String getExplainOutput(BaseSemanticAnalyzer sem,
                                      QueryPlan plan,
                                      ASTNode astTree,
                                      QueryState queryState,
                                      Context context,
                                      HiveConf conf)
                               throws IOException

Returns EXPLAIN EXTENDED output for a semantically analyzed query.

Parameters:

sem - semantic analyzer for analyzed query

plan - query plan

astTree - AST tree dump

Throws:

IOException