com.avaje.ebean

Interface SqlQuery

All Superinterfaces:

Serializable

public interface SqlQuery
extends Serializable

Query object for performing native SQL queries that return SqlRow's.

Firstly note that you can use your own sql queries with entity beans by using the SqlSelect annotation. This should be your first approach when wanting to use your own SQL queries.

If ORM Mapping is too tight and constraining for your problem then SqlQuery could be a good approach.

The returned SqlRow objects are similar to a LinkedHashMap with some type conversion support added.

  // its typically a good idea to use a named query
  // and put the sql in the orm.xml instead of in your code

  String sql = "select id, name from customer where name like :name and status_code = :status";

  SqlQuery sqlQuery = Ebean.createSqlQuery(sql);
  sqlQuery.setParameter("name", "Acme%");
  sqlQuery.setParameter("status", "ACTIVE");

  // execute the query returning a List of MapBean objects
  List<SqlRow> list = sqlQuery.findList();

Method Summary

Modifier and Type	Method and Description
void	findEach(QueryEachConsumer<SqlRow> consumer) Execute the SqlQuery iterating a row at a time.
void	findEachWhile(QueryEachWhileConsumer<SqlRow> consumer) Execute the SqlQuery iterating a row at a time with the ability to stop consuming part way through.
List<SqlRow>	findList() Execute the query returning a list.
SqlRow	findUnique() Execute the query returning a single row or null.
SqlQuery	setBufferFetchSizeHint(int bufferFetchSizeHint) A hint which for JDBC translates to the Statement.fetchSize().
SqlQuery	setFirstRow(int firstRow) Set the index of the first row of the results to return.
SqlQuery	setMaxRows(int maxRows) Set the maximum number of query results to return.
SqlQuery	setParameter(int position, Object value) The same as bind for positioned parameters.
SqlQuery	setParameter(String name, Object value) The same as bind for named parameters.
SqlQuery	setTimeout(int secs) Set a timeout on this query.

Method Detail

findList

List<SqlRow> findList()

Execute the query returning a list.

findEach

void findEach(QueryEachConsumer<SqlRow> consumer)

Execute the SqlQuery iterating a row at a time.

This streaming type query is useful for large query execution as only 1 row needs to be held in memory.

findEachWhile

void findEachWhile(QueryEachWhileConsumer<SqlRow> consumer)

Execute the SqlQuery iterating a row at a time with the ability to stop consuming part way through.

Returning false after processing a row stops the iteration through the query results.

This streaming type query is useful for large query execution as only 1 row needs to be held in memory.

findUnique

SqlRow findUnique()

Execute the query returning a single row or null.

If this query finds 2 or more rows then it will throw a PersistenceException.

setParameter

SqlQuery setParameter(String name,
                      Object value)

The same as bind for named parameters.

setParameter

SqlQuery setParameter(int position,
                      Object value)

The same as bind for positioned parameters.

setFirstRow

SqlQuery setFirstRow(int firstRow)

Set the index of the first row of the results to return.

setMaxRows

SqlQuery setMaxRows(int maxRows)

Set the maximum number of query results to return.

setTimeout

SqlQuery setTimeout(int secs)

Set a timeout on this query.

This will typically result in a call to setQueryTimeout() on a preparedStatement. If the timeout occurs an exception will be thrown - this will be a SQLException wrapped up in a PersistenceException.

Parameters:

secs - the query timeout limit in seconds. Zero means there is no limit.

setBufferFetchSizeHint

SqlQuery setBufferFetchSizeHint(int bufferFetchSizeHint)

A hint which for JDBC translates to the Statement.fetchSize().

Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed for ResultSet.