org.apache.lens.server.query

Class QueryServiceResource

java.lang.Object

org.apache.lens.server.query.QueryServiceResource

public class QueryServiceResource
extends Object

queryapi resource

This provides api for all things query.

Constructor Summary

Constructors

Constructor and Description
QueryServiceResource() Instantiates a new query service resource.

Method Summary

Methods

Modifier and Type	Method and Description
APIResult	cancelAllQueries(LensSessionHandle sessionid, String state, String user, String queryName, String driver, String fromDate, String toDate) Cancel all the queries in query server; can be filtered with state and user.
APIResult	cancelQuery(LensSessionHandle sessionid, String queryHandle) Cancel the query specified by the handle.
APIResult	closeResultSet(LensSessionHandle sessionid, String queryHandle) Close the result set once fetching is done.
APIResult	destroyPrepared(LensSessionHandle sessionid, String prepareHandle) Destroy the prepared query specified by handle.
APIResult	destroyPreparedQueries(LensSessionHandle sessionid, String user, String queryName, String fromDate, String toDate) Destroy all the prepared queries; Can be filtered with user.
QuerySubmitResult	executePrepared(LensSessionHandle sessionid, String prepareHandle, String operation, LensConf conf, Long timeoutmillis, String queryName) Submit prepared query for execution.
List<QueryPrepareHandle>	getAllPreparedQueries(LensSessionHandle sessionid, String user, String queryName, String fromDate, String toDate) Get all prepared queries in the query server; can be filtered with user.
List<QueryHandle>	getAllQueries(LensSessionHandle sessionid, String states, String queryName, String user, String driver, String fromDate, String toDate) Get all the queries in the query server; can be filtered with state and queryName.
javax.ws.rs.core.Response	getHttpResultSet(LensSessionHandle sessionid, String queryHandle) Get the http endpoint for result set.
String	getMessage() API to know if Query service is up and running
LensPreparedQuery	getPreparedQuery(LensSessionHandle sessionid, String prepareHandle) Get a prepared query specified by handle.
QueryResult	getResultSet(LensSessionHandle sessionid, String queryHandle, long startIndex, int fetchSize) Fetch the result set.
QueryResultSetMetadata	getResultSetMetadata(LensSessionHandle sessionid, String queryHandle) Get resultset metadata of the query.
LensQuery	getStatus(LensSessionHandle sessionid, String queryHandle) Get lens query and its current status.
LensAPIResult<QuerySubmitResult>	prepareQuery(LensSessionHandle sessionid, String query, String operation, LensConf conf, String queryName) Prepare a query or 'explain and prepare' the query.
LensAPIResult<QuerySubmitResult>	query(LensSessionHandle sessionid, String query, String operation, LensConf conf, Long timeoutmillis, String queryName) Submit the query for explain or execute or execute with a timeout.
APIResult	updateConf(LensSessionHandle sessionid, String queryHandle, LensConf conf) Modify query configuration if it is not running yet.
APIResult	updatePreparedConf(LensSessionHandle sessionid, String prepareHandle, LensConf conf) Modify prepared query's configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryServiceResource

public QueryServiceResource()
                     throws LensException

Instantiates a new query service resource.

Throws:

LensException - the lens exception

Method Detail

getMessage

public String getMessage()

API to know if Query service is up and running

Returns:

Simple text saying it up

getAllQueries

public List<QueryHandle> getAllQueries(LensSessionHandle sessionid,
                              String states,
                              String queryName,
                              String user,
                              String driver,
                              String fromDate,
                              String toDate)
                                throws LensException

Get all the queries in the query server; can be filtered with state and queryName. This will by default only return queries submitted by the user that has started the session. To get queries of all users, set the searchAllUsers parameter to false.

Parameters:

sessionid - The sessionid in which queryName is working

states - If any state is passed, all the queries in that state will be returned, otherwise all queries will be returned. Possible states are {link QueryStatus.Status#values()}. Multiple states can be passed as comma separated string

queryName - If any queryName is passed, all the queries containing the queryName will be returned, otherwise all the queries will be returned

user - Returns queries submitted by this user. If set to "all", returns queries of all users. By default, returns queries of the current user.

driver - Get queries submitted on a specific driver.

fromDate - from date to search queries in a time range, the range is inclusive(submitTime >= fromDate) from date can be a long value indicating timestamp, or it can be in a format acceptable in time_range_in function. Notably: yyyy[-MM[-dd[-HH-[mm...]]]], or now based relative format

toDate - to date to search queries in a time range, the range is inclusive(toDate > submitTime) possible formats it can take is same as fromDate

Returns:

List of QueryHandle objects

Throws:

LensException

query

public LensAPIResult<QuerySubmitResult> query(LensSessionHandle sessionid,
                                     String query,
                                     String operation,
                                     LensConf conf,
                                     Long timeoutmillis,
                                     String queryName)
                                       throws LensException

Submit the query for explain or execute or execute with a timeout.

Parameters:

sessionid - The session in which user is submitting the query. Any configuration set in the session will be picked up.

query - The query to run

operation - The operation on the query. Supported operations are values: SubmitOp.ESTIMATE, SubmitOp.EXPLAIN, SubmitOp.EXECUTE and SubmitOp.EXECUTE_WITH_TIMEOUT

conf - The configuration for the query

timeoutmillis - The timeout for the query. If the query does not finish within the specified timeout, it is automatically cancelled unless user specified otherwise by setting configuration lens.query.cancel.on.timeout = false.
Note: The timeout parameter is honored only in case of SubmitOp.EXECUTE_WITH_TIMEOUT operation

queryName - human readable query name set by user (optional parameter)

Returns:

LensAPIResult with DATA as QueryHandle in case of SubmitOp.EXECUTE operation. QueryPlan in case of SubmitOp.EXPLAIN operation. QueryHandleWithResultSet in case SubmitOp.EXECUTE_WITH_TIMEOUT operation. QueryCostTO in case of SubmitOp.ESTIMATE operation.

Throws:

LensException

cancelAllQueries

public APIResult cancelAllQueries(LensSessionHandle sessionid,
                         String state,
                         String user,
                         String queryName,
                         String driver,
                         String fromDate,
                         String toDate)
                           throws LensException

Cancel all the queries in query server; can be filtered with state and user.

Parameters:

sessionid - The session in which cancel is issued

state - If any state is passed, all the queries in that state will be cancelled, otherwise all queries will be cancelled. Possible states are QueryStatus.Status.values() The queries in QueryStatus.Status.FAILED, QueryStatus.Status.CLOSED, QueryStatus.Status.SUCCESSFUL cannot be cancelled

user - If any user is passed, all the queries submitted by the user will be cancelled, otherwise all the queries will be cancelled

driver - Get queries submitted on a specific driver.

queryName - Cancel queries matching the query name

fromDate - the from date, inclusive(submitTime>=fromDate)

toDate - the to date, inclusive(toDate>=submitTime)

Returns:

APIResult with state APIResult.Status.SUCCEEDED in case of successful cancellation. APIResult with state APIResult.Status.FAILED in case of cancellation failure. APIResult with state APIResult.Status.PARTIAL in case of partial cancellation.

Throws:

LensException

getAllPreparedQueries

public List<QueryPrepareHandle> getAllPreparedQueries(LensSessionHandle sessionid,
                                             String user,
                                             String queryName,
                                             String fromDate,
                                             String toDate)
                                               throws LensException

Get all prepared queries in the query server; can be filtered with user.

Parameters:

sessionid - The sessionid in which user is working

user - returns queries of the user. If set to "all", returns queries of all users. By default returns the queries of the current user.

queryName - returns queries matching the query name

fromDate - start time for filtering prepared queries by preparation time

toDate - end time for filtering prepared queries by preparation time

Returns:

List of QueryPrepareHandle objects

Throws:

LensException

prepareQuery

public LensAPIResult<QuerySubmitResult> prepareQuery(LensSessionHandle sessionid,
                                            String query,
                                            String operation,
                                            LensConf conf,
                                            String queryName)
                                              throws LensException

Prepare a query or 'explain and prepare' the query.

Parameters:

sessionid - The session in which user is preparing the query. Any configuration set in the session will be picked up.

query - The query to prepare

operation - The operation on the query. Supported operations are SubmitOp.EXPLAIN_AND_PREPARE or SubmitOp.PREPARE

conf - The configuration for preparing the query

queryName - human readable query name set by user (optional parameter)

Returns:

QueryPrepareHandle incase of {link org.apache.lens.api.query.SubmitOp#PREPARE} operation. QueryPlan incase of SubmitOp.EXPLAIN_AND_PREPARE and the query plan will contain the prepare handle as well.

Throws:

LensException

destroyPreparedQueries

public APIResult destroyPreparedQueries(LensSessionHandle sessionid,
                               String user,
                               String queryName,
                               String fromDate,
                               String toDate)
                                 throws LensException

Destroy all the prepared queries; Can be filtered with user.

Parameters:

sessionid - The session in which cancel is issued

user - destroys queries of the user. If set to "all", destroys queries of all users. By default destroys the queries of the current user.

queryName - destroys queries matching the query name

fromDate - the from date

toDate - the to date

Returns:

APIResult with state APIResult.Status.SUCCEEDED in case of successful destroy. APIResult with state APIResult.Status.FAILED in case of destroy failure. APIResult with state APIResult.Status.PARTIAL in case of partial destroy.

Throws:

LensException

getPreparedQuery

public LensPreparedQuery getPreparedQuery(LensSessionHandle sessionid,
                                 String prepareHandle)
                                   throws LensException

Get a prepared query specified by handle.

Parameters:

sessionid - The user session handle

prepareHandle - The prepare handle

Returns:

LensPreparedQuery

Throws:

LensException

destroyPrepared

public APIResult destroyPrepared(LensSessionHandle sessionid,
                        String prepareHandle)
                          throws LensException

Destroy the prepared query specified by handle.

Parameters:

sessionid - The user session handle

prepareHandle - The prepare handle

Returns:

APIResult with state APIResult.Status.SUCCEEDED in case of successful destroy. APIResult with state APIResult.Status.FAILED in case of destroy failure.

Throws:

LensException

getStatus

public LensQuery getStatus(LensSessionHandle sessionid,
                  String queryHandle)
                    throws LensException

Get lens query and its current status.

Parameters:

sessionid - The user session handle

queryHandle - The query handle

Returns:

LensQuery

Throws:

LensException

cancelQuery

public APIResult cancelQuery(LensSessionHandle sessionid,
                    String queryHandle)
                      throws LensException

Cancel the query specified by the handle.

Parameters:

sessionid - The user session handle

queryHandle - The query handle

Returns:

APIResult with state APIResult.Status.SUCCEEDED in case of successful cancellation. APIResult with state APIResult.Status.FAILED in case of cancellation failure.

Throws:

LensException

updateConf

public APIResult updateConf(LensSessionHandle sessionid,
                   String queryHandle,
                   LensConf conf)
                     throws LensException

Modify query configuration if it is not running yet.

Parameters:

sessionid - The user session handle

queryHandle - The query handle

conf - The new configuration, will be on top of old one

Returns:

APIResult with state APIResult.Status.SUCCEEDED in case of successful update. APIResult with state APIResult.Status.FAILED in case of udpate failure.

Throws:

LensException

updatePreparedConf

public APIResult updatePreparedConf(LensSessionHandle sessionid,
                           String prepareHandle,
                           LensConf conf)
                             throws LensException

Modify prepared query's configuration. This would be picked up for subsequent runs of the prepared queries. The query wont be re-prepared with new configuration.

Parameters:

sessionid - The user session handle

prepareHandle - The prepare handle

conf - The new configuration, will be on top of old one

Returns:

APIResult with state APIResult.Status.SUCCEEDED in case of successful update. APIResult with state APIResult.Status.FAILED in case of udpate failure.

Throws:

LensException

executePrepared

public QuerySubmitResult executePrepared(LensSessionHandle sessionid,
                                String prepareHandle,
                                String operation,
                                LensConf conf,
                                Long timeoutmillis,
                                String queryName)
                                  throws LensException

Submit prepared query for execution.

Parameters:

sessionid - The session in which user is submitting the query. Any configuration set in the session will be picked up.

prepareHandle - The Query to run

operation - The operation on the query. Supported operations are SubmitOp.EXECUTE and SubmitOp.EXECUTE_WITH_TIMEOUT

conf - The configuration for the execution of query

timeoutmillis - The timeout for the query, honored only in case of SubmitOp.EXECUTE_WITH_TIMEOUT operation

queryName - human readable query name set by user (optional parameter)

Returns:

QueryHandle in case of {link org.apache.lens.api.query.SubmitOp#EXECUTE} operation. QueryHandleWithResultSet in case SubmitOp.EXECUTE_WITH_TIMEOUT operation.

Throws:

LensException

getResultSetMetadata

public QueryResultSetMetadata getResultSetMetadata(LensSessionHandle sessionid,
                                          String queryHandle)
                                            throws LensException

Get resultset metadata of the query.

Parameters:

sessionid - The user session handle

queryHandle - The query handle

Returns:

QueryResultSetMetadata

Throws:

LensException

getResultSet

public QueryResult getResultSet(LensSessionHandle sessionid,
                       String queryHandle,
                       long startIndex,
                       int fetchSize)
                         throws LensException

Fetch the result set.

Parameters:

sessionid - The user session handle

queryHandle - The query handle

startIndex - start index of the result

fetchSize - fetch size

Returns:

QueryResult

Throws:

LensException

getHttpResultSet

public javax.ws.rs.core.Response getHttpResultSet(LensSessionHandle sessionid,
                                         String queryHandle)
                                           throws LensException

Get the http endpoint for result set.

Parameters:

sessionid - The user session handle

queryHandle - The query handle

Returns:

Response with result as octet stream

Throws:

LensException

closeResultSet

public APIResult closeResultSet(LensSessionHandle sessionid,
                       String queryHandle)
                         throws LensException

Close the result set once fetching is done.

Parameters:

sessionid - The user session handle

queryHandle - The query handle

Returns:

APIResult with state APIResult.Status.SUCCEEDED in case of successful close. APIResult with state APIResult.Status.FAILED in case of close failure.

Throws:

LensException