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.
<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()
<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 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

Modifier and Type	Method	Description
final Query	bind(int position, boolean value)	Bind an argument positionally
final Query	bind(int position, byte value)	Bind an argument positionally
final Query	bind(int position, byte[] value)	Bind an argument positionally
final Query	bind(int position, char value)	Bind an argument positionally
final Query	bind(int position, double value)	Bind an argument positionally
final Query	bind(int position, float value)	Bind an argument positionally
final Query	bind(int position, int value)	Bind an argument positionally
final Query	bind(int position, long value)	Bind an argument positionally
final Query	bind(int position, short value)	Bind an argument positionally
final Query	bind(int position, Reader value, int length)	Bind an argument positionally
final Query	bind(int position, Boolean value)	Bind an argument positionally
final Query	bind(int position, Byte value)	Bind an argument positionally
final Query	bind(int position, Character value)	Bind an argument positionally
final Query	bind(int position, Double value)	Bind an argument positionally
final Query	bind(int position, Float value)	Bind an argument positionally
final Query	bind(int position, Integer value)	Bind an argument positionally
final Query	bind(int position, Long value)	Bind an argument positionally
final Query	bind(int position, Object value)	Bind an argument positionally
final Query	bind(int position, Short value)	Bind an argument positionally
final Query	bind(int position, String value)	Bind an argument positionally
final Query	bind(int position, BigDecimal value)	Bind an argument positionally
final Query	bind(int position, URI value)	Bind an argument positionally
final Query	bind(int position, URL value)	Bind an argument positionally
final Query	bind(int position, Blob value)	Bind an argument positionally
final Query	bind(int position, Clob value)	Bind an argument positionally
final Query	bind(int position, Date value)	Bind an argument positionally
final Query	bind(int position, Time value)	Bind an argument positionally
final Query	bind(int position, Timestamp value)	Bind an argument positionally
final Query	bind(int position, Date value)	Bind an argument positionally
final Query	bind(int position, UUID value)	Bind an argument positionally
Query	bind(int position, Argument argument)	Used if you need to have some exotic parameter bound.
final Query	bind(String name, boolean value)	Bind an argument by name
final Query	bind(String name, byte value)	Bind an argument by name
final Query	bind(String name, byte[] value)	Bind an argument by name
final Query	bind(String name, char value)	Bind an argument by name
final Query	bind(String name, double value)	Bind an argument by name
final Query	bind(String name, float value)	Bind an argument by name
final Query	bind(String name, int value)	Bind an argument by name
final Query	bind(String name, long value)	Bind an argument by name
final Query	bind(String name, short value)	Bind an argument by name
final Query	bind(String name, Reader value, int length)	Bind an argument by name
final Query	bind(String name, Boolean value)	Bind an argument by name
final Query	bind(String name, Byte value)	Bind an argument by name
final Query	bind(String name, Character value)	Bind an argument by name
final Query	bind(String name, Double value)	Bind an argument by name
final Query	bind(String name, Float value)	Bind an argument by name
final Query	bind(String name, Integer value)	Bind an argument by name
final Query	bind(String name, Long value)	Bind an argument by name
final Query	bind(String name, Object value)	Bind an argument by name
final Query	bind(String name, Short value)	Bind an argument by name
final Query	bind(String name, String value)	Bind an argument by name
final Query	bind(String name, BigDecimal value)	Bind an argument by name
final Query	bind(String name, URI value)	Bind an argument by name
final Query	bind(String name, URL value)	Bind an argument by name
final Query	bind(String name, Blob value)	Bind an argument by name
final Query	bind(String name, Clob value)	Bind an argument by name
final Query	bind(String name, Date value)	Bind an argument by name
final Query	bind(String name, Time value)	Bind an argument by name
final Query	bind(String name, Timestamp value)	Bind an argument by name
final Query	bind(String name, Date value)	Bind an argument by name
final Query	bind(String name, UUID value)	Bind an argument by name
Query	bind(String name, Argument argument)	Used if you need to have some exotic parameter bound.
final Query	bindArray(int pos, Type elementType, Iterable<?> iterable)	Bind an Iterable as a SQL array.
final Query	bindArray(int pos, Type elementType, Object... array)	Bind a Java array as a SQL array, casting each element to a new type.
final Query	bindArray(int pos, Type elementType, Iterator<?> iterator)	Bind an Iterator as a SQL array.
final <T> Query	bindArray(int pos, T... array)	Bind a Java array as a SQL array.
final Query	bindArray(String name, Type elementType, Iterable<?> iterable)	Bind an Iterable as a SQL array.
final Query	bindArray(String name, Type elementType, Object... array)	Bind a Java array as a SQL array, casting each element to a new type.
final Query	bindArray(String name, Type elementType, Iterator<?> iterator)	Bind an Iterator as a SQL array.
final <T> Query	bindArray(String name, T... array)	Bind a Java array as a SQL array.
final Query	bindASCIIStream(int position, InputStream value, int length)	Bind an argument positionally
final Query	bindASCIIStream(String name, InputStream value, int length)	Bind an argument by name
Query	bindBean(Object bean)	Binds named parameters from JavaBean properties on the argument.
Query	bindBean(String prefix, Object bean)	Binds named parameters from JavaBean properties on the bean argument, with the given prefix.
final Query	bindBeanList(String key, List<?> values, List<String> propertyNames)	Bind a parameter for each value in the given list * number of property names, and defines an attribute as the comma-separated list of parameter references (using colon prefix).
final Query	bindBinaryStream(int position, InputStream value, int length)	Bind an argument positionally
final Query	bindBinaryStream(String name, InputStream value, int length)	Bind an argument by name
final Query	bindBySqlType(int position, Object value, int sqlType)	Bind a value using a specific type from java.sql.Types via PreparedStatement#setObject(int, Object, int)
final Query	bindBySqlType(String name, Object value, int sqlType)	Bind a value using a specific type from java.sql.Types via PreparedStatement#setObject(int, Object, int)
final Query	bindByType(int position, Object value, Type argumentType)	Bind an argument dynamically by the type passed in.
final Query	bindByType(int position, Object value, GenericType<?> argumentType)	Bind an argument dynamically by the generic type passed in.
final Query	bindByType(int position, Object value, QualifiedType<?> argumentType)	Bind an argument dynamically by the qualified type passed in.
final Query	bindByType(String name, Object value, Type argumentType)	Bind an argument dynamically by the type passed in.
final Query	bindByType(String name, Object value, GenericType<?> argumentType)	Bind an argument dynamically by the generic type passed in.
final Query	bindByType(String name, Object value, QualifiedType<?> argumentType)	Bind an argument dynamically by the type passed in.
Query	bindFields(Object object)	Binds public fields of the specified object as arguments for the query.
Query	bindFields(String prefix, Object object)	Binds public fields of the specified object as arguments for the query.
final Query	bindList(String key, Iterable<?> values)	see SqlStatement.bindList(BiConsumer, String, List)
final Query	bindList(String key, Object... values)	see SqlStatement.bindList(BiConsumer, String, List)
final Query	bindList(String key, Iterator<?> values)	see SqlStatement.bindList(BiConsumer, String, List)
final Query	bindList(BiConsumer<SqlStatement, String> onEmpty, String key, Iterable<?> values)	see SqlStatement.bindList(BiConsumer, String, List)
final Query	bindList(BiConsumer<SqlStatement, String> onEmpty, String key, Object... values)	see SqlStatement.bindList(BiConsumer, String, List)
final Query	bindList(BiConsumer<SqlStatement, String> onEmpty, String key, Iterator<?> values)	see SqlStatement.bindList(BiConsumer, String, List)
final Query	bindList(BiConsumer<SqlStatement, String> onEmpty, String key, List<?> values)	Bind a parameter for each value in the given list, and defines an attribute as the comma-separated list of parameter references (using colon prefix).
Query	bindMap(Map<String,?> map)	Binds named parameters from a map of String to Object instances
Query	bindMethods(Object object)	Binds methods with no parameters on the argument.
Query	bindMethods(String prefix, Object object)	Binds methods with no parameters on the argument, with the given prefix.
final Query	bindMethodsList(String key, Iterable<?> values, List<String> methodNames)	For each value given, create a tuple by invoking each given method in order, and bind the tuple into a VALUES (...) format insert clause.
Query	bindNamedArgumentFinder(NamedArgumentFinder namedArgumentFinder)	Binds a new NamedArgumentFinder.
final Query	bindNull(int position, int sqlType)	Bind NULL to be set for a given argument.
final Query	bindNull(String name, int sqlType)	Bind NULL to be set for a given argument.
final Query	bindNVarchar(int position, String value)	Bind a String argument positionally, as NVARCHAR type.
final Query	bindNVarchar(String name, String value)	Bind a String argument by name, as NVARCHAR type.
Query	bindPojo(Object pojo)	Binds named parameters from object properties on the argument.
Query	bindPojo(Object pojo, Type type)	Binds named parameters from object properties on the argument.
Query	bindPojo(Object pojo, GenericType<?> type)	Binds named parameters from object properties on the argument.
Query	bindPojo(String prefix, Object pojo)	Binds named parameters from object properties on the bean argument, with the given prefix.
Query	bindPojo(String prefix, Object pojo, Type type)	Binds named parameters from object properties on the bean argument, with the given prefix.
Query	bindPojo(String prefix, Object pojo, GenericType<?> type)	Binds named parameters from object properties on the bean argument, with the given prefix.
Query	cleanupHandleCommit()	Transfer ownership of the handle to the statement: when the statement is closed, commit the handle's transaction (if one exists) and close the handle.
Query	cleanupHandleRollback()	When the statement is closed, roll it back then close the owning Handle.
final Query	defineList(String key, Object... values)	Define an attribute as the comma-separated String from the elements of the values argument.
final Query	defineList(String key, List<?> values)	Define an attribute as the comma-separated String from the elements of the values argument.
Query	defineNamedBindings()	Define all bound arguments that don't already have a definition with a boolean indicating their presence.
Query	setQueryTimeout(int seconds)	Set the query timeout, in seconds, on the prepared statement.
String	toString()

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Configurable

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

Modifier and Type	Method	Description
default Query	addCustomizer(StatementCustomizer customizer)
default <C extends JdbiConfig<C>> Query	configure(Class<C> configClass, Consumer<C> configurer)	Passes the configuration object of the given type to the configurer, then returns this object.
default Query	define(String key, Object value)	Convenience method for getConfig(SqlStatements.class).define(key, value)
default <C extends JdbiConfig<C>> C	getConfig(Class<C> configClass)	Gets the configuration object of the given type, associated with this object.
default Query	registerArgument(ArgumentFactory factory)	Convenience method for getConfig(Arguments.class).register(factory)
default Query	registerArgument(QualifiedArgumentFactory factory)	Convenience method for getConfig(Arguments.class).register(factory)
default Query	registerArrayType(Class<?> elementType, String sqlTypeName)	Convenience method for getConfig(SqlArrayTypes.class).register(elementType, sqlTypeName)
default <T> Query	registerArrayType(Class<T> elementType, String sqlTypeName, Function<T,?> conversion)	Convenience method for registering an array type as SqlArrayTypeFactory.of(Class, String, Function).
default Query	registerArrayType(SqlArrayType<?> arrayType)	Convenience method for getConfig(SqlArrayTypes.class).register(arrayType)
default Query	registerArrayType(SqlArrayTypeFactory factory)	Convenience method for getConfig(SqlArrayTypes.class).register(factory)
default Query	registerCodecFactory(CodecFactory codecFactory)	Convenience method to register a CodecFactory.
default Query	registerCollector(Type collectionType, Collector<?,?,?> collector)	Convenience method for getConfig(JdbiCollectors.class).register(CollectorFactory.collectorFactory(collectionType, collector))
default Query	registerCollector(CollectorFactory factory)	Convenience method for getConfig(JdbiCollectors.class).register(factory)
default Query	registerColumnMapper(Type type, ColumnMapper<?> mapper)	Convenience method for getConfig(ColumnMappers.class).register(type, mapper)
default <T> Query	registerColumnMapper(GenericType<T> type, ColumnMapper<T> mapper)	Convenience method for getConfig(ColumnMappers.class).register(type, mapper)
default Query	registerColumnMapper(ColumnMapper<?> mapper)	Convenience method for getConfig(ColumnMappers.class).register(mapper)
default Query	registerColumnMapper(ColumnMapperFactory factory)	Convenience method for getConfig(ColumnMappers.class).register(factory)
default Query	registerColumnMapper(QualifiedColumnMapperFactory factory)	Convenience method for getConfig(ColumnMappers.class).register(factory)
default <T> Query	registerColumnMapper(QualifiedType<T> type, ColumnMapper<T> mapper)	Convenience method for getConfig(ColumnMappers.class).register(type, mapper)
default Query	registerExtension(ExtensionFactory factory)	Convenience method for getConfig(Extensions.class).register(factory)
default Query	registerRowMapper(Type type, RowMapper<?> mapper)	Convenience method for getConfig(RowMappers.class).register(type, mapper)
default <T> Query	registerRowMapper(GenericType<T> type, RowMapper<T> mapper)	Convenience method for getConfig(RowMappers.class).register(type, mapper)
default Query	registerRowMapper(RowMapper<?> mapper)	Convenience method for getConfig(RowMappers.class).register(mapper)
default Query	registerRowMapper(RowMapperFactory factory)	Convenience method for getConfig(RowMappers.class).register(factory)
default Query	setMapKeyColumn(String keyColumn)	Convenience method for getConfig(MapEntryMappers.class).setKeyColumn(keyColumn)
default Query	setMapValueColumn(String valueColumn)	Convenience method for getConfig(MapEntryMappers.class).setValueColumn(valueColumn)
default Query	setSqlArrayArgumentStrategy(SqlArrayArgumentStrategy strategy)	Convenience method for getConfig(SqlArrayTypes.class).setArgumentStrategy(strategy)
default Query	setSqlLogger(SqlLogger sqlLogger)
default Query	setSqlParser(SqlParser parser)	Convenience method for getConfig(SqlStatements.class).setSqlParser(rewriter)
default Query	setTemplateEngine(TemplateEngine templateEngine)	Convenience method for getConfig(SqlStatements.class).setTemplateEngine(rewriter)
default Query	setTimingCollector(TimingCollector collector)	Deprecated, for removal: This API element is subject to removal in a future version. use Configurable.setSqlLogger(SqlLogger) instead

Methods inherited from interface ResultBearing

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

Modifier and Type	Method	Description
default <R> R	collectInto(Class<R> containerType)	Collect the results into a container of the given type.
default Object	collectInto(Type containerType)	Collect the results into a container of the given type.
default <R> R	collectInto(GenericType<R> containerType)	Collect the results into a container of the given generic type.
default <A,R> R	collectRows(Collector<RowView,A,R> collector)	Collect the results using the given collector.
default <T> ResultIterable<T>	map(ColumnMapper<T> mapper)	Maps this result set to a ResultIterable, using the given column mapper.
default <T> ResultIterable<T>	map(RowMapper<T> mapper)	Maps this result set to a ResultIterable, using the given row mapper.
default <T> ResultIterable<T>	map(RowViewMapper<T> mapper)	Maps this result set to a ResultIterable, using the given RowViewMapper.
default <T> ResultIterable<T>	mapTo(Class<T> type)	Maps this result set to a ResultIterable of the given element type.
default ResultIterable<?>	mapTo(Type type)	Maps this result set to a ResultIterable of the given element type.
default <T> ResultIterable<T>	mapTo(GenericType<T> type)	Maps this result set to a ResultIterable of the given element type.
default <T> ResultIterable<T>	mapTo(QualifiedType<T> type)	Maps this result set to a ResultIterable of the given qualified element type.
default <T> ResultIterable<T>	mapToBean(Class<T> type)	Maps this result set to a ResultIterable of the given element type, using BeanMapper.
default ResultIterable<Map<String,Object>>	mapToMap()	Maps this result set to a ResultIterable of Map<String,Object>.
default <T> ResultIterable<Map<String,T>>	mapToMap(Class<T> valueType)	Maps this result set to a Map of String and the given value class.
default <T> ResultIterable<Map<String,T>>	mapToMap(GenericType<T> valueType)	Maps this result set to a Map of String and the given value type.
default <U> U	reduceResultSet(U seed, ResultSetAccumulator<U> accumulator)	Reduce the results.
default <K,V> Stream<V>	reduceRows(BiConsumer<Map<K,V>,RowView> accumulator)	Reduce the result rows using a Map<K, V> as the result container.
default <C,R> Stream<R>	reduceRows(RowReducer<C,R> rowReducer)	Reduce the result rows using the given row reducer.
default <U> U	reduceRows(U seed, BiFunction<U,RowView,U> accumulator)	Reduce the results.

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

@Beta
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