QueryPlan (Hive Query Language 4.0.0 API)

java.lang.Object
- org.apache.hadoop.hive.ql.QueryPlan

All Implemented Interfaces:

Serializable
```
public class QueryPlan
extends Object
implements Serializable
```
QueryPlan can be serialized to disk so that we can restart/resume the progress of it in the future, either within or outside of the current jvm.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected LineageInfo linfo
Lineage information for the query.

Fields
Modifier and Type	Field and Description
`protected LineageInfo`	`linfo` Lineage information for the query.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`QueryPlan()`
`protected`	`QueryPlan(HiveOperation command)`
	`QueryPlan(String queryString, BaseSemanticAnalyzer sem, Long startTime, String queryId, HiveOperation operation, org.apache.hadoop.hive.metastore.api.Schema resultSchema)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WriteEntity`	`getAcidAnalyzeTable()`
`Boolean`	`getAutoCommitValue()`
`String`	`getCboInfo()`
`ColumnAccessInfo`	`getColumnAccessInfo()` Gets the column access information.
`Map<String,Map<String,Long>>`	`getCounters()`
`Set<String>`	`getDone()`
`Map<String,List<org.apache.hadoop.fs.Path>>`	`getDynamicPartitionSpecs(long writeId, String moveTaskId, AcidUtils.Operation acidOperation, org.apache.hadoop.fs.Path path)` This method is to get the dynamic partition specifications inserted by the FileSinkOperator, a particular MoveTask belongs to.
`FetchTask`	`getFetchTask()`
`Map<String,String>`	`getIdToTableNameMap()`
`Set<ReadEntity>`	`getInputs()`
`String`	`getJSONKeyValue(Object key, Object value)`
`String`	`getJSONMap(Map map)`
`String`	`getJSONQuery(Query query)`
`String`	`getJSONValue(Object value)`
`LineageInfo`	`getLineageInfo()` Gets the lineage information.
`HiveOperation`	`getOperation()`
`String`	`getOperationName()`
`String`	`getOptimizedCBOPlan()`
`String`	`getOptimizedQueryString()`
`Set<WriteEntity>`	`getOutputs()`
`Query`	`getQuery()`
`String`	`getQueryId()`
`Query`	`getQueryPlan()`
`QueryProperties`	`getQueryProperties()`
`Long`	`getQueryStartTime()`
`String`	`getQueryStr()`
`String`	`getQueryString()`
`List<ReducerTimeStatsPerJob>`	`getReducerTimeStatsPerJobList()`
`org.apache.hadoop.hive.metastore.api.Schema`	`getResultSchema()`
`List<Task<?>>`	`getRootTasks()`
`Set<String>`	`getStarted()`
`Integer`	`getStatementIdForAcidWriteType(long writeId, String moveTaskId, AcidUtils.Operation acidOperation, org.apache.hadoop.fs.Path path, int originalStatementId)` This method is to get the proper statementId for the FileSinkOperator, a particular MoveTask belongs to.
`TableAccessInfo`	`getTableAccessInfo()` Gets the table access information.
`boolean`	`hasAcidResourcesInQuery()`
`boolean`	`isExplain()`
`boolean`	`isForExplain()`
`boolean`	`isPrepareQuery()`
`static String`	`makeQueryId()`
`void`	`setColumnAccessInfo(ColumnAccessInfo columnAccessInfo)` Sets the column access information.
`void`	`setDone()`
`void`	`setFetchTask(FetchTask fetchTask)`
`void`	`setIdToTableNameMap(Map<String,String> idToTableNameMap)`
`void`	`setInputs(HashSet<ReadEntity> inputs)`
`void`	`setLineageInfo(LineageInfo linfo)` Sets the lineage information.
`void`	`setOptimizedCBOPlan(String optimizedCBOPlan)`
`void`	`setOptimizedQueryString(String optimizedQueryString)`
`void`	`setOutputs(HashSet<WriteEntity> outputs)`
`void`	`setPrepareQuery(boolean prepareQuery)`
`void`	`setQuery(Query query)`
`void`	`setQueryId(String queryId)`
`void`	`setQueryStartTime(Long queryStartTime)`
`void`	`setQueryString(String queryString)`
`void`	`setRootTasks(List<Task<?>> rootTasks)`
`void`	`setStarted()`
`void`	`setTableAccessInfo(TableAccessInfo tableAccessInfo)` Sets the table access information.
`String`	`toBinaryString()`
`String`	`toString()`
`String`	`toThriftJSONString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - linfo
```
protected LineageInfo linfo
```
    Lineage information for the query.
- Constructor Detail
  - QueryPlan
```
public QueryPlan()
```
  - QueryPlan
```
protected QueryPlan(HiveOperation command)
```
  - QueryPlan
```
public QueryPlan(String queryString,
                 BaseSemanticAnalyzer sem,
                 Long startTime,
                 String queryId,
                 HiveOperation operation,
                 org.apache.hadoop.hive.metastore.api.Schema resultSchema)
```
- Method Detail
  - hasAcidResourcesInQuery
```
public boolean hasAcidResourcesInQuery()
```
    Returns:
    
    true if any acid resources are read/written
  - getAcidAnalyzeTable
```
public WriteEntity getAcidAnalyzeTable()
```
  - getStatementIdForAcidWriteType
```
public Integer getStatementIdForAcidWriteType(long writeId,
                                              String moveTaskId,
                                              AcidUtils.Operation acidOperation,
                                              org.apache.hadoop.fs.Path path,
                                              int originalStatementId)
```
    This method is to get the proper statementId for the FileSinkOperator, a particular MoveTask belongs to. This is needed for ACID operations with direct insert on. In this case for listing the newly added or modified data the MoveTask has to know the statementId in order to list the files from the proper folder. Without knowing the statementId the files could be listed by multiple MoveTasks which could cause issues. To get the statementId, first the FSO has to be found in the acidSinks list. To do that, use the ACID operation, the path, the writeId and the moveTaskId. For queries with union all optimisation, there will be multiple FSOs with the same operation, writeId and moveTaskId. But one of these FSOs doesn't write data and its statementId is not valid, so if this FSO is selected and its statementId is returned, the file listing will find nothing. So check the acidSinks and if two of them have the same writeId, path and moveTaskId, then return -1 as statementId. With doing this, the file listing will find all partitions and files correctly.
    
    Parameters:
    
    writeId -
    
    moveTaskId -
    
    acidOperation -
    
    path -
    
    Returns:
    
    The statementId from the FileSinkOperator with the given writeId, moveTaskId, operation and path. -1 if there are multiple FileSinkOperators with the same value of these parameters. The original statement id if there were no matching acid sinks.
  - getDynamicPartitionSpecs
```
public Map<String,List<org.apache.hadoop.fs.Path>> getDynamicPartitionSpecs(long writeId,
                                                                            String moveTaskId,
                                                                            AcidUtils.Operation acidOperation,
                                                                            org.apache.hadoop.fs.Path path)
```
    This method is to get the dynamic partition specifications inserted by the FileSinkOperator, a particular MoveTask belongs to. This is needed for insert overwrite queries for ACID tables with direct insert on, so each MoveTask could list only the files inserted by the FSO the MoveTask belongs to. In case of an insert query, the writeId and statementId is enough to identify which delta directory was written by which FSO. But in case of insert overwrite, base directories will be created without statementIds, so we need the partition information to identify which folders to list. For queries with union all optimisation, there will be multiple FSOs with the same operation, writeId and moveTaskId. But one of these FSOs doesn't contain the partition specifications, so if this FSO is selected, the file listing will not be correct. So check the acidSinks and if two of them have the same writeId, path and moveTaskId, then return null. With doing this, the file listing will find all partitions and files correctly.
    
    Parameters:
    
    writeId -
    
    moveTaskId -
    
    acidOperation -
    
    path -
    
    Returns:
    
    The dynamic partition specifications from the FileSinkOperator with the given writeId, moveTaskId, operation and path. null if there are multiple FileSinkOperators with the same value of these parameters.
  - getQueryStr
```
public String getQueryStr()
```
  - getQueryId
```
public String getQueryId()
```
  - setPrepareQuery
```
public void setPrepareQuery(boolean prepareQuery)
```
  - isPrepareQuery
```
public boolean isPrepareQuery()
```
  - makeQueryId
```
public static String makeQueryId()
```
  - getQueryPlan
```
public Query getQueryPlan()
                   throws IOException
```
    Throws:
    
    IOException
  - getJSONValue
```
public String getJSONValue(Object value)
```
  - getJSONKeyValue
```
public String getJSONKeyValue(Object key,
                              Object value)
```
  - getJSONMap
```
public String getJSONMap(Map map)
```
  - getJSONQuery
```
public String getJSONQuery(Query query)
```
  - isExplain
```
public boolean isExplain()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toThriftJSONString
```
public String toThriftJSONString()
                          throws IOException
```
    Throws:
    
    IOException
  - toBinaryString
```
public String toBinaryString()
                      throws IOException
```
    Throws:
    
    IOException
  - setStarted
```
public void setStarted()
```
  - setDone
```
public void setDone()
```
  - getStarted
```
public Set<String> getStarted()
```
  - getDone
```
public Set<String> getDone()
```
  - getRootTasks
```
public List<Task<?>> getRootTasks()
```
  - setRootTasks
```
public void setRootTasks(List<Task<?>> rootTasks)
```
  - isForExplain
```
public boolean isForExplain()
```
  - getFetchTask
```
public FetchTask getFetchTask()
```
  - setFetchTask
```
public void setFetchTask(FetchTask fetchTask)
```
  - getInputs
```
public Set<ReadEntity> getInputs()
```
  - setInputs
```
public void setInputs(HashSet<ReadEntity> inputs)
```
  - getOutputs
```
public Set<WriteEntity> getOutputs()
```
  - setOutputs
```
public void setOutputs(HashSet<WriteEntity> outputs)
```
  - getResultSchema
```
public org.apache.hadoop.hive.metastore.api.Schema getResultSchema()
```
  - getIdToTableNameMap
```
public Map<String,String> getIdToTableNameMap()
```
  - setIdToTableNameMap
```
public void setIdToTableNameMap(Map<String,String> idToTableNameMap)
```
  - getQueryString
```
public String getQueryString()
```
  - setQueryString
```
public void setQueryString(String queryString)
```
  - getOptimizedQueryString
```
public String getOptimizedQueryString()
```
  - setOptimizedQueryString
```
public void setOptimizedQueryString(String optimizedQueryString)
```
  - getOptimizedCBOPlan
```
public String getOptimizedCBOPlan()
```
  - setOptimizedCBOPlan
```
public void setOptimizedCBOPlan(String optimizedCBOPlan)
```
  - getQuery
```
public Query getQuery()
```
  - getReducerTimeStatsPerJobList
```
public List<ReducerTimeStatsPerJob> getReducerTimeStatsPerJobList()
```
  - setQuery
```
public void setQuery(Query query)
```
  - getCounters
```
public Map<String,Map<String,Long>> getCounters()
```
  - setQueryId
```
public void setQueryId(String queryId)
```
  - getLineageInfo
```
public LineageInfo getLineageInfo()
```
    Gets the lineage information.
    
    Returns:
    
    LineageInfo associated with the query.
  - setLineageInfo
```
public void setLineageInfo(LineageInfo linfo)
```
    Sets the lineage information.
    
    Parameters:
    
    linfo - The LineageInfo structure that is set in the optimization phase.
  - getTableAccessInfo
```
public TableAccessInfo getTableAccessInfo()
```
    Gets the table access information.
    
    Returns:
    
    TableAccessInfo associated with the query.
  - setTableAccessInfo
```
public void setTableAccessInfo(TableAccessInfo tableAccessInfo)
```
    Sets the table access information.
    
    Parameters:
    
    tableAccessInfo - The TableAccessInfo structure that is set right before the optimization phase.
  - getColumnAccessInfo
```
public ColumnAccessInfo getColumnAccessInfo()
```
    Gets the column access information.
    
    Returns:
    
    ColumnAccessInfo associated with the query.
  - setColumnAccessInfo
```
public void setColumnAccessInfo(ColumnAccessInfo columnAccessInfo)
```
    Sets the column access information.
    
    Parameters:
    
    columnAccessInfo - The ColumnAccessInfo structure that is set immediately after the optimization phase.
  - getQueryProperties
```
public QueryProperties getQueryProperties()
```
  - getQueryStartTime
```
public Long getQueryStartTime()
```
  - setQueryStartTime
```
public void setQueryStartTime(Long queryStartTime)
```
  - getOperationName
```
public String getOperationName()
```
  - getOperation
```
public HiveOperation getOperation()
```
  - getAutoCommitValue
```
public Boolean getAutoCommitValue()
```
  - getCboInfo
```
public String getCboInfo()
```

Class QueryPlan

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

linfo

Constructor Detail

QueryPlan

QueryPlan

QueryPlan

Method Detail

hasAcidResourcesInQuery

getAcidAnalyzeTable

getStatementIdForAcidWriteType

getDynamicPartitionSpecs

getQueryStr

getQueryId

setPrepareQuery

isPrepareQuery

makeQueryId

getQueryPlan

getJSONValue

getJSONKeyValue

getJSONMap

getJSONQuery

isExplain

toString

toThriftJSONString

toBinaryString

setStarted

setDone

getStarted

getDone

getRootTasks

setRootTasks

isForExplain

getFetchTask

setFetchTask

getInputs

setInputs

getOutputs

setOutputs

getResultSchema

getIdToTableNameMap

setIdToTableNameMap

getQueryString

setQueryString

getOptimizedQueryString

setOptimizedQueryString

getOptimizedCBOPlan

setOptimizedCBOPlan

getQuery

getReducerTimeStatsPerJobList

setQuery

getCounters

setQueryId

getLineageInfo

setLineageInfo

getTableAccessInfo

setTableAccessInfo

getColumnAccessInfo

setColumnAccessInfo

getQueryProperties

getQueryStartTime

setQueryStartTime

getOperationName

getOperation

getAutoCommitValue

getCboInfo