com.avaje.ebeaninternal.server.query

Class CQueryPlan

java.lang.Object

com.avaje.ebeaninternal.server.query.CQueryPlan

Direct Known Subclasses:

CQueryPlanRawSql

public class CQueryPlan
extends Object

Represents a query for a given SQL statement.

This can be executed multiple times with different bind parameters.

That is, the sql including the where clause, order by clause etc must be exactly the same to share the same query plan with the only difference being bind values.

This is useful in that is common in OLTP type applications that the same query will be executed quite a lot just with different bind values. With this query plan we can bypass some of the query statement generation (for performance) and collect statistics on the number and average execution times. This is turn can be used to identify queries that could be looked at for performance tuning.

Constructor Summary

Constructors

Constructor and Description
CQueryPlan(OrmQueryRequest<?> request, SqlLimitResponse sqlRes, SqlTree sqlTree, boolean rawSql, String logWhereSql) Create a query plan based on a OrmQueryRequest.
CQueryPlan(OrmQueryRequest<?> request, String sql, SqlTree sqlTree, boolean rawSql, boolean rowNumberIncluded, String logWhereSql) Create a query plan for a raw sql query.

Method Summary

Methods

Modifier and Type	Method and Description
void	bindEncryptedProperties(DataBind dataBind)
DataReader	createDataReader(ResultSet rset)
void	executionTime(long loadedBeanCount, long timeMicros, ObjectGraphNode objectGraphNode) Register an execution time against this query plan;
Class<?>	getBeanType()
HashQueryPlan	getHash()
long	getLastQueryTime() Return the time this query plan was last used.
String	getLogWhereSql()
CQueryPlanStats	getQueryStats() Return the current query statistics.
CQueryPlanStats.Snapshot	getSnapshot(boolean reset)
String	getSql()
SqlTree	getSqlTree()
boolean	isAutofetchTuned()
boolean	isRawSql()
boolean	isRowNumberIncluded()
void	resetStatistics() Reset the query statistics.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CQueryPlan

public CQueryPlan(OrmQueryRequest<?> request,
          SqlLimitResponse sqlRes,
          SqlTree sqlTree,
          boolean rawSql,
          String logWhereSql)

Create a query plan based on a OrmQueryRequest.

CQueryPlan

public CQueryPlan(OrmQueryRequest<?> request,
          String sql,
          SqlTree sqlTree,
          boolean rawSql,
          boolean rowNumberIncluded,
          String logWhereSql)

Create a query plan for a raw sql query.

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getBeanType

public Class<?> getBeanType()

createDataReader

public DataReader createDataReader(ResultSet rset)

bindEncryptedProperties

public void bindEncryptedProperties(DataBind dataBind)
                             throws SQLException

Throws:

SQLException

isAutofetchTuned

public boolean isAutofetchTuned()

getHash

public HashQueryPlan getHash()

getSql

public String getSql()

getSqlTree

public SqlTree getSqlTree()

isRawSql

public boolean isRawSql()

isRowNumberIncluded

public boolean isRowNumberIncluded()

getLogWhereSql

public String getLogWhereSql()

resetStatistics

public void resetStatistics()

Reset the query statistics.

executionTime

public void executionTime(long loadedBeanCount,
                 long timeMicros,
                 ObjectGraphNode objectGraphNode)

Register an execution time against this query plan;

getSnapshot

public CQueryPlanStats.Snapshot getSnapshot(boolean reset)

getQueryStats

public CQueryPlanStats getQueryStats()

Return the current query statistics.

getLastQueryTime

public long getLastQueryTime()

Return the time this query plan was last used.