org.apache.hadoop.hive.ql

Class Driver

java.lang.Object

org.apache.hadoop.hive.ql.Driver

All Implemented Interfaces:

AutoCloseable, IDriver, CommandProcessor

public class Driver
extends Object
implements IDriver

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Driver.LockedDriverState

Constructor Summary

Constructors

Constructor and Description
Driver(HiveConf conf)
Driver(HiveConf conf, Context ctx, LineageState lineageState)
Driver(HiveConf conf, LineageState lineageState)
Driver(HiveConf conf, String userName, LineageState lineageState)
Driver(QueryState queryState, String userName)
Driver(QueryState queryState, String userName, QueryInfo queryInfo)
Driver(QueryState queryState, String userName, QueryInfo queryInfo, HiveTxnManager txnMgr)

Method Summary

Modifier and Type	Method and Description
void	close()
int	compile(String command) Compile a new query.
int	compile(String command, boolean resetTaskIds) Compile a new query, but potentially reset taskID counter.
CommandProcessorResponse	compileAndRespond(String command)
CommandProcessorResponse	compileAndRespond(String command, boolean cleanupTxnList)
void	destroy()
static void	doAuthorization(HiveOperation op, BaseSemanticAnalyzer sem, String command) Do authorization using post semantic analysis information in the semantic analyzer The original command is also passed so that authorization interface can provide more useful information in logs.
org.apache.hadoop.mapred.ClusterStatus	getClusterStatus() Return the status information about the Map-Reduce cluster
HiveConf	getConf()
Context	getContext()
String	getErrorMsg()
org.apache.hadoop.hive.metastore.api.Schema	getExplainSchema()
FetchTask	getFetchTask()
HookRunner	getHookRunner()
int	getMaxRows() Return the maximum number of rows returned by getResults
QueryPlan	getPlan()
PlanMapper	getPlanMapper()
QueryDisplay	getQueryDisplay()
org.apache.hadoop.hive.ql.plan.api.Query	getQueryPlan()
QueryState	getQueryState()
boolean	getResults(List res)
org.apache.hadoop.hive.metastore.api.Schema	getSchema()
StatsSource	getStatsSource()
org.apache.hadoop.hive.metastore.api.Schema	getThriftSchema() Get a Schema with fields represented with Thrift DDL types
boolean	hasResultSet()
boolean	isFetchingTable()
void	lockAndRespond()
void	releaseLocksAndCommitOrRollback(boolean commit)
void	releaseLocksAndCommitOrRollback(boolean commit, HiveTxnManager txnManager)
void	releaseResources() Release some resources after a query is executed while keeping the result around.
void	resetFetch()
CommandProcessorResponse	run()
CommandProcessorResponse	run(String command)
CommandProcessorResponse	run(String command, boolean alreadyCompiled)
void	setCompactionWriteIds(org.apache.hadoop.hive.common.ValidWriteIdList val)
void	setMaxRows(int maxRows) Set the maximum number of rows returned by getResults
void	setOperationId(String opId) Set the HS2 operation handle's guid string
void	setStatsSource(StatsSource runtimeStatsSource)

Methods inherited from class java.lang.Object

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

Constructor Detail

Driver

public Driver(HiveConf conf)

Driver

public Driver(HiveConf conf,
              LineageState lineageState)

Driver

public Driver(HiveConf conf,
              Context ctx,
              LineageState lineageState)

Driver

public Driver(HiveConf conf,
              String userName,
              LineageState lineageState)

Driver

public Driver(QueryState queryState,
              String userName)

Driver

public Driver(QueryState queryState,
              String userName,
              QueryInfo queryInfo)

Driver

public Driver(QueryState queryState,
              String userName,
              QueryInfo queryInfo,
              HiveTxnManager txnMgr)

Method Detail

getClusterStatus

public org.apache.hadoop.mapred.ClusterStatus getClusterStatus()
                                                        throws Exception

Return the status information about the Map-Reduce cluster

Throws:

Exception

getSchema

public org.apache.hadoop.hive.metastore.api.Schema getSchema()

Specified by:

getSchema in interface IDriver

getExplainSchema

public org.apache.hadoop.hive.metastore.api.Schema getExplainSchema()

getContext

public Context getContext()

Specified by:

getContext in interface IDriver

getPlanMapper

public PlanMapper getPlanMapper()

getThriftSchema

public org.apache.hadoop.hive.metastore.api.Schema getThriftSchema()
                                                            throws Exception

Get a Schema with fields represented with Thrift DDL types

Throws:

Exception

getMaxRows

public int getMaxRows()

Return the maximum number of rows returned by getResults

setMaxRows

public void setMaxRows(int maxRows)

Set the maximum number of rows returned by getResults

Specified by:

setMaxRows in interface IDriver

compile

public int compile(String command)

Compile a new query. Any currently-planned query associated with this Driver is discarded. Do not reset id for inner queries(index, etc). Task ids are used for task identity check.

Specified by:

compile in interface IDriver

Parameters:

command - The SQL query to compile.

compile

public int compile(String command,
                   boolean resetTaskIds)

Compile a new query, but potentially reset taskID counter. Not resetting task counter is useful for generating re-entrant QL queries.

Parameters:

command - The HiveQL query to compile

resetTaskIds - Resets taskID counter if true.

Returns:

0 for ok

doAuthorization

public static void doAuthorization(HiveOperation op,
                                   BaseSemanticAnalyzer sem,
                                   String command)
                            throws HiveException,
                                   AuthorizationException

Do authorization using post semantic analysis information in the semantic analyzer The original command is also passed so that authorization interface can provide more useful information in logs.

Parameters:

sem - SemanticAnalyzer used to parse input query

command - input query

Throws:

HiveException

AuthorizationException

getConf

public HiveConf getConf()

Specified by:

getConf in interface IDriver

getPlan

public QueryPlan getPlan()

Specified by:

getPlan in interface IDriver

Returns:

The current query plan associated with this Driver, if any.

getFetchTask

public FetchTask getFetchTask()

Specified by:

getFetchTask in interface IDriver

Returns:

The current FetchTask associated with the Driver's plan, if any.

releaseLocksAndCommitOrRollback

public void releaseLocksAndCommitOrRollback(boolean commit)
                                     throws LockException

Throws:

LockException

releaseLocksAndCommitOrRollback

public void releaseLocksAndCommitOrRollback(boolean commit,
                                            HiveTxnManager txnManager)
                                     throws LockException

Parameters:

commit - if there is an open transaction and if true, commit, if false rollback. If there is no open transaction this parameter is ignored.

txnManager - an optional existing transaction manager retrieved earlier from the session

Throws:

LockException

releaseResources

public void releaseResources()

Release some resources after a query is executed while keeping the result around.

run

public CommandProcessorResponse run(String command)

Specified by:

run in interface IDriver

Specified by:

run in interface CommandProcessor

run

public CommandProcessorResponse run()

Specified by:

run in interface IDriver

run

public CommandProcessorResponse run(String command,
                                    boolean alreadyCompiled)

compileAndRespond

public CommandProcessorResponse compileAndRespond(String command)

Specified by:

compileAndRespond in interface IDriver

compileAndRespond

public CommandProcessorResponse compileAndRespond(String command,
                                                  boolean cleanupTxnList)

lockAndRespond

public void lockAndRespond()
                    throws CommandProcessorResponse

Throws:

CommandProcessorResponse

isFetchingTable

public boolean isFetchingTable()

Specified by:

isFetchingTable in interface IDriver

getResults

public boolean getResults(List res)
                   throws IOException

Specified by:

getResults in interface IDriver

Throws:

IOException

resetFetch

public void resetFetch()
                throws IOException

Specified by:

resetFetch in interface IDriver

Throws:

IOException

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface IDriver

destroy

public void destroy()

Specified by:

destroy in interface IDriver

getQueryPlan

public org.apache.hadoop.hive.ql.plan.api.Query getQueryPlan()
                                                      throws IOException

Throws:

IOException

getErrorMsg

public String getErrorMsg()

getQueryDisplay

public QueryDisplay getQueryDisplay()

Specified by:

getQueryDisplay in interface IDriver

setOperationId

public void setOperationId(String opId)

Set the HS2 operation handle's guid string

Specified by:

setOperationId in interface IDriver

Parameters:

opId - base64 encoded guid string

getQueryState

public QueryState getQueryState()

getHookRunner

public HookRunner getHookRunner()

setStatsSource

public void setStatsSource(StatsSource runtimeStatsSource)

getStatsSource

public StatsSource getStatsSource()

hasResultSet

public boolean hasResultSet()

Specified by:

hasResultSet in interface IDriver

setCompactionWriteIds

public void setCompactionWriteIds(org.apache.hadoop.hive.common.ValidWriteIdList val)