io.r2dbc.proxy.core

Interface QueryExecutionInfo

All Known Implementing Classes:

MockQueryExecutionInfo

public interface QueryExecutionInfo

Hold query execution related information.

Author:

Tadaya Tsuyukubo

Method Summary

Modifier and Type	Method and Description
int	getBatchSize() Get the size of the batch query.
int	getBindingsSize() Get the number of the binding.
ConnectionInfo	getConnectionInfo() Get the associated ConnectionInfo.
Object	getCurrentMappedResult() Mapped query result available for each-query-result-callback(ProxyExecutionListener.eachQueryResult(QueryExecutionInfo)).
int	getCurrentResultCount() Represent Nth Result.
Duration	getExecuteDuration() Get the time that took queries to execute.
Method	getMethod() Get the invoked query execution Method.
Object[]	getMethodArgs() Get the arguments of the invocation.
ProxyEventType	getProxyEventType() Get the proxy event type for query execution.
List<QueryInfo>	getQueries() Get the list of QueryInfo.
long	getThreadId() Get the currently executed thread ID.
String	getThreadName() Get the currently executed thread name.
Throwable	getThrowable() Get the thrown exception.
ExecutionType	getType() Get the type of query execution.
ValueStore	getValueStore() Retrieve ValueStore which is associated to the scope of before/after method execution.
boolean	isSuccess() Indicate whether the query execution was successful or not.

Method Detail

getMethod

Method getMethod()

Get the invoked query execution Method.

Returns:

invoked method

getMethodArgs

@Nullable
Object[] getMethodArgs()

Get the arguments of the invocation. This can be null when method is invoked with no argument.

Returns:

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

getThrowable

@Nullable
Throwable getThrowable()

Get the thrown exception. For ProxyExecutionListener.beforeQuery(QueryExecutionInfo) callback or query execution did't throw any error, this returns null.

Returns:

thrown exception

getConnectionInfo

ConnectionInfo getConnectionInfo()

Get the associated ConnectionInfo.

Returns:

connection info

isSuccess

boolean isSuccess()

Indicate whether the query execution was successful or not. Contains valid value only after the query execution. 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()

Get the size of the batch query. i.e. Number of the calls of Batch.add(String).

Returns:

batch size

getQueries

List<QueryInfo> getQueries()

Get the list of QueryInfo.

Returns:

list of queries. This will NOT return null.

getType

ExecutionType getType()

Get the type of query execution.

Returns:

type of query execution

getBindingsSize

int getBindingsSize()

Get the number of the binding. i.e. Number of the calls of Statement.add().

Returns:

size of the binding

getExecuteDuration

Duration getExecuteDuration()

Get the time that took queries to execute.

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

Returns:

query execution duration

getThreadName

String getThreadName()

Get the currently executed thread name.

Returns:

thread name

getThreadId

long getThreadId()

Get the currently executed thread ID.

Returns:

thread ID

getProxyEventType

ProxyEventType getProxyEventType()

Get the proxy event type for query execution.

Returns:

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

getCurrentResultCount

int getCurrentResultCount()

Represent Nth Result. On each query result callback(ProxyExecutionListener.eachQueryResult(QueryExecutionInfo)), this value indicates Nth Result starting from 1. (1st query result, 2nd query result, 3rd, 4th,...). This returns 0 for before query execution(ProxyExecutionListener.beforeQuery(QueryExecutionInfo)). For after query execution(ProxyExecutionListener.afterQuery(QueryExecutionInfo)), this returns total number of Result returned by this query execution.

Returns:

Nth number of query result

getCurrentMappedResult

@Nullable
Object getCurrentMappedResult()

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

Returns:

currently mapped result

getValueStore

ValueStore getValueStore()

Retrieve ValueStore which is associated to the scope of before/after method execution. Mainly used for passing values between ProxyExecutionListener.beforeQuery(QueryExecutionInfo) and ProxyExecutionListener.afterQuery(QueryExecutionInfo).

Returns:

value store