org.apache.lens.client

Class LensStatement

java.lang.Object

org.apache.lens.client.LensStatement

public class LensStatement
extends Object

Top level class which is used to execute lens queries.

Constructor Summary

Constructors

Constructor and Description
LensStatement(LensConnection connection)

Method Summary

Modifier and Type	Method and Description
boolean	closeResultSet() Close result set.
boolean	destroyPrepared(QueryPrepareHandle phandle) Destroy prepared.
QueryHandle	executeQuery(QueryPrepareHandle phandle, boolean waitForQueryToComplete, String queryName) Deprecated.
QueryHandle	executeQuery(QueryPrepareHandle phandle, boolean waitForQueryToComplete, String queryName, LensConf conf) This method can be used for executing a prepared query.
QueryHandle	executeQuery(String sql, boolean waitForQueryToComplete, String queryName) Deprecated.
QueryHandle	executeQuery(String sql, boolean waitForQueryToComplete, String queryName, LensConf conf) This method can be used for executing a query.
QueryHandleWithResultSet	executeQuery(String sql, String queryName, long timeOutMillis) Deprecated.
QueryHandleWithResultSet	executeQuery(String sql, String queryName, long timeOutMillis, LensConf conf) This method can be used for executing query.
LensAPIResult<QueryPlan>	explainAndPrepare(String sql, String queryName) Deprecated.
LensAPIResult<QueryPlan>	explainAndPrepare(String sql, String queryName, LensConf conf) Explain and prepare.
LensAPIResult<QueryPlan>	explainQuery(String sql) Deprecated.
LensAPIResult<QueryPlan>	explainQuery(String sql, LensConf conf) Explain query.
List<QueryPrepareHandle>	getAllPreparedQueries(String userName, String queryName, String fromDate, String toDate) Gets the all prepared queries.
List<QueryHandle>	getAllQueries(String state, String queryName, String user, String driver, String fromDate, String toDate) Gets the all queries.
List<LensQuery>	getAllQueryDetails(String state, String queryName, String user, String driver, String fromDate, String toDate) Gets the all queries with details.
int	getErrorCode() Gets the error code, if any, for the most recently executed query.
String	getErrorMessage() Gets the error message, if any, for the most recently executed query.
javax.ws.rs.core.Response	getHttpResultSet() Gets http result set for the most recently executed query.
javax.ws.rs.core.Response	getHttpResultSet(LensQuery query) Gets the http result set.
LensPreparedQuery	getPreparedQuery(QueryPrepareHandle handle) Gets the prepared query.
LensQuery	getQuery() Gets details of the most recently executed query through executeQuery(QueryPrepareHandle, boolean, String) or executeQuery(String, boolean, String) or executeQuery(String, String, long)
LensQuery	getQuery(QueryHandle handle) Gets the query.
String	getQueryHandleString() Gets the query handle string for the most recently executed query.
QueryResult	getResultSet() Gets result set for the most recently executed query.
QueryResult	getResultSet(LensQuery query) Gets the result set.
QueryResultSetMetadata	getResultSetMetaData() Gets the result set meta data for the most recently executed query.
QueryResultSetMetadata	getResultSetMetaData(LensQuery query) Gets the result set meta data.
QueryStatus	getStatus() Gets the status for the most recently executed query.
QueryStatus	getStatus(QueryHandle handle) Gets status for query represented by handle.
String	getUser() Gets the user for the lens session
boolean	isIdle()
boolean	kill() Kill the most recently submitted query via any executeQuery methods.
boolean	kill(LensQuery query) Kill.
LensAPIResult<QueryPrepareHandle>	prepareQuery(String sql, String queryName) Deprecated.
LensAPIResult<QueryPrepareHandle>	prepareQuery(String sql, String queryName, LensConf conf) Prepare query.
void	waitForQueryToComplete(QueryHandle handle)
boolean	wasQuerySuccessful() Was the most recently executed query successful.

Methods inherited from class java.lang.Object

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

Constructor Detail

LensStatement

@ConstructorProperties(value="connection")
 @Generated(value="lombok")
public LensStatement(LensConnection connection)

Method Detail

executeQuery

@Deprecated
public QueryHandle executeQuery(String sql,
                                            boolean waitForQueryToComplete,
                                            String queryName)
                                     throws LensAPIException

Deprecated.

This method can be used for executing a query. If waitForQueryToComplete is false, the call to this method returns immediately after submitting the query to the server without waiting for it to complete execution.

getStatus(QueryHandle) can be used to track to track the query progress and getQuery(QueryHandle) can be used to get complete details (including status) about the query.

Parameters:

sql - the sql

waitForQueryToComplete - the wait for query to complete

queryName - the query name

Returns:

the query handle

Throws:

LensAPIException

executeQuery

public QueryHandle executeQuery(String sql,
                                boolean waitForQueryToComplete,
                                String queryName,
                                LensConf conf)
                         throws LensAPIException

This method can be used for executing a query. If waitForQueryToComplete is false, the call to this method returns immediately after submitting the query to the server without waiting for it to complete execution.

getStatus(QueryHandle) can be used to track to track the query progress and getQuery(QueryHandle) can be used to get complete details (including status) about the query.

Parameters:

sql - the sql

waitForQueryToComplete - the wait for query to complete

queryName - the query name

conf - config specific to this query

Returns:

the query handle

Throws:

LensAPIException

executeQuery

@Deprecated
public QueryHandle executeQuery(QueryPrepareHandle phandle,
                                            boolean waitForQueryToComplete,
                                            String queryName)

Deprecated.

This method can be used for executing a prepared query. If waitForQueryToComplete is false, the call to this method returns immediately after submitting the query to the server without waiting for it to complete execution.

getStatus(QueryHandle) can be used to track to track the query progress and getQuery(QueryHandle) can be used to get complete details (including status) about the query.

Parameters:

phandle - the prepared query handle

waitForQueryToComplete - the wait for query to complete

queryName - the query name

Returns:

the query handle

executeQuery

public QueryHandle executeQuery(QueryPrepareHandle phandle,
                                boolean waitForQueryToComplete,
                                String queryName,
                                LensConf conf)

This method can be used for executing a prepared query. If waitForQueryToComplete is false, the call to this method returns immediately after submitting the query to the server without waiting for it to complete execution.

getStatus(QueryHandle) can be used to track to track the query progress and getQuery(QueryHandle) can be used to get complete details (including status) about the query.

Parameters:

phandle - the prepared query handle

waitForQueryToComplete - the wait for query to complete

queryName - the query name

conf - config to be used for the query

Returns:

the query handle

executeQuery

@Deprecated
public QueryHandleWithResultSet executeQuery(String sql,
                                                         String queryName,
                                                         long timeOutMillis)
                                                  throws LensAPIException

Deprecated.

This method can be used for executing query. The method waits for timeOutMillis time OR query execution to succeed, which ever happens first, before returning the response to the caller.

If the query execution finishes before timeout, user can check the query Status (SUCCESSFUL/FAILED) using QueryHandleWithResultSet.getStatus() and access the result of SUCCESSFUL query via QueryHandleWithResultSet.getResult() and QueryHandleWithResultSet.getResultMetadata().

If the query does not finish within the timeout, user can use getStatus(QueryHandle) to track the query progress and getQuery(QueryHandle) to get complete details (including status) about the query. Once the query has reached SUCCESSFUL state, user can access the results via getResultSet(LensQuery) and getResultSetMetaData(LensQuery)

Parameters:

sql - : query/command to be executed

queryName - : optional query name

timeOutMillis - : timeout milliseconds

Returns:

QueryHandleWithResultSet

Throws:

LensAPIException

executeQuery

public QueryHandleWithResultSet executeQuery(String sql,
                                             String queryName,
                                             long timeOutMillis,
                                             LensConf conf)
                                      throws LensAPIException

This method can be used for executing query. The method waits for timeOutMillis time OR query execution to succeed, which ever happens first, before returning the response to the caller.

If the query execution finishes before timeout, user can check the query Status (SUCCESSFUL/FAILED) using QueryHandleWithResultSet.getStatus() and access the result of SUCCESSFUL query via QueryHandleWithResultSet.getResult() and QueryHandleWithResultSet.getResultMetadata().

If the query does not finish within the timeout, user can use getStatus(QueryHandle) to track the query progress and getQuery(QueryHandle) to get complete details (including status) about the query. Once the query has reached SUCCESSFUL state, user can access the results via getResultSet(LensQuery) and getResultSetMetaData(LensQuery)

Parameters:

sql - : query/command to be executed

queryName - : optional query name

timeOutMillis - : timeout milliseconds

conf - config to be used for the query

Returns:

QueryHandleWithResultSet

Throws:

LensAPIException

prepareQuery

@Deprecated
public LensAPIResult<QueryPrepareHandle> prepareQuery(String sql,
                                                                  String queryName)
                                                           throws LensAPIException

Deprecated.

Prepare query.

Parameters:

sql - the sql

queryName - the query name

Returns:

the query prepare handle

Throws:

LensAPIException

prepareQuery

public LensAPIResult<QueryPrepareHandle> prepareQuery(String sql,
                                                      String queryName,
                                                      LensConf conf)
                                               throws LensAPIException

Prepare query.

Parameters:

sql - the sql

queryName - the query name

Returns:

the query prepare handle

Throws:

LensAPIException

explainAndPrepare

@Deprecated
public LensAPIResult<QueryPlan> explainAndPrepare(String sql,
                                                              String queryName)
                                                       throws LensAPIException

Deprecated.

Explain and prepare.

Parameters:

sql - the sql

queryName - the query name

Returns:

the query plan

Throws:

LensAPIException

explainAndPrepare

public LensAPIResult<QueryPlan> explainAndPrepare(String sql,
                                                  String queryName,
                                                  LensConf conf)
                                           throws LensAPIException

Explain and prepare.

Parameters:

sql - the sql

queryName - the query name

conf - config to be used for the query

Returns:

the query plan

Throws:

LensAPIException

waitForQueryToComplete

public void waitForQueryToComplete(QueryHandle handle)

getQuery

public LensQuery getQuery(QueryHandle handle)

Gets the query.

Parameters:

handle - the handle

Returns:

the query

getPreparedQuery

public LensPreparedQuery getPreparedQuery(QueryPrepareHandle handle)

Gets the prepared query.

Parameters:

handle - the handle

Returns:

the prepared query

explainQuery

@Deprecated
public LensAPIResult<QueryPlan> explainQuery(String sql)
                                                  throws LensAPIException

Deprecated.

Explain query.

Parameters:

sql - the sql

Returns:

the query plan

Throws:

LensAPIException

explainQuery

public LensAPIResult<QueryPlan> explainQuery(String sql,
                                             LensConf conf)
                                      throws LensAPIException

Explain query.

Parameters:

sql - the sql

conf - config to be used for the query

Returns:

the query plan

Throws:

LensAPIException

getAllQueries

public List<QueryHandle> getAllQueries(String state,
                                       String queryName,
                                       String user,
                                       String driver,
                                       String fromDate,
                                       String toDate)

Gets the all queries.

Parameters:

state - the state

queryName - the query name

user - the user

driver - the driver name

fromDate - the from date

toDate - the to date

Returns:

the all queries

getAllQueryDetails

public List<LensQuery> getAllQueryDetails(String state,
                                          String queryName,
                                          String user,
                                          String driver,
                                          String fromDate,
                                          String toDate)

Gets the all queries with details.

Parameters:

state - the state

queryName - the query name

user - the user

driver - the driver name

fromDate - the from date

toDate - the to date

Returns:

the all queries as per criteria along with additional details

getAllPreparedQueries

public List<QueryPrepareHandle> getAllPreparedQueries(String userName,
                                                      String queryName,
                                                      String fromDate,
                                                      String toDate)

Gets the all prepared queries.

Parameters:

userName - the user name

queryName - the query name

fromDate - the from date

toDate - the to date

Returns:

the all prepared queries

getResultSetMetaData

public QueryResultSetMetadata getResultSetMetaData()

Gets the result set meta data for the most recently executed query.

getResultSetMetaData

public QueryResultSetMetadata getResultSetMetaData(LensQuery query)

Gets the result set meta data.

Parameters:

query - the query

Returns:

the result set meta data

getResultSet

public QueryResult getResultSet()

Gets result set for the most recently executed query.

getHttpResultSet

public javax.ws.rs.core.Response getHttpResultSet()

Gets http result set for the most recently executed query.

getResultSet

public QueryResult getResultSet(LensQuery query)

Gets the result set.

Parameters:

query - the query

Returns:

the result set

getHttpResultSet

public javax.ws.rs.core.Response getHttpResultSet(LensQuery query)

Gets the http result set.

Parameters:

query - the query

Returns:

the http result set

kill

public boolean kill()

Kill the most recently submitted query via any executeQuery methods.

Returns:

true, if successful

kill

public boolean kill(LensQuery query)

Kill.

Parameters:

query - the query

Returns:

true, if successful

closeResultSet

public boolean closeResultSet()

Close result set.

Returns:

true, if successful

destroyPrepared

public boolean destroyPrepared(QueryPrepareHandle phandle)

Destroy prepared.

Parameters:

phandle - the phandle

Returns:

true, if successful

isIdle

public boolean isIdle()

wasQuerySuccessful

public boolean wasQuerySuccessful()

Was the most recently executed query successful.

Returns:

true, if successful

getStatus

public QueryStatus getStatus(QueryHandle handle)

Gets status for query represented by handle.

getStatus

public QueryStatus getStatus()

Gets the status for the most recently executed query.

getQuery

public LensQuery getQuery()

Gets details of the most recently executed query through executeQuery(QueryPrepareHandle, boolean, String) or executeQuery(String, boolean, String) or executeQuery(String, String, long)

Note: Cached query details are returned if the query has finished. If the query has still not finished it fetches the latest details from server again.

getErrorCode

public int getErrorCode()

Gets the error code, if any, for the most recently executed query.

getErrorMessage

public String getErrorMessage()

Gets the error message, if any, for the most recently executed query.

getQueryHandleString

public String getQueryHandleString()

Gets the query handle string for the most recently executed query.

getUser

public String getUser()

Gets the user for the lens session