org.apache.hive.service.cli.operation

Class Operation

java.lang.Object

org.apache.hive.service.cli.operation.Operation

Direct Known Subclasses:

ExecuteStatementOperation, MetadataOperation

public abstract class Operation
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected Future<?>	backgroundHandle
static long	DEFAULT_FETCH_MAX_ROWS
static FetchOrientation	DEFAULT_FETCH_ORIENTATION
protected static EnumSet<FetchOrientation>	DEFAULT_FETCH_ORIENTATION_SET
protected boolean	hasResultSet
protected boolean	isOperationLogEnabled
static org.apache.commons.logging.Log	LOG
protected HiveSQLException	operationException
protected OperationLog	operationLog
protected HiveSession	parentSession
protected boolean	runAsync

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Operation(HiveSession parentSession, OperationType opType, boolean runInBackground)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	afterRun() Invoked after runInternal(), even if an exception is thrown in runInternal().
protected void	assertState(OperationState state)
protected void	beforeRun() Invoked before runInternal().
void	cancel()
protected void	cleanupOperationLog()
abstract void	close()
protected void	createOperationLog()
Future<?>	getBackgroundHandle()
HiveConf	getConfiguration()
OperationHandle	getHandle()
long	getLastAccessTime()
RowSet	getNextRowSet()
abstract RowSet	getNextRowSet(FetchOrientation orientation, long maxRows)
OperationLog	getOperationLog()
long	getOperationTimeout()
HiveSession	getParentSession()
TProtocolVersion	getProtocolVersion()
abstract TableSchema	getResultSetSchema()
OperationStatus	getStatus()
OperationType	getType()
boolean	hasResultSet()
boolean	isCanceled()
boolean	isFailed()
boolean	isFinished()
boolean	isRunning()
boolean	isTimedOut(long current)
void	run()
protected abstract void	runInternal() Implemented by subclass of Operation class to execute specific behaviors.
protected void	setBackgroundHandle(Future<?> backgroundHandle)
void	setConfiguration(HiveConf configuration)
protected void	setHasResultSet(boolean hasResultSet)
protected void	setOperationException(HiveSQLException operationException)
void	setOperationTimeout(long operationTimeout)
protected OperationState	setState(OperationState newState)
boolean	shouldRunAsync()
protected HiveSQLException	toSQLException(String prefix, CommandProcessorResponse response)
protected void	unregisterOperationLog()
protected void	validateDefaultFetchOrientation(FetchOrientation orientation) Verify if the given fetch orientation is part of the default orientation types.
protected void	validateFetchOrientation(FetchOrientation orientation, EnumSet<FetchOrientation> supportedOrientations) Verify if the given fetch orientation is part of the supported orientation types.

Methods inherited from class java.lang.Object

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

Field Detail

parentSession

protected final HiveSession parentSession

LOG

public static final org.apache.commons.logging.Log LOG

DEFAULT_FETCH_ORIENTATION

public static final FetchOrientation DEFAULT_FETCH_ORIENTATION

DEFAULT_FETCH_MAX_ROWS

public static final long DEFAULT_FETCH_MAX_ROWS

See Also:

Constant Field Values

hasResultSet

protected boolean hasResultSet

operationException

protected volatile HiveSQLException operationException

runAsync

protected final boolean runAsync

backgroundHandle

protected volatile Future<?> backgroundHandle

operationLog

protected OperationLog operationLog

isOperationLogEnabled

protected boolean isOperationLogEnabled

DEFAULT_FETCH_ORIENTATION_SET

protected static final EnumSet<FetchOrientation> DEFAULT_FETCH_ORIENTATION_SET

Constructor Detail

Operation

protected Operation(HiveSession parentSession,
         OperationType opType,
         boolean runInBackground)

Method Detail

getBackgroundHandle

public Future<?> getBackgroundHandle()

setBackgroundHandle

protected void setBackgroundHandle(Future<?> backgroundHandle)

shouldRunAsync

public boolean shouldRunAsync()

setConfiguration

public void setConfiguration(HiveConf configuration)

getConfiguration

public HiveConf getConfiguration()

getParentSession

public HiveSession getParentSession()

getHandle

public OperationHandle getHandle()

getProtocolVersion

public TProtocolVersion getProtocolVersion()

getType

public OperationType getType()

getStatus

public OperationStatus getStatus()

hasResultSet

public boolean hasResultSet()

setHasResultSet

protected void setHasResultSet(boolean hasResultSet)

getOperationLog

public OperationLog getOperationLog()

setState

protected final OperationState setState(OperationState newState)
                                 throws HiveSQLException

Throws:

HiveSQLException

isTimedOut

public boolean isTimedOut(long current)

getLastAccessTime

public long getLastAccessTime()

getOperationTimeout

public long getOperationTimeout()

setOperationTimeout

public void setOperationTimeout(long operationTimeout)

setOperationException

protected void setOperationException(HiveSQLException operationException)

assertState

protected final void assertState(OperationState state)
                          throws HiveSQLException

Throws:

HiveSQLException

isRunning

public boolean isRunning()

isFinished

public boolean isFinished()

isCanceled

public boolean isCanceled()

isFailed

public boolean isFailed()

createOperationLog

protected void createOperationLog()

unregisterOperationLog

protected void unregisterOperationLog()

beforeRun

protected void beforeRun()

Invoked before runInternal(). Set up some preconditions, or configurations.

afterRun

protected void afterRun()

Invoked after runInternal(), even if an exception is thrown in runInternal(). Clean up resources, which was set up in beforeRun().

runInternal

protected abstract void runInternal()
                             throws HiveSQLException

Implemented by subclass of Operation class to execute specific behaviors.

Throws:

HiveSQLException

run

public void run()
         throws HiveSQLException

Throws:

HiveSQLException

cleanupOperationLog

protected void cleanupOperationLog()

cancel

public void cancel()
            throws HiveSQLException

Throws:

HiveSQLException

close

public abstract void close()
                    throws HiveSQLException

Throws:

HiveSQLException

getResultSetSchema

public abstract TableSchema getResultSetSchema()
                                        throws HiveSQLException

Throws:

HiveSQLException

getNextRowSet

public abstract RowSet getNextRowSet(FetchOrientation orientation,
                   long maxRows)
                              throws HiveSQLException

Throws:

HiveSQLException

getNextRowSet

public RowSet getNextRowSet()
                     throws HiveSQLException

Throws:

HiveSQLException

validateDefaultFetchOrientation

protected void validateDefaultFetchOrientation(FetchOrientation orientation)
                                        throws HiveSQLException

Verify if the given fetch orientation is part of the default orientation types.

Parameters:

orientation -

Throws:

HiveSQLException

validateFetchOrientation

protected void validateFetchOrientation(FetchOrientation orientation,
                            EnumSet<FetchOrientation> supportedOrientations)
                                 throws HiveSQLException

Verify if the given fetch orientation is part of the supported orientation types.

Parameters:

orientation -

supportedOrientations -

Throws:

HiveSQLException

toSQLException

protected HiveSQLException toSQLException(String prefix,
                              CommandProcessorResponse response)