Module io.ebean.core

Package io.ebeaninternal.server.querydefn

Class DefaultRelationalQuery

java.lang.Object

io.ebeaninternal.server.querydefn.AbstractQuery

io.ebeaninternal.server.querydefn.DefaultRelationalQuery

All Implemented Interfaces:

CancelableQuery, SqlQuery, SpiCancelableQuery, SpiSqlBinding, SpiSqlQuery, Serializable

@NullMarked
public final class DefaultRelationalQuery
extends AbstractQuery
implements SpiSqlQuery

Default implementation of SQuery - SQL Query.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface io.ebean.SqlQuery

SqlQuery.TypeQuery<T>

Field Summary

Fields inherited from class io.ebeaninternal.server.querydefn.AbstractQuery

useMaster

Constructor Summary

Constructors

Constructor	Description
DefaultRelationalQuery(SpiEbeanServer server, String query)	Additional supply a query detail object.

Method Summary

Modifier and Type	Method	Description
void	findEach(Consumer<SqlRow> consumer)
void	findEachRow(RowConsumer consumer)
void	findEachWhile(Predicate<SqlRow> consumer)
List<SqlRow>	findList()
SqlRow	findOne()
Optional<SqlRow>	findOneOrEmpty()
BindParams	getBindParams()	Return the named or positioned parameters.
int	getBufferFetchSizeHint()	Return the hint for Statement.setFetchSize().
int	getFirstRow()	Return the first row to fetch.
String	getLabel()	Return the label (to collect metrics on when set).
int	getMaxRows()	Return the maximum number of rows to fetch.
String	getQuery()	return the query.
int	getTimeout()	Return the query timeout.
boolean	isUseMaster()	Return true if this query should not use the read only data source.
<T> SqlQuery.TypeQuery<T>	mapTo(RowMapper<T> mapper)
<T> SqlQuery.TypeQuery<T>	mapToScalar(Class<T> attributeType)
DefaultRelationalQuery	setArrayParameter(int position, Collection<?> value)
DefaultRelationalQuery	setArrayParameter(String paramName, Collection<?> value)
DefaultRelationalQuery	setBufferFetchSizeHint(int bufferFetchSizeHint)
final void	setDefaultFetchBuffer(int fetchSize)	Set the JDBC fetchSize buffer hint if not explicitly set.
DefaultRelationalQuery	setFirstRow(int firstRow)
DefaultRelationalQuery	setLabel(String label)
DefaultRelationalQuery	setMaxRows(int maxRows)
SqlQuery	setNullParameter(int position, int jdbcType)
SqlQuery	setNullParameter(String name, int jdbcType)
DefaultRelationalQuery	setParameter(int position, Object value)
DefaultRelationalQuery	setParameter(Object value)
DefaultRelationalQuery	setParameter(String paramName, Object value)
DefaultRelationalQuery	setParameters(Object... values)
DefaultRelationalQuery	setTimeout(int secs)
String	toString()
SpiTransaction	transaction()	Return the transaction explicitly associated to the query.
SqlQuery	usingConnection(Connection connection)
SqlQuery	usingMaster()
SqlQuery	usingTransaction(Transaction transaction)

Methods inherited from class io.ebeaninternal.server.querydefn.AbstractQuery

cancel, checkCancelled, setCancelableQuery

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.ebean.CancelableQuery

cancel

Methods inherited from interface io.ebeaninternal.api.SpiCancelableQuery

checkCancelled, setCancelableQuery

Constructor Details

DefaultRelationalQuery

public DefaultRelationalQuery(SpiEbeanServer server,
 String query)

Additional supply a query detail object.

Method Details

transaction

public SpiTransaction transaction()

Description copied from interface: SpiSqlBinding

Return the transaction explicitly associated to the query.

Specified by:

transaction in interface SpiSqlBinding

usingTransaction

public SqlQuery usingTransaction(Transaction transaction)

Specified by:

usingTransaction in interface SqlQuery

usingConnection

public SqlQuery usingConnection(Connection connection)

Specified by:

usingConnection in interface SqlQuery

usingMaster

public SqlQuery usingMaster()

Specified by:

usingMaster in interface SqlQuery

isUseMaster

public boolean isUseMaster()

Description copied from interface: SpiSqlBinding

Return true if this query should not use the read only data source.

Specified by:

isUseMaster in interface SpiSqlBinding

findEach

public void findEach(Consumer<SqlRow> consumer)

Specified by:

findEach in interface SqlQuery

findEachWhile

public void findEachWhile(Predicate<SqlRow> consumer)

Specified by:

findEachWhile in interface SqlQuery

findList

public List<SqlRow> findList()

Specified by:

findList in interface SqlQuery

findEachRow

public void findEachRow(RowConsumer consumer)

Specified by:

findEachRow in interface SqlQuery

findOne

public SqlRow findOne()

Specified by:

findOne in interface SqlQuery

findOneOrEmpty

public Optional<SqlRow> findOneOrEmpty()

Specified by:

findOneOrEmpty in interface SqlQuery

setParameters

public DefaultRelationalQuery setParameters(Object... values)

Specified by:

setParameters in interface SqlQuery

setParameter

public DefaultRelationalQuery setParameter(Object value)

Specified by:

setParameter in interface SqlQuery

setNullParameter

public SqlQuery setNullParameter(int position,
 int jdbcType)

Specified by:

setNullParameter in interface SqlQuery

setNullParameter

public SqlQuery setNullParameter(String name,
 int jdbcType)

Specified by:

setNullParameter in interface SqlQuery

setParameter

public DefaultRelationalQuery setParameter(int position,
 Object value)

Specified by:

setParameter in interface SqlQuery

setArrayParameter

public DefaultRelationalQuery setArrayParameter(int position,
 Collection<?> value)

Specified by:

setArrayParameter in interface SqlQuery

setParameter

public DefaultRelationalQuery setParameter(String paramName,
 Object value)

Specified by:

setParameter in interface SqlQuery

setArrayParameter

public DefaultRelationalQuery setArrayParameter(String paramName,
 Collection<?> value)

Specified by:

setArrayParameter in interface SqlQuery

toString

public String toString()

Overrides:

toString in class Object

getFirstRow

public int getFirstRow()

Description copied from interface: SpiSqlBinding

Return the first row to fetch.

Specified by:

getFirstRow in interface SpiSqlBinding

setFirstRow

public DefaultRelationalQuery setFirstRow(int firstRow)

Specified by:

setFirstRow in interface SqlQuery

getMaxRows

public int getMaxRows()

Description copied from interface: SpiSqlBinding

Return the maximum number of rows to fetch.

Specified by:

getMaxRows in interface SpiSqlBinding

setMaxRows

public DefaultRelationalQuery setMaxRows(int maxRows)

Specified by:

setMaxRows in interface SqlQuery

getTimeout

public int getTimeout()

Description copied from interface: SpiSqlBinding

Return the query timeout.

Specified by:

getTimeout in interface SpiSqlBinding

setTimeout

public DefaultRelationalQuery setTimeout(int secs)

Specified by:

setTimeout in interface SqlQuery

getLabel

public String getLabel()

Description copied from interface: SpiSqlBinding

Return the label (to collect metrics on when set).

Specified by:

getLabel in interface SpiSqlBinding

setLabel

public DefaultRelationalQuery setLabel(String label)

Specified by:

setLabel in interface SqlQuery

getBindParams

public BindParams getBindParams()

Description copied from interface: SpiSqlBinding

Return the named or positioned parameters.

Specified by:

getBindParams in interface SpiSqlBinding

setDefaultFetchBuffer

public final void setDefaultFetchBuffer(int fetchSize)

Description copied from interface: SpiSqlBinding

Set the JDBC fetchSize buffer hint if not explicitly set.

Specified by:

setDefaultFetchBuffer in interface SpiSqlBinding

setBufferFetchSizeHint

public DefaultRelationalQuery setBufferFetchSizeHint(int bufferFetchSizeHint)

Specified by:

setBufferFetchSizeHint in interface SqlQuery

getBufferFetchSizeHint

public int getBufferFetchSizeHint()

Description copied from interface: SpiSqlBinding

Return the hint for Statement.setFetchSize().

Specified by:

getBufferFetchSizeHint in interface SpiSqlBinding

getQuery

public String getQuery()

Description copied from interface: SpiSqlBinding

return the query.

Specified by:

getQuery in interface SpiSqlBinding

mapToScalar

public <T> SqlQuery.TypeQuery<T> mapToScalar(Class<T> attributeType)

Specified by:

mapToScalar in interface SqlQuery

mapTo

public <T> SqlQuery.TypeQuery<T> mapTo(RowMapper<T> mapper)

Specified by:

mapTo in interface SqlQuery