Class Call

java.lang.Object

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

org.jdbi.v3.core.statement.Call

All Implemented Interfaces:

Closeable, AutoCloseable, Configurable<Call>

public class Call
extends SqlStatement<Call>

Used for invoking stored procedures. The most common way to use this is to register OutParameters with the call and then use the invoke() method to retrieve the return values from the invoked procedure.
There are some databases, most prominently MS SqlServer that only support limited OUT parameters, especially do not support cursors (for MS SqlServer see Using a stored procedure with output parameters). Those databases may support returning a result set from the procedure invocation, to access this result set use the OutParameters.getResultSet() method to retrieve the result set from the underlying call operation.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final Call	attachToHandleForCleanup()	Registers with the handle for cleaning when the handle is closed.
void	close()
Call	concurrentUpdatable()	Specify that the result set should be concurrent updatable.
ConfigRegistry	getConfig()	Returns the configuration registry associated with this object.
final StatementContext	getContext()	Returns the statement context associated with this statement.
final Handle	getHandle()
OutParameters	invoke()	Invoke the callable statement.
void	invoke(Consumer<OutParameters> resultConsumer)	Invoke the callable statement and process its OutParameters results.
<T> T	invoke(Function<OutParameters, T> resultComputer)	Invoke the callable statement and process its OutParameters results, returning a computed value of type T.
Call	registerOutParameter(int position, int sqlType)	Register a positional output parameter.
Call	registerOutParameter(int position, int sqlType, CallableStatementMapper mapper)	Register a positional output parameter.
Call	registerOutParameter(String name, int sqlType)	Register a named output parameter.
Call	registerOutParameter(String name, int sqlType, CallableStatementMapper mapper)	Register a named output parameter.
Call	setFetchSize(int fetchSize)	Specify the fetch size for the call.
Call	setMaxFieldSize(int maxFields)	Specify the maximum field size in the result set.
Call	setMaxRows(int maxRows)	Specify the maximum number of rows the call 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 Call	bind(int position, boolean value)	Bind an argument positionally
final Call	bind(int position, byte value)	Bind an argument positionally
final Call	bind(int position, byte[] value)	Bind an argument positionally
final Call	bind(int position, char value)	Bind an argument positionally
final Call	bind(int position, double value)	Bind an argument positionally
final Call	bind(int position, float value)	Bind an argument positionally
final Call	bind(int position, int value)	Bind an argument positionally
final Call	bind(int position, long value)	Bind an argument positionally
final Call	bind(int position, short value)	Bind an argument positionally
final Call	bind(int position, Reader value, int length)	Bind an argument positionally
final Call	bind(int position, Boolean value)	Bind an argument positionally
final Call	bind(int position, Byte value)	Bind an argument positionally
final Call	bind(int position, Character value)	Bind an argument positionally
final Call	bind(int position, Double value)	Bind an argument positionally
final Call	bind(int position, Float value)	Bind an argument positionally
final Call	bind(int position, Integer value)	Bind an argument positionally
final Call	bind(int position, Long value)	Bind an argument positionally
final Call	bind(int position, Object value)	Bind an argument positionally
final Call	bind(int position, Short value)	Bind an argument positionally
final Call	bind(int position, String value)	Bind an argument positionally
final Call	bind(int position, BigDecimal value)	Bind an argument positionally
final Call	bind(int position, URI value)	Bind an argument positionally
final Call	bind(int position, URL value)	Bind an argument positionally
final Call	bind(int position, Blob value)	Bind an argument positionally
final Call	bind(int position, Clob value)	Bind an argument positionally
final Call	bind(int position, Date value)	Bind an argument positionally
final Call	bind(int position, Time value)	Bind an argument positionally
final Call	bind(int position, Timestamp value)	Bind an argument positionally
final Call	bind(int position, Date value)	Bind an argument positionally
final Call	bind(int position, UUID value)	Bind an argument positionally
Call	bind(int position, Argument argument)	Used if you need to have some exotic parameter bound.
final Call	bind(String name, boolean value)	Bind an argument by name
final Call	bind(String name, byte value)	Bind an argument by name
final Call	bind(String name, byte[] value)	Bind an argument by name
final Call	bind(String name, char value)	Bind an argument by name
final Call	bind(String name, double value)	Bind an argument by name
final Call	bind(String name, float value)	Bind an argument by name
final Call	bind(String name, int value)	Bind an argument by name
final Call	bind(String name, long value)	Bind an argument by name
final Call	bind(String name, short value)	Bind an argument by name
final Call	bind(String name, Reader value, int length)	Bind an argument by name
final Call	bind(String name, Boolean value)	Bind an argument by name
final Call	bind(String name, Byte value)	Bind an argument by name
final Call	bind(String name, Character value)	Bind an argument by name
final Call	bind(String name, Double value)	Bind an argument by name
final Call	bind(String name, Float value)	Bind an argument by name
final Call	bind(String name, Integer value)	Bind an argument by name
final Call	bind(String name, Long value)	Bind an argument by name
final Call	bind(String name, Object value)	Bind an argument by name
final Call	bind(String name, Short value)	Bind an argument by name
final Call	bind(String name, String value)	Bind an argument by name
final Call	bind(String name, BigDecimal value)	Bind an argument by name
final Call	bind(String name, URI value)	Bind an argument by name
final Call	bind(String name, URL value)	Bind an argument by name
final Call	bind(String name, Blob value)	Bind an argument by name
final Call	bind(String name, Clob value)	Bind an argument by name
final Call	bind(String name, Date value)	Bind an argument by name
final Call	bind(String name, Time value)	Bind an argument by name
final Call	bind(String name, Timestamp value)	Bind an argument by name
final Call	bind(String name, Date value)	Bind an argument by name
final Call	bind(String name, UUID value)	Bind an argument by name
Call	bind(String name, Argument argument)	Used if you need to have some exotic parameter bound.
final Call	bindArray(int pos, Type elementType, Iterable<?> iterable)	Bind an Iterable as a SQL array.
final Call	bindArray(int pos, Type elementType, Object... array)	Bind a Java array as a SQL array, casting each element to a new type.
final Call	bindArray(int pos, Type elementType, Iterator<?> iterator)	Bind an Iterator as a SQL array.
final <T> Call	bindArray(int pos, T... array)	Bind a Java array as a SQL array.
final Call	bindArray(String name, Type elementType, Iterable<?> iterable)	Bind an Iterable as a SQL array.
final Call	bindArray(String name, Type elementType, Object... array)	Bind a Java array as a SQL array, casting each element to a new type.
final Call	bindArray(String name, Type elementType, Iterator<?> iterator)	Bind an Iterator as a SQL array.
final <T> Call	bindArray(String name, T... array)	Bind a Java array as a SQL array.
final Call	bindASCIIStream(int position, InputStream value, int length)	Bind an argument positionally
final Call	bindASCIIStream(String name, InputStream value, int length)	Bind an argument by name
Call	bindBean(Object bean)	Binds named parameters from JavaBean properties on the argument.
Call	bindBean(String prefix, Object bean)	Binds named parameters from JavaBean properties on the bean argument, with the given prefix.
final Call	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 Call	bindBinaryStream(int position, InputStream value, int length)	Bind an argument positionally
final Call	bindBinaryStream(String name, InputStream value, int length)	Bind an argument by name
final Call	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 Call	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 Call	bindByType(int position, Object value, Type argumentType)	Bind an argument dynamically by the type passed in.
final Call	bindByType(int position, Object value, GenericType<?> argumentType)	Bind an argument dynamically by the generic type passed in.
final Call	bindByType(int position, Object value, QualifiedType<?> argumentType)	Bind an argument dynamically by the qualified type passed in.
final Call	bindByType(String name, Object value, Type argumentType)	Bind an argument dynamically by the type passed in.
final Call	bindByType(String name, Object value, GenericType<?> argumentType)	Bind an argument dynamically by the generic type passed in.
final Call	bindByType(String name, Object value, QualifiedType<?> argumentType)	Bind an argument dynamically by the type passed in.
Call	bindFields(Object object)	Binds public fields of the specified object as arguments for the query.
Call	bindFields(String prefix, Object object)	Binds public fields of the specified object as arguments for the query.
final Call	bindList(String key, Iterable<?> values)	see SqlStatement.bindList(BiConsumer, String, List)
final Call	bindList(String key, Object... values)	see SqlStatement.bindList(BiConsumer, String, List)
final Call	bindList(String key, Iterator<?> values)	see SqlStatement.bindList(BiConsumer, String, List)
final Call	bindList(BiConsumer<SqlStatement, String> onEmpty, String key, Iterable<?> values)	see SqlStatement.bindList(BiConsumer, String, List)
final Call	bindList(BiConsumer<SqlStatement, String> onEmpty, String key, Object... values)	see SqlStatement.bindList(BiConsumer, String, List)
final Call	bindList(BiConsumer<SqlStatement, String> onEmpty, String key, Iterator<?> values)	see SqlStatement.bindList(BiConsumer, String, List)
final Call	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).
Call	bindMap(Map<String,?> map)	Binds named parameters from a map of String to Object instances
Call	bindMethods(Object object)	Binds methods with no parameters on the argument.
Call	bindMethods(String prefix, Object object)	Binds methods with no parameters on the argument, with the given prefix.
final Call	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.
Call	bindNamedArgumentFinder(NamedArgumentFinder namedArgumentFinder)	Binds a new NamedArgumentFinder.
final Call	bindNull(int position, int sqlType)	Bind NULL to be set for a given argument.
final Call	bindNull(String name, int sqlType)	Bind NULL to be set for a given argument.
final Call	bindNVarchar(int position, String value)	Bind a String argument positionally, as NVARCHAR type.
final Call	bindNVarchar(String name, String value)	Bind a String argument by name, as NVARCHAR type.
Call	bindPojo(Object pojo)	Binds named parameters from object properties on the argument.
Call	bindPojo(Object pojo, Type type)	Binds named parameters from object properties on the argument.
Call	bindPojo(Object pojo, GenericType<?> type)	Binds named parameters from object properties on the argument.
Call	bindPojo(String prefix, Object pojo)	Binds named parameters from object properties on the bean argument, with the given prefix.
Call	bindPojo(String prefix, Object pojo, Type type)	Binds named parameters from object properties on the bean argument, with the given prefix.
Call	bindPojo(String prefix, Object pojo, GenericType<?> type)	Binds named parameters from object properties on the bean argument, with the given prefix.
Call	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.
Call	cleanupHandleRollback()	When the statement is closed, roll it back then close the owning Handle.
final Call	defineList(String key, Object... values)	Define an attribute as the comma-separated String from the elements of the values argument.
final Call	defineList(String key, List<?> values)	Define an attribute as the comma-separated String from the elements of the values argument.
Call	defineNamedBindings()	Define all bound arguments that don't already have a definition with a boolean indicating their presence.
Call	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 Call	addCustomizer(StatementCustomizer customizer)
default <C extends JdbiConfig<C>> Call	configure(Class<C> configClass, Consumer<C> configurer)	Passes the configuration object of the given type to the configurer, then returns this object.
default Call	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 Call	registerArgument(ArgumentFactory factory)	Convenience method for getConfig(Arguments.class).register(factory)
default Call	registerArgument(QualifiedArgumentFactory factory)	Convenience method for getConfig(Arguments.class).register(factory)
default Call	registerArrayType(Class<?> elementType, String sqlTypeName)	Convenience method for getConfig(SqlArrayTypes.class).register(elementType, sqlTypeName)
default <T> Call	registerArrayType(Class<T> elementType, String sqlTypeName, Function<T,?> conversion)	Convenience method for registering an array type as SqlArrayTypeFactory.of(Class, String, Function).
default Call	registerArrayType(SqlArrayType<?> arrayType)	Convenience method for getConfig(SqlArrayTypes.class).register(arrayType)
default Call	registerArrayType(SqlArrayTypeFactory factory)	Convenience method for getConfig(SqlArrayTypes.class).register(factory)
default Call	registerCodecFactory(CodecFactory codecFactory)	Convenience method to register a CodecFactory.
default Call	registerCollector(Type collectionType, Collector<?,?,?> collector)	Convenience method for getConfig(JdbiCollectors.class).register(CollectorFactory.collectorFactory(collectionType, collector))
default Call	registerCollector(CollectorFactory factory)	Convenience method for getConfig(JdbiCollectors.class).register(factory)
default Call	registerColumnMapper(Type type, ColumnMapper<?> mapper)	Convenience method for getConfig(ColumnMappers.class).register(type, mapper)
default <T> Call	registerColumnMapper(GenericType<T> type, ColumnMapper<T> mapper)	Convenience method for getConfig(ColumnMappers.class).register(type, mapper)
default Call	registerColumnMapper(ColumnMapper<?> mapper)	Convenience method for getConfig(ColumnMappers.class).register(mapper)
default Call	registerColumnMapper(ColumnMapperFactory factory)	Convenience method for getConfig(ColumnMappers.class).register(factory)
default Call	registerColumnMapper(QualifiedColumnMapperFactory factory)	Convenience method for getConfig(ColumnMappers.class).register(factory)
default <T> Call	registerColumnMapper(QualifiedType<T> type, ColumnMapper<T> mapper)	Convenience method for getConfig(ColumnMappers.class).register(type, mapper)
default Call	registerExtension(ExtensionFactory factory)	Convenience method for getConfig(Extensions.class).register(factory)
default Call	registerRowMapper(Type type, RowMapper<?> mapper)	Convenience method for getConfig(RowMappers.class).register(type, mapper)
default <T> Call	registerRowMapper(GenericType<T> type, RowMapper<T> mapper)	Convenience method for getConfig(RowMappers.class).register(type, mapper)
default Call	registerRowMapper(RowMapper<?> mapper)	Convenience method for getConfig(RowMappers.class).register(mapper)
default Call	registerRowMapper(RowMapperFactory factory)	Convenience method for getConfig(RowMappers.class).register(factory)
default Call	setMapKeyColumn(String keyColumn)	Convenience method for getConfig(MapEntryMappers.class).setKeyColumn(keyColumn)
default Call	setMapValueColumn(String valueColumn)	Convenience method for getConfig(MapEntryMappers.class).setValueColumn(valueColumn)
default Call	setSqlArrayArgumentStrategy(SqlArrayArgumentStrategy strategy)	Convenience method for getConfig(SqlArrayTypes.class).setArgumentStrategy(strategy)
default Call	setSqlLogger(SqlLogger sqlLogger)
default Call	setSqlParser(SqlParser parser)	Convenience method for getConfig(SqlStatements.class).setSqlParser(rewriter)
default Call	setTemplateEngine(TemplateEngine templateEngine)	Convenience method for getConfig(SqlStatements.class).setTemplateEngine(rewriter)
default Call	setTimingCollector(TimingCollector collector)	Deprecated, for removal: This API element is subject to removal in a future version. use Configurable.setSqlLogger(SqlLogger) instead

Constructor Details

Call

public Call(Handle handle,
 CharSequence sql)

Call

public Call(Handle handle,
 String sql)

Backwards compatible constructor that takes an explicit string argument.

See Also:

• Call(Handle, CharSequence)

Method Details

registerOutParameter

public Call registerOutParameter(int position,
 int sqlType)

Register a positional output parameter.

Parameters:

position - the parameter position (zero-based)

sqlType - an SQL type constant as defined by Types or by the JDBC vendor.

Returns:

self

registerOutParameter

public Call registerOutParameter(int position,
 int sqlType,
 CallableStatementMapper mapper)

Register a positional output parameter. For INOUT parameters, call SqlStatement.bind(int, Object) before this method; the existing binding will be captured and sent as the input value.

Parameters:

position - the parameter position (zero-based)

sqlType - an SQL type constant as defined by Types or by the JDBC vendor.

mapper - a mapper which converts the CallableStatement to a desired output type.

Returns:

self

registerOutParameter

public Call registerOutParameter(String name,
 int sqlType)

Register a named output parameter.

Parameters:

name - the parameter name

sqlType - an SQL type constant as defined by Types or by the JDBC vendor.

Returns:

self

registerOutParameter

public Call registerOutParameter(String name,
 int sqlType,
 CallableStatementMapper mapper)

Register a named output parameter. For INOUT parameters, call SqlStatement.bind(String, Object) before this method; the existing binding will be captured and sent as the input value.

Parameters:

name - the parameter name

sqlType - an SQL type constant as defined by Types or by the JDBC vendor.

mapper - a mapper which converts the CallableStatement to a desired output type.

Returns:

self

invoke

public OutParameters invoke()

Invoke the callable statement. Note that the statement will be cleaned up, so cursor-typed values may not work.

Returns:

the output parameters resulting from the invocation.

invoke

public void invoke(Consumer<OutParameters> resultConsumer)

Invoke the callable statement and process its OutParameters results.

invoke

public <T> T invoke(Function<OutParameters, T> resultComputer)

Invoke the callable statement and process its OutParameters results, returning a computed value of type T.

setFetchSize

public Call setFetchSize(int fetchSize)

Specify the fetch size for the call. 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 call

Since:

3.43.0

setMaxRows

public Call setMaxRows(int maxRows)

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

Parameters:

maxRows - maximum number of rows to return

Returns:

modified call

Since:

3.43.0

setMaxFieldSize

public Call 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 call

Since:

3.43.0

concurrentUpdatable

public Call 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 Call.

Returns:

the modified call

Since:

3.43.0

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 Call 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