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

Compiles and executes HQL commands.

Constructor Summary

Constructors

Constructor and Description
Driver(HiveConf conf)
Driver(HiveConf conf, Context ctx, LineageState lineageState)
Driver(QueryState queryState)
Driver(QueryState queryState, long analyzeTableWriteId)
Driver(QueryState queryState, QueryInfo queryInfo)
Driver(QueryState queryState, QueryInfo queryInfo, HiveTxnManager txnManager)
Driver(QueryState queryState, ValidWriteIdList compactionWriteIds, long compactorTxnId)

Method Summary

Modifier and Type	Method and Description
void	close()
int	compile(String command, boolean resetTaskIds) Compiles a new HQL command, but potentially resets taskID counter.
void	compile(String command, boolean resetTaskIds, boolean deferClose) Compiles an HQL command, creates an execution plan for it.
CommandProcessorResponse	compileAndRespond(String command)
CommandProcessorResponse	compileAndRespond(String command, boolean cleanupTxnList)
void	destroy()
HiveConf	getConf()
Context	getContext()
FetchTask	getFetchTask()
HookRunner	getHookRunner()
QueryPlan	getPlan()
PlanMapper	getPlanMapper()
QueryDisplay	getQueryDisplay()
QueryState	getQueryState()
boolean	getResults(List results)
org.apache.hadoop.hive.metastore.api.Schema	getSchema()
StatsSource	getStatsSource()
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() Executes a previously compiled HQL command.
CommandProcessorResponse	run(String command) Compiles and executes an HQL command.
void	setMaxRows(int maxRows) Set the maximum number of rows returned by getResults.
void	setOperationId(String operationId) 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,
              Context ctx,
              LineageState lineageState)

Driver

public Driver(QueryState queryState)

Driver

public Driver(QueryState queryState,
              QueryInfo queryInfo)

Driver

public Driver(QueryState queryState,
              ValidWriteIdList compactionWriteIds,
              long compactorTxnId)

Driver

public Driver(QueryState queryState,
              long analyzeTableWriteId)

Driver

public Driver(QueryState queryState,
              QueryInfo queryInfo,
              HiveTxnManager txnManager)

Method Detail

getContext

public Context getContext()

Specified by:

getContext in interface IDriver

getConf

public HiveConf getConf()

Specified by:

getConf in interface IDriver

run

public CommandProcessorResponse run(String command)
                             throws CommandProcessorException

Compiles and executes an HQL command.

Specified by:

run in interface IDriver

Specified by:

run in interface CommandProcessor

Throws:

CommandProcessorException

run

public CommandProcessorResponse run()
                             throws CommandProcessorException

Executes a previously compiled HQL command.

Specified by:

run in interface IDriver

Throws:

CommandProcessorException

lockAndRespond

public void lockAndRespond()
                    throws CommandProcessorException

Throws:

CommandProcessorException

compileAndRespond

public CommandProcessorResponse compileAndRespond(String command)
                                           throws CommandProcessorException

Specified by:

compileAndRespond in interface IDriver

Throws:

CommandProcessorException

compileAndRespond

public CommandProcessorResponse compileAndRespond(String command,
                                                  boolean cleanupTxnList)
                                           throws CommandProcessorException

Throws:

CommandProcessorException

compile

public int compile(String command,
                   boolean resetTaskIds)

Compiles a new HQL command, but potentially resets 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

compile

public void compile(String command,
                    boolean resetTaskIds,
                    boolean deferClose)
             throws CommandProcessorException

Compiles an HQL command, creates an execution plan for it.

Parameters:

command - The HiveQL query to compile

resetTaskIds - Resets taskID counter if true.

deferClose - indicates if the close/destroy should be deferred when the process has been interrupted, it should be set to true if the compile is called within another method like runInternal, which defers the close to the called in that method.

Throws:

CommandProcessorException

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.

getPlanMapper

public PlanMapper getPlanMapper()

isFetchingTable

public boolean isFetchingTable()

Specified by:

isFetchingTable in interface IDriver

getSchema

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

Specified by:

getSchema in interface IDriver

hasResultSet

public boolean hasResultSet()

Specified by:

hasResultSet in interface IDriver

resetFetch

public void resetFetch()
                throws IOException

Specified by:

resetFetch in interface IDriver

Throws:

IOException

setMaxRows

public void setMaxRows(int maxRows)

Set the maximum number of rows returned by getResults.

Specified by:

setMaxRows in interface IDriver

getResults

public boolean getResults(List results)
                   throws IOException

Specified by:

getResults 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

getQueryDisplay

public QueryDisplay getQueryDisplay()

Specified by:

getQueryDisplay in interface IDriver

setOperationId

public void setOperationId(String operationId)

Set the HS2 operation handle's guid string.

Specified by:

setOperationId in interface IDriver

Parameters:

operationId - base64 encoded guid string

getQueryState

public QueryState getQueryState()

Specified by:

getQueryState in interface IDriver

getHookRunner

public HookRunner getHookRunner()

setStatsSource

public void setStatsSource(StatsSource runtimeStatsSource)

getStatsSource

public StatsSource getStatsSource()