Interface QueryExecutionInfo

All Known Implementing Classes:

MockQueryExecutionInfo

public interface QueryExecutionInfo

Holds information about a query execution.

Author:

Tadaya Tsuyukubo

Method Summary

Modifier and Type	Method	Description
int	getBatchSize()	Returns the size of the batch query.
int	getBindingsSize()	Returns the number of bindings.
ConnectionInfo	getConnectionInfo()	Returns the associated ConnectionInfo.
Object	getCurrentMappedResult()	The mapped query result available for each query-result callback (ProxyExecutionListener.eachQueryResult(QueryExecutionInfo)).
int	getCurrentResultCount()	Represents the Nth Result.
Duration	getExecuteDuration()	Returns the time spent executing the query.
Method	getMethod()	Returns the method used for the query execution.
Object[]	getMethodArgs()	Returns the arguments passed to the invocation.
ProxyEventType	getProxyEventType()	Returns the proxy event type for the query execution.
List<QueryInfo>	getQueries()	Returns the list of QueryInfo.
long	getThreadId()	Returns the ID of the thread executing the query.
String	getThreadName()	Returns the name of the thread executing the query.
Throwable	getThrowable()	Returns the exception thrown by the invocation.
ExecutionType	getType()	Returns the type of query execution.
ValueStore	getValueStore()	Returns the ValueStore associated with the scope of the before/after query execution.
boolean	isSuccess()	Returns whether the query execution was successful.

Method Details

getMethod

Method getMethod()

Returns the method used for the query execution.

Returns:

invoked method

getMethodArgs

@Nullable
Object[] getMethodArgs()

Returns the arguments passed to the invocation. This value may be null when the method is invoked without any arguments.

Returns:

argument lists or null if the invoked method did not take any arguments

getThrowable

@Nullable
Throwable getThrowable()

Returns the exception thrown by the invocation. For the ProxyExecutionListener.beforeQuery(QueryExecutionInfo) callback, or when the query execution did not throw any error, this returns null.

Returns:

thrown exception

getConnectionInfo

ConnectionInfo getConnectionInfo()

Returns the associated ConnectionInfo.

Returns:

connection info

isSuccess

boolean isSuccess()

Returns whether the query execution was successful. This value is populated only after the query execution completes. A query execution is considered successful when the Publisher returned from Statement.execute() either received completion or at least one element is emitted regardless of it has received cancellation.

Returns:

true when query has successfully executed

getBatchSize

int getBatchSize()

Returns the size of the batch query. In other words, this is the number of calls to Batch.add(String).

Returns:

batch size

getQueries

List<QueryInfo> getQueries()

Returns the list of QueryInfo.

Returns:

the list of queries; never null

getType

ExecutionType getType()

Returns the type of query execution.

Returns:

type of query execution

getBindingsSize

int getBindingsSize()

Returns the number of bindings. In other words, this is the number of calls to Statement.add().

Returns:

size of the binding

getExecuteDuration

Duration getExecuteDuration()

Returns the time spent executing the query.

Duration is only populated in appropriate phase. (e.g.: ProxyExecutionListener.afterQuery(QueryExecutionInfo))

Returns:

query execution duration

getThreadName

String getThreadName()

Returns the name of the thread executing the query.

Returns:

thread name

getThreadId

long getThreadId()

Returns the ID of the thread executing the query.

Returns:

thread ID

getProxyEventType

ProxyEventType getProxyEventType()

Returns the proxy event type for the query execution.

Returns:

proxy event type; one of ProxyEventType.BEFORE_QUERY, ProxyEventType.AFTER_QUERY, or ProxyEventType.EACH_QUERY_RESULT

getCurrentResultCount

int getCurrentResultCount()

Represents the Nth Result. For each query-result callback (ProxyExecutionListener.eachQueryResult(QueryExecutionInfo)), this value indicates the Nth Result, starting from 1 (first, second, third, and so on). This returns 0 before query execution (ProxyExecutionListener.beforeQuery(QueryExecutionInfo)). For after-query execution (ProxyExecutionListener.afterQuery(QueryExecutionInfo)), it returns the total number of Result objects returned by this query execution.

Returns:

Nth number of query result

getCurrentMappedResult

@Nullable
Object getCurrentMappedResult()

The mapped query result available for each query-result callback (ProxyExecutionListener.eachQueryResult(QueryExecutionInfo)). For the before- and after-query execution callbacks (ProxyExecutionListener.beforeQuery(QueryExecutionInfo) and ProxyExecutionListener.afterQuery(QueryExecutionInfo)), this returns null.

Returns:

currently mapped result

getValueStore

ValueStore getValueStore()

Returns the ValueStore associated with the scope of the before/after query execution. Mainly used for passing values between ProxyExecutionListener.beforeQuery(QueryExecutionInfo) and ProxyExecutionListener.afterQuery(QueryExecutionInfo).

Returns:

value store