com.avaje.ebeaninternal.server.query.CQueryPlan Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ebean Show documentation
Ebean
There is a newer version: 2.8.1
package com.avaje.ebeaninternal.server.query;

import java.sql.ResultSet;
import java.sql.SQLException;

import com.avaje.ebean.config.dbplatform.SqlLimitResponse;
import com.avaje.ebean.meta.MetaQueryStatistic;
import com.avaje.ebeaninternal.server.core.OrmQueryRequest;
import com.avaje.ebeaninternal.server.deploy.BeanProperty;
import com.avaje.ebeaninternal.server.type.DataBind;
import com.avaje.ebeaninternal.server.type.DataReader;
import com.avaje.ebeaninternal.server.type.RsetDataReader;

/**
 * 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.
 * 
 */
public class CQueryPlan {

	private final boolean autofetchTuned;
		
	private final int hash;
	
	private final boolean rawSql;

	private final boolean rowNumberIncluded;

	private final String sql;

	private final String logWhereSql;

	private final SqlTree sqlTree;

	/**
	 * Encrypted properties required additional binding.
	 */
	private final BeanProperty[] encryptedProps;
	
	private CQueryStats queryStats = new CQueryStats();

	/**
	 * Create a query plan based on a OrmQueryRequest.
	 */
	public CQueryPlan(OrmQueryRequest request, SqlLimitResponse sqlRes, SqlTree sqlTree, 
			boolean rawSql, String logWhereSql, String luceneQueryDescription) {
		
		this.hash = request.getQueryPlanHash();
		this.autofetchTuned = request.getQuery().isAutofetchTuned();
		if (sqlRes != null){
	        this.sql = sqlRes.getSql();
	        this.rowNumberIncluded = sqlRes.isIncludesRowNumberColumn();		    
		} else {
		    this.sql = luceneQueryDescription;
		    this.rowNumberIncluded = false;
		}
		this.sqlTree = sqlTree;
		this.rawSql = rawSql;
		this.logWhereSql = logWhereSql;
		this.encryptedProps = sqlTree.getEncryptedProps();
	}

	/**
	 * Create a query plan for a raw sql query.
	 */
	public CQueryPlan(String sql, SqlTree sqlTree, 
			boolean rawSql, boolean rowNumberIncluded, String logWhereSql) {
		
		this.hash = 0;
		this.autofetchTuned = false;
		this.sql = sql;
		this.sqlTree = sqlTree;
		this.rawSql = rawSql;
		this.rowNumberIncluded = rowNumberIncluded;
		this.logWhereSql = logWhereSql;
		this.encryptedProps = sqlTree.getEncryptedProps();
	}

	public boolean isLucene() {
	    return false;
	}
	
    public DataReader createDataReader(ResultSet rset){
        
        return new RsetDataReader(rset);
    }

	public void bindEncryptedProperties(DataBind dataBind) throws SQLException {
	    if (encryptedProps != null){
	        for (int i = 0; i < encryptedProps.length; i++) {
	            String key = encryptedProps[i].getEncryptKey().getStringValue();
	            dataBind.setString(key);
            }
	    }
	}
	
	public boolean isAutofetchTuned() {
		return autofetchTuned;
	}

	public int getHash() {
		return hash;
	}

	public String getSql() {
		return sql;
	}

	public SqlTree getSqlTree() {
		return sqlTree;
	}

	public boolean isRawSql() {
		return rawSql;
	}

	public boolean isRowNumberIncluded() {
		return rowNumberIncluded;
	}

	public String getLogWhereSql() {
		return logWhereSql;
	}

	/**
	 * Reset the query statistics.
	 */
	public void resetStatistics() {
		queryStats = new CQueryStats();
	}
	
	/**
	 * Register an execution time against this query plan;
	 */
	public void executionTime(int loadedBeanCount, int timeMicros) {
		// Atomic operation
		queryStats = queryStats.add(loadedBeanCount, timeMicros);
	}

	/**
	 * Return the current query statistics.
	 */
	public CQueryStats getQueryStats() {
		return queryStats;
	}
	
	/**
	 * Return the time this query plan was last used.
	 */
	public long getLastQueryTime(){
	    return queryStats.getLastQueryTime();
	}
	
	public MetaQueryStatistic createMetaQueryStatistic(String beanName) {
		return queryStats.createMetaQueryStatistic(beanName, this);
	}

}