Interface RelationalQueryEngine

All Known Implementing Classes:

DefaultRelationalQueryEngine

public interface RelationalQueryEngine

Method Summary

Modifier and Type	Method	Description
boolean	captureActive()	Return true if query plan capture is enabled (the master switch).
void	collect(String label, long exeMicros)	Collect SQL query execution statistics.
io.ebean.SqlRow	createSqlRow(int estimateCapacity)	Return a new SqlRow with appropriate mapping for DB true and optimised binary UUID etc.
void	findEach(RelationalQueryRequest request, io.ebean.RowConsumer mapper)	Find each via raw consumer.
<T> void	findEach(RelationalQueryRequest request, RowReader<T> reader, Predicate<T> consumer)	Find each while query using relational query.
<T> List<T>	findList(RelationalQueryRequest request, RowReader<T> reader)	Find a list of beans using relational query.
<T> T	findOne(RelationalQueryRequest request, io.ebean.RowMapper<T> mapper)	Find one via mapper.
<T> T	findSingleAttribute(RelationalQueryRequest request, Class<T> cls)	Find single attribute.
<T> void	findSingleAttributeEach(RelationalQueryRequest request, Class<T> cls, Consumer<T> consumer)	Find single attribute streaming the result to a consumer.
<T> List<T>	findSingleAttributeList(RelationalQueryRequest request, Class<T> cls)	Find single attribute list.
SqlQueryPlan	obtainPlan(String label, String sql, SpiEbeanServer server)	Obtain (creating and caching if necessary) the query plan for a labelled native SqlQuery, used to capture bind values for database query plan collection.
void	queryPlanInit(io.ebean.meta.QueryPlanInit request, List<io.ebean.meta.MetaQueryPlan> list)	Initiate query plan bind capture for matching SqlQuery plans.
void	visitMetrics(io.ebean.meta.MetricVisitor visitor)	Visit the metrics.

Method Details

createSqlRow

io.ebean.SqlRow createSqlRow(int estimateCapacity)

Return a new SqlRow with appropriate mapping for DB true and optimised binary UUID etc.

findList

<T> List<T> findList(RelationalQueryRequest request,
 RowReader<T> reader)

Find a list of beans using relational query.

findEach

<T> void findEach(RelationalQueryRequest request,
 RowReader<T> reader,
 Predicate<T> consumer)

Find each while query using relational query.

findEach

void findEach(RelationalQueryRequest request,
 io.ebean.RowConsumer mapper)

Find each via raw consumer.

findOne

<T> T findOne(RelationalQueryRequest request,
 io.ebean.RowMapper<T> mapper)

Find one via mapper.

findSingleAttribute

<T> T findSingleAttribute(RelationalQueryRequest request,
 Class<T> cls)

Find single attribute.

findSingleAttributeList

<T> List<T> findSingleAttributeList(RelationalQueryRequest request,
 Class<T> cls)

Find single attribute list.

findSingleAttributeEach

<T> void findSingleAttributeEach(RelationalQueryRequest request,
 Class<T> cls,
 Consumer<T> consumer)

Find single attribute streaming the result to a consumer.

collect

void collect(String label,
 long exeMicros)

Collect SQL query execution statistics.

captureActive

boolean captureActive()

Return true if query plan capture is enabled (the master switch). When false no SqlQuery plans are created or cached, so labelled queries incur no extra cost.

obtainPlan

SqlQueryPlan obtainPlan(String label,
 String sql,
 SpiEbeanServer server)

Obtain (creating and caching if necessary) the query plan for a labelled native SqlQuery, used to capture bind values for database query plan collection.

queryPlanInit

void queryPlanInit(io.ebean.meta.QueryPlanInit request,
 List<io.ebean.meta.MetaQueryPlan> list)

Initiate query plan bind capture for matching SqlQuery plans.

visitMetrics

void visitMetrics(io.ebean.meta.MetricVisitor visitor)

Visit the metrics.