org.apache.lens.api.query

Class LensQuery

java.lang.Object

org.apache.lens.api.ToYAMLString

org.apache.lens.api.query.LensQuery

All Implemented Interfaces:

org.jvnet.jaxb2_commons.lang.ToString

Direct Known Subclasses:

ProxyLensQuery

public class LensQuery
extends ToYAMLString

Instantiates a new lens query.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lens.api.ToYAMLString

ToYAMLString.FieldNameAndValue

Constructor Summary

Constructors

Constructor and Description
LensQuery(QueryHandle queryHandle, String userQuery, String submittedUser, Priority priority, boolean isPersistent, String selectedDriverName, String driverQuery, QueryStatus status, String resultSetPath, String driverOpHandle, LensConf queryConf, long submissionTime, long launchTime, long driverStartTime, long driverFinishTime, long finishTime, long closedTime, String queryName)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
long	getClosedTime() The the query close time when the query is purged by the server and no more operations are pending for it.
long	getDriverFinishTime() The the query execution end time on driver.
String	getDriverOpHandle() The operation handle associated with the driver, if any.
String	getDriverQuery() The driver query.
long	getDriverStartTime() The query execution start time on driver.
Integer	getErrorCode()
String	getErrorMessage()
long	getFinishTime() The query finish time on server.
long	getLaunchTime() The query launch time.
Priority	getPriority() The priority of the query.
LensConf	getQueryConf() The query conf that was used for executing this query.
QueryHandle	getQueryHandle() The query handle that represents this query uniquely
String	getQueryHandleString()
String	getQueryName() The query name, if any.
String	getResultSetPath() The result set path for this query if the query output was persisted by the server.
String	getSelectedDriverName() Name of the driver which executed the query (Example: hive/testDriver, jdbc/prodDriver etc)
QueryStatus	getStatus() The status of this query.
long	getSubmissionTime() The submission time.
String	getSubmittedUser() The user who submitted the query.
String	getUserQuery() The the query submitted by the user
int	hashCode()
boolean	isPersistent() Is true if query's result would be persisted by server.

Methods inherited from class org.apache.lens.api.ToYAMLString

append, appendFields, fromXMLString, getFieldsToAppend, toString, toXMLString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LensQuery

@ConstructorProperties(value={"queryHandle","userQuery","submittedUser","priority","isPersistent","selectedDriverName","driverQuery","status","resultSetPath","driverOpHandle","queryConf","submissionTime","launchTime","driverStartTime","driverFinishTime","finishTime","closedTime","queryName"})
@Generated(value="lombok")
public LensQuery(QueryHandle queryHandle,
                                                   String userQuery,
                                                   String submittedUser,
                                                   Priority priority,
                                                   boolean isPersistent,
                                                   String selectedDriverName,
                                                   String driverQuery,
                                                   QueryStatus status,
                                                   String resultSetPath,
                                                   String driverOpHandle,
                                                   LensConf queryConf,
                                                   long submissionTime,
                                                   long launchTime,
                                                   long driverStartTime,
                                                   long driverFinishTime,
                                                   long finishTime,
                                                   long closedTime,
                                                   String queryName)

Method Detail

getErrorCode

public Integer getErrorCode()

Returns:

error code in case of query failures

getErrorMessage

public String getErrorMessage()

Returns:

error message in case of query failures

getQueryHandleString

public String getQueryHandleString()

Returns:

the query handle string

equals

@Generated(value="lombok")
public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

@Generated(value="lombok")
public int hashCode()

Overrides:

hashCode in class Object

getQueryHandle

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

The query handle that represents this query uniquely

getUserQuery

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

The the query submitted by the user

getSubmittedUser

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

The user who submitted the query.

getPriority

@Generated(value="lombok")
public Priority getPriority()

The priority of the query.

isPersistent

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

Is true if query's result would be persisted by server.

getSelectedDriverName

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

Name of the driver which executed the query (Example: hive/testDriver, jdbc/prodDriver etc)

getDriverQuery

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

The driver query. It is the final query (derived form user query) that was submitted by the driver for execution.

getStatus

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

The status of this query. Note: QueryStatus.getStatus() method can be used to get the QueryStatus.Status enum that defines the current state of the query. Also other utility methods are available to check the status of the query like QueryStatus.queued(), QueryStatus.successful(), QueryStatus.finished(), QueryStatus.failed() and QueryStatus.running()

getResultSetPath

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

The result set path for this query if the query output was persisted by the server.

getDriverOpHandle

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

The operation handle associated with the driver, if any.

getQueryConf

@Generated(value="lombok")
public LensConf getQueryConf()

The query conf that was used for executing this query.

getSubmissionTime

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

The submission time.

getLaunchTime

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

The query launch time. This will be submission time + time spent by query waiting in the queue

getDriverStartTime

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

The query execution start time on driver. This will >= launch time.

getDriverFinishTime

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

The the query execution end time on driver.

getFinishTime

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

The query finish time on server. This will be driver finish time + any extra time spent by server (like formatting the result)

getClosedTime

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

The the query close time when the query is purged by the server and no more operations are pending for it. Note: not supported as of now.

getQueryName

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

The query name, if any.