Package org.jdbi.v3.core.statement

Class Query

java.lang.Object

org.jdbi.v3.core.statement.SqlStatement<Query>

org.jdbi.v3.core.statement.Query

All Implemented Interfaces:

Closeable, AutoCloseable, Configurable<Query>, ResultBearing

public class Query
extends SqlStatement<Query>
implements ResultBearing

Statement providing convenience result handling for SQL queries.

Constructor Summary

Constructors

Constructor	Description
Query(Handle handle, CharSequence sql)
Query(Handle handle, String sql)	Backwards compatible constructor that takes an explicit string argument.

Method Summary

Modifier and Type	Method	Description
final Query	attachToHandleForCleanup()	Registers with the handle for cleaning when the handle is closed.
void	close()
Query	concurrentUpdatable()	Specify that the result set should be concurrent updatable.
final boolean	equals(Object o)
<R> R	execute(ResultProducer<R> producer)	Executes the query, returning the result obtained from the given ResultProducer.
ConfigRegistry	getConfig()	Returns the configuration registry associated with this object.
final StatementContext	getContext()	Returns the statement context associated with this statement.
final Handle	getHandle()
final int	hashCode()
<R> R	scanResultSet(ResultSetScanner<R> resultSetScanner)	Invokes the mapper with a result set supplier, and returns the value returned by the mapper.
Query	setFetchSize(int fetchSize)	Specify the fetch size for the query.
Query	setMaxFieldSize(int maxFields)	Specify the maximum field size in the result set.
Query	setMaxRows(int maxRows)	Specify the maximum number of rows the query is to return.

Methods inherited from class org.jdbi.v3.core.statement.SqlStatement

bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bind, bindArray, bindArray, bindArray, bindArray, bindArray, bindArray, bindArray, bindArray, bindASCIIStream, bindASCIIStream, bindBean, bindBean, bindBeanList, bindBinaryStream, bindBinaryStream, bindBySqlType, bindBySqlType, bindByType, bindByType, bindByType, bindByType, bindByType, bindByType, bindFields, bindFields, bindList, bindList, bindList, bindList, bindList, bindList, bindList, bindMap, bindMethods, bindMethods, bindMethodsList, bindNamedArgumentFinder, bindNull, bindNull, bindNVarchar, bindNVarchar, bindPojo, bindPojo, bindPojo, bindPojo, bindPojo, bindPojo, cleanupHandleCommit, cleanupHandleRollback, defineList, defineList, defineNamedBindings, setQueryTimeout, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jdbi.v3.core.config.Configurable

addCustomizer, configure, define, getConfig, registerArgument, registerArgument, registerArrayType, registerArrayType, registerArrayType, registerArrayType, registerCodecFactory, registerCollector, registerColumnMapper, registerColumnMapper, registerColumnMapper, registerColumnMapper, registerColumnMapper, registerColumnMapper, registerExtension, registerRowMapper, registerRowMapper, registerRowMapper, registerRowMapper, setMapKeyColumn, setMapValueColumn, setSqlArrayArgumentStrategy, setSqlLogger, setSqlParser, setTemplateEngine, setTimingCollector

Methods inherited from interface org.jdbi.v3.core.result.ResultBearing

collectInto, collectInto, collectInto, collectRows, map, map, map, mapTo, mapTo, mapTo, mapTo, mapToBean, mapToMap, mapToMap, mapToMap, reduceResultSet, reduceRows, reduceRows, reduceRows

Constructor Details

Query

public Query(Handle handle,
 CharSequence sql)

Query

public Query(Handle handle,
 String sql)

Backwards compatible constructor that takes an explicit string argument.

See Also:

• Query(Handle, CharSequence)

Method Details

execute

public <R> R execute(ResultProducer<R> producer)

Executes the query, returning the result obtained from the given ResultProducer.

Type Parameters:

R - the type of the result

Parameters:

producer - the result producer.

Returns:

value returned by the result producer.

scanResultSet

public <R> R scanResultSet(ResultSetScanner<R> resultSetScanner)

Description copied from interface: ResultBearing

Invokes the mapper with a result set supplier, and returns the value returned by the mapper.

Specified by:

scanResultSet in interface ResultBearing

Type Parameters:

R - result type returned by the mapper.

Parameters:

resultSetScanner - result set scanner

Returns:

the value returned by the mapper.

setFetchSize

public Query setFetchSize(int fetchSize)

Specify the fetch size for the query. This should cause the results to be fetched from the underlying RDBMS in groups of rows equal to the number passed. This is useful for doing chunked streaming of results when exhausting memory could be a problem.

Parameters:

fetchSize - the number of rows to fetch in a bunch

Returns:

the modified query

setMaxRows

public Query setMaxRows(int maxRows)

Specify the maximum number of rows the query is to return. This uses the underlying JDBC Statement.setMaxRows(int)}.

Parameters:

maxRows - maximum number of rows to return

Returns:

modified query

setMaxFieldSize

public Query setMaxFieldSize(int maxFields)

Specify the maximum field size in the result set. This uses the underlying JDBC Statement.setMaxFieldSize(int)

Parameters:

maxFields - maximum field size

Returns:

modified query

concurrentUpdatable

public Query concurrentUpdatable()

Specify that the result set should be concurrent updatable. This will allow the update methods to be called on the result set produced by this Query.

Returns:

the modified query

getHandle

public final Handle getHandle()

getConfig

public ConfigRegistry getConfig()

Description copied from interface: Configurable

Returns the configuration registry associated with this object.

Specified by:

getConfig in interface Configurable<This>

Returns:

the configuration registry associated with this object.

getContext

public final StatementContext getContext()

Returns the statement context associated with this statement.

Returns:

the statement context associated with this statement.

attachToHandleForCleanup

@Alpha
public final Query attachToHandleForCleanup()

Registers with the handle for cleaning when the handle is closed.
There are some situations where Statements need to be cleaned up to avoid resource leaks. This method registers the current Statement it with the Handle. If the statement or the context are cleaned by themselves, it will automatically unregister, so in normal operations, resources should not pool for cleanup with the Handle.

Since:

3.35.0

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object