org.apache.lens.server.api.query

Class QueryContext

java.lang.Object

org.apache.lens.server.api.query.AbstractQueryContext

org.apache.lens.server.api.query.QueryContext

All Implemented Interfaces:

Serializable, FailureContext

public class QueryContext
extends AbstractQueryContext
implements FailureContext

The Class QueryContext.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lens.server.api.query.AbstractQueryContext

AbstractQueryContext.DriverEstimateRunnable

Constructor Summary

Constructors

Constructor and Description
QueryContext(PreparedQueryContext prepared, String user, LensConf qconf, org.apache.hadoop.conf.Configuration conf) Creates context from PreparedQueryContext
QueryContext(String query, String user, LensConf qconf, org.apache.hadoop.conf.Configuration conf, Collection<LensDriver> drivers) Creates context from query

Method Summary

Modifier and Type	Method and Description
static QueryContext	createContextWithSingleDriver(String query, String user, LensConf qconf, org.apache.hadoop.conf.Configuration conf, LensDriver driver, String lensSessionPublicId, boolean mergeDriverConf) Utility create method to create context with single driver.
boolean	executed()
void	extractFailedAttempt()
void	extractFailedAttempt(LensDriver selectedDriver)
boolean	finished()
long	getClosedTime() The closed time.
String	getClusterUser()
boolean	getCompressOutput()
String	getDriverOpHandle() The driver op handle.
LensResultSet	getDriverResult() Query result registered by driver
String	getDriverResultPath() The hdfsout path.
BackOffRetryHandler<QueryContext>	getDriverRetryPolicy()
DriverQueryStatus	getDriverStatus() The driver status.
long	getEndTime() The end time.
long	getExecuteTimeoutMillis() This is the timeout that the client may have provided while initiating query execution This value is used for pre fetching in-memory result if applicable Note: in case the timeout is not provided, this value will not be set.
int	getFailCount()
List<FailedAttempt>	getFailedAttempts()
org.apache.hadoop.fs.Path	getHDFSResultDir()
long	getLastFailedTime()
long	getLaunchTime() The launch time.
String	getLogHandle() Get handle of the query for logging purposes
long	getMaxResultSplitRows()
String	getOuptutFileExtn()
byte[]	getQueryConfHash()
QueryHandle	getQueryHandle() The query handle.
String	getQueryHandleString()
Future	getQueryLauncher()
String	getQueryName() The query name.
QueryOutputFormatter	getQueryOutputFormatter() The query output formatter.
String	getResultEncoding()
String	getResultFooter()
String	getResultHeader()
String	getResultSetParentDir()
String	getResultSetPath() The result set path.
BackOffRetryHandler<QueryContext>	getRetryPolicy()
com.google.common.collect.ImmutableSet<QueryLaunchingConstraint>	getSelectedDriverQueryConstraints()
BackOffRetryHandler<QueryContext>	getServerRetryPolicy()
QueryStatus	getStatus() The status.
long	getSubmissionTime() The submission time.
boolean	hasTimedout()
void	initTransientState()
boolean	isDriverPersistent() The is driver persistent.
boolean	isDriverResultRegistered() True if driver has registered the result
boolean	isFinishedQueryPersisted() The finished query persisted.
boolean	isLaunching()
boolean	isPersistent() The is persistent.
boolean	isQueryClosedOnDriver()
boolean	isResultAvailableInDriver()
boolean	launched()
boolean	queued()
void	registerDriverResult(LensResultSet result)
void	registerStatusUpdateListener(QueryDriverStatusUpdateListener driverStatusUpdateListener)
boolean	running()
void	setClosedTime(long closedTime) The closed time.
void	setDriverOpHandle(String driverOpHandle) The driver op handle.
void	setDriverResultPath(String driverResultPath) The hdfsout path.
void	setDriverRetryPolicy(BackOffRetryHandler<QueryContext> driverRetryPolicy)
void	setDriverStatus(DriverQueryStatus.DriverQueryState state)
void	setDriverStatus(DriverQueryStatus.DriverQueryState state, String message)
void	setEndTime(long endTime) The end time.
void	setExecuteTimeoutMillis(long executeTimeoutMillis) This is the timeout that the client may have provided while initiating query execution This value is used for pre fetching in-memory result if applicable Note: in case the timeout is not provided, this value will not be set.
void	setFailedAttempts(List<FailedAttempt> failedAttempts)
void	setFinishedQueryPersisted(boolean finishedQueryPersisted) The finished query persisted.
void	setLaunching(boolean isLaunching)
void	setLaunchTime(long launchTime) The launch time.
void	setQueryClosedOnDriver(boolean isQueryClosedOnDriver)
void	setQueryConfHash(byte[] queryConfHash)
void	setQueryHandle(QueryHandle queryHandle) The query handle.
void	setQueryLauncher(Future queryLauncher)
void	setQueryName(String queryName) The query name.
void	setQueryOutputFormatter(QueryOutputFormatter queryOutputFormatter) The query output formatter.
void	setResultSetPath(String resultSetPath) The result set path.
void	setServerRetryPolicy(BackOffRetryHandler<QueryContext> serverRetryPolicy)
void	setStatus(QueryStatus newStatus)
void	setStatusSkippingTransitionTest(QueryStatus newStatus)
boolean	splitResultIntoMultipleFiles() Split result into multiple files.
boolean	successful()
LensQuery	toLensQuery() To lens query.
String	toString()
void	unSetDriverPersistent() Set whether result is persisted on driver to false.
void	updateDriverStatus(BackOffRetryHandler statusUpdateRetryHandler) Update status from selected driver
void	validateTransition(QueryStatus newStatus)

Methods inherited from class org.apache.lens.server.api.query.AbstractQueryContext

clearTransientStateAfterCompleted, clearTransientStateAfterLaunch, estimateCostForDrivers, getConf, getDatabase, getDriverConf, getDriverContext, getDriverEstimateRunnables, getDriverQuery, getDriverQueryCost, getDriverRewriteError, getDriverRewriterPlan, getFinalDriverQuery, getHiveConf, getLensConf, getLensSessionIdentifier, getPhase1RewrittenQuery, getPriority, getQueue, getSelectedDriver, getSelectedDriverConf, getSelectedDriverQuery, getSelectedDriverQueryCost, getSelectedDriverQueryPlan, getSubmittedUser, getTableWeights, getUserQuery, isDriverQueryExplicitlySet, isOlapQuery, setConf, setDriverContext, setDriverCost, setDriverQueries, setDriverQuery, setDriverRewriteError, setFinalDriverQuery, setLensSessionIdentifier, setOlapQuery, setPhase1RewrittenQuery, setPriority, setSelectedDriver, setSelectedDriverQuery, setSelectedDriverQueryCost, updateConf

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

QueryContext

public QueryContext(String query,
                    String user,
                    LensConf qconf,
                    org.apache.hadoop.conf.Configuration conf,
                    Collection<LensDriver> drivers)

Creates context from query

Parameters:

query - the query

user - the user

qconf - The query lensconf

conf - the conf

QueryContext

public QueryContext(PreparedQueryContext prepared,
                    String user,
                    LensConf qconf,
                    org.apache.hadoop.conf.Configuration conf)

Creates context from PreparedQueryContext

Parameters:

prepared - the prepared

user - the user

qconf - the qconf

conf - the conf

Method Detail

createContextWithSingleDriver

public static QueryContext createContextWithSingleDriver(String query,
                                                         String user,
                                                         LensConf qconf,
                                                         org.apache.hadoop.conf.Configuration conf,
                                                         LensDriver driver,
                                                         String lensSessionPublicId,
                                                         boolean mergeDriverConf)

Utility create method to create context with single driver.

Parameters:

query - The user query

user - The submitted query

qconf - The query lens conf

conf - Query configuration object - merged with session

driver - The driver

lensSessionPublicId - The session id

Returns:

QueryContext object

initTransientState

public void initTransientState()

Overrides:

initTransientState in class AbstractQueryContext

getResultSetParentDir

public String getResultSetParentDir()

getHDFSResultDir

public org.apache.hadoop.fs.Path getHDFSResultDir()

toLensQuery

public LensQuery toLensQuery()

To lens query.

Returns:

the lens query

isResultAvailableInDriver

public boolean isResultAvailableInDriver()

unSetDriverPersistent

public void unSetDriverPersistent()

Set whether result is persisted on driver to false. Set by drivers when drivers are not persisting

setStatusSkippingTransitionTest

public void setStatusSkippingTransitionTest(QueryStatus newStatus)

setStatus

public void setStatus(QueryStatus newStatus)
               throws LensException

Throws:

LensException

updateDriverStatus

public void updateDriverStatus(BackOffRetryHandler statusUpdateRetryHandler)
                        throws LensException

Update status from selected driver

Parameters:

statusUpdateRetryHandler - The exponential retry handler

Throws:

LensException - Throws exception if update from driver has failed.

getResultHeader

public String getResultHeader()

getResultFooter

public String getResultFooter()

getResultEncoding

public String getResultEncoding()

getOuptutFileExtn

public String getOuptutFileExtn()

getCompressOutput

public boolean getCompressOutput()

getMaxResultSplitRows

public long getMaxResultSplitRows()

splitResultIntoMultipleFiles

public boolean splitResultIntoMultipleFiles()

Split result into multiple files.

Returns:

true, if successful

getClusterUser

public String getClusterUser()

getLogHandle

public String getLogHandle()

Description copied from class: AbstractQueryContext

Get handle of the query for logging purposes

Specified by:

getLogHandle in class AbstractQueryContext

Returns:

query handle string

getQueryHandleString

public String getQueryHandleString()

validateTransition

public void validateTransition(QueryStatus newStatus)
                        throws LensException

Throws:

LensException

finished

public boolean finished()

successful

public boolean successful()

executed

public boolean executed()

launched

public boolean launched()

running

public boolean running()

queued

public boolean queued()

getSelectedDriverQueryConstraints

public com.google.common.collect.ImmutableSet<QueryLaunchingConstraint> getSelectedDriverQueryConstraints()

registerDriverResult

public void registerDriverResult(LensResultSet result)
                          throws LensException

Throws:

LensException

setDriverStatus

public void setDriverStatus(DriverQueryStatus.DriverQueryState state,
                            String message)

toString

public String toString()

Overrides:

toString in class Object

setDriverStatus

public void setDriverStatus(DriverQueryStatus.DriverQueryState state)

registerStatusUpdateListener

public void registerStatusUpdateListener(QueryDriverStatusUpdateListener driverStatusUpdateListener)

getLastFailedTime

public long getLastFailedTime()

Specified by:

getLastFailedTime in interface FailureContext

Returns:

Last time of failure

getFailCount

public int getFailCount()

Specified by:

getFailCount in interface FailureContext

Returns:

number of times failure has occured so far

getRetryPolicy

public BackOffRetryHandler<QueryContext> getRetryPolicy()

extractFailedAttempt

public void extractFailedAttempt()

extractFailedAttempt

public void extractFailedAttempt(LensDriver selectedDriver)

hasTimedout

public boolean hasTimedout()

getQueryHandle

@Generated(value="lombok")
public QueryHandle getQueryHandle()

The query handle.

setQueryHandle

@Generated(value="lombok")
public void setQueryHandle(QueryHandle queryHandle)

The query handle.

isPersistent

@Generated(value="lombok")
public boolean isPersistent()

The is persistent.

isDriverPersistent

@Generated(value="lombok")
public boolean isDriverPersistent()

The is driver persistent.

getStatus

@Generated(value="lombok")
public QueryStatus getStatus()

The status.

getResultSetPath

@Generated(value="lombok")
public String getResultSetPath()

The result set path.

setResultSetPath

@Generated(value="lombok")
public void setResultSetPath(String resultSetPath)

The result set path.

getDriverResultPath

@Generated(value="lombok")
public String getDriverResultPath()

The hdfsout path.

setDriverResultPath

@Generated(value="lombok")
public void setDriverResultPath(String driverResultPath)

The hdfsout path.

getSubmissionTime

@Generated(value="lombok")
public long getSubmissionTime()

The submission time.

getLaunchTime

@Generated(value="lombok")
public long getLaunchTime()

The launch time.

setLaunchTime

@Generated(value="lombok")
public void setLaunchTime(long launchTime)

The launch time.

getEndTime

@Generated(value="lombok")
public long getEndTime()

The end time.

setEndTime

@Generated(value="lombok")
public void setEndTime(long endTime)

The end time.

getClosedTime

@Generated(value="lombok")
public long getClosedTime()

The closed time.

setClosedTime

@Generated(value="lombok")
public void setClosedTime(long closedTime)

The closed time.

getDriverOpHandle

@Generated(value="lombok")
public String getDriverOpHandle()

The driver op handle.

setDriverOpHandle

@Generated(value="lombok")
public void setDriverOpHandle(String driverOpHandle)

The driver op handle.

getDriverStatus

@Generated(value="lombok")
public DriverQueryStatus getDriverStatus()

The driver status.

getQueryOutputFormatter

@Generated(value="lombok")
public QueryOutputFormatter getQueryOutputFormatter()

The query output formatter.

setQueryOutputFormatter

@Generated(value="lombok")
public void setQueryOutputFormatter(QueryOutputFormatter queryOutputFormatter)

The query output formatter.

isFinishedQueryPersisted

@Generated(value="lombok")
public boolean isFinishedQueryPersisted()

The finished query persisted.

setFinishedQueryPersisted

@Generated(value="lombok")
public void setFinishedQueryPersisted(boolean finishedQueryPersisted)

The finished query persisted.

isQueryClosedOnDriver

@Generated(value="lombok")
public boolean isQueryClosedOnDriver()

setQueryClosedOnDriver

@Generated(value="lombok")
public void setQueryClosedOnDriver(boolean isQueryClosedOnDriver)

getQueryName

@Generated(value="lombok")
public String getQueryName()

The query name.

setQueryName

@Generated(value="lombok")
public void setQueryName(String queryName)

The query name.

setExecuteTimeoutMillis

@Generated(value="lombok")
public void setExecuteTimeoutMillis(long executeTimeoutMillis)

This is the timeout that the client may have provided while initiating query execution This value is used for pre fetching in-memory result if applicable Note: in case the timeout is not provided, this value will not be set.

getExecuteTimeoutMillis

@Generated(value="lombok")
public long getExecuteTimeoutMillis()

This is the timeout that the client may have provided while initiating query execution This value is used for pre fetching in-memory result if applicable Note: in case the timeout is not provided, this value will not be set.

getDriverResult

@Generated(value="lombok")
public LensResultSet getDriverResult()

Query result registered by driver

isDriverResultRegistered

@Generated(value="lombok")
public boolean isDriverResultRegistered()

True if driver has registered the result

getQueryConfHash

@Generated(value="lombok")
public byte[] getQueryConfHash()

setQueryConfHash

@Generated(value="lombok")
public void setQueryConfHash(byte[] queryConfHash)

isLaunching

@Generated(value="lombok")
public boolean isLaunching()

setLaunching

@Generated(value="lombok")
public void setLaunching(boolean isLaunching)

getQueryLauncher

@Generated(value="lombok")
public Future getQueryLauncher()

setQueryLauncher

@Generated(value="lombok")
public void setQueryLauncher(Future queryLauncher)

getFailedAttempts

@Generated(value="lombok")
public List<FailedAttempt> getFailedAttempts()

setFailedAttempts

@Generated(value="lombok")
public void setFailedAttempts(List<FailedAttempt> failedAttempts)

getDriverRetryPolicy

@Generated(value="lombok")
public BackOffRetryHandler<QueryContext> getDriverRetryPolicy()

setDriverRetryPolicy

@Generated(value="lombok")
public void setDriverRetryPolicy(BackOffRetryHandler<QueryContext> driverRetryPolicy)

getServerRetryPolicy

@Generated(value="lombok")
public BackOffRetryHandler<QueryContext> getServerRetryPolicy()

setServerRetryPolicy

@Generated(value="lombok")
public void setServerRetryPolicy(BackOffRetryHandler<QueryContext> serverRetryPolicy)