Class PreparedBatch

java.lang.Object

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

org.jdbi.v3.core.statement.PreparedBatch

All Implemented Interfaces:

Closeable, AutoCloseable, Configurable<PreparedBatch>, ResultBearing

public class PreparedBatch
extends SqlStatement<PreparedBatch>
implements ResultBearing

Represents a prepared batch statement. Multiple bindings are added to the compiled statement and then executed in a single operation. This is, generally, a very efficient way to execute large numbers of the same statement where the statement only varies by the arguments bound to it. The statement starts with an empty binding. You bind a single batch of parameters with the usual SqlStatement binding methods, and then call add() to add the current binding as a batch and then clear it. An entire batch can be bound and added in one go with add(Map) or add(Object...).

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
PreparedBatch	add()	Add the current binding as a saved batch and clear the binding.
PreparedBatch	add(Object... args)	Bind arguments positionally, add the binding as a saved batch, and then clear the current binding.
PreparedBatch	add(Map<String,?> args)	Bind arguments from a Map, add the binding as a saved batch, then clear the current binding.
final PreparedBatch	attachToHandleForCleanup()	Registers with the handle for cleaning when the handle is closed.
void	close()
int[]	execute()	Execute the batch and return the number of rows affected for each batch part.
<R> R	execute(ResultProducer<R> producer)	Executes the batch, returning the result obtained from the given ResultProducer.
ResultIterator<Integer>	executeAndGetModCount()	Execute the batch and return the mod counts as in execute, but as a Jdbi result iterator instead of an array.
ResultBearing	executeAndReturnGeneratedKeys(String... columnNames)	Deprecated, for removal: This API element is subject to removal in a future version. Use executePreparedBatch(String...) which has the same functionality but also returns the per-batch modified row counts.
BatchResultBearing	executePreparedBatch(String... columnNames)	Execute the batch and give access to any generated keys returned by the operation.
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.
int	size()	Returns the number of bindings in this batch.

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 PreparedBatch	bind(int position, boolean value)	Bind an argument positionally
final PreparedBatch	bind(int position, byte value)	Bind an argument positionally
final PreparedBatch	bind(int position, byte[] value)	Bind an argument positionally
final PreparedBatch	bind(int position, char value)	Bind an argument positionally
final PreparedBatch	bind(int position, double value)	Bind an argument positionally
final PreparedBatch	bind(int position, float value)	Bind an argument positionally
final PreparedBatch	bind(int position, int value)	Bind an argument positionally
final PreparedBatch	bind(int position, long value)	Bind an argument positionally
final PreparedBatch	bind(int position, short value)	Bind an argument positionally
final PreparedBatch	bind(int position, Reader value, int length)	Bind an argument positionally
final PreparedBatch	bind(int position, Boolean value)	Bind an argument positionally
final PreparedBatch	bind(int position, Byte value)	Bind an argument positionally
final PreparedBatch	bind(int position, Character value)	Bind an argument positionally
final PreparedBatch	bind(int position, Double value)	Bind an argument positionally
final PreparedBatch	bind(int position, Float value)	Bind an argument positionally
final PreparedBatch	bind(int position, Integer value)	Bind an argument positionally
final PreparedBatch	bind(int position, Long value)	Bind an argument positionally
final PreparedBatch	bind(int position, Object value)	Bind an argument positionally
final PreparedBatch	bind(int position, Short value)	Bind an argument positionally
final PreparedBatch	bind(int position, String value)	Bind an argument positionally
final PreparedBatch	bind(int position, BigDecimal value)	Bind an argument positionally
final PreparedBatch	bind(int position, URI value)	Bind an argument positionally
final PreparedBatch	bind(int position, URL value)	Bind an argument positionally
final PreparedBatch	bind(int position, Blob value)	Bind an argument positionally
final PreparedBatch	bind(int position, Clob value)	Bind an argument positionally
final PreparedBatch	bind(int position, Date value)	Bind an argument positionally
final PreparedBatch	bind(int position, Time value)	Bind an argument positionally
final PreparedBatch	bind(int position, Timestamp value)	Bind an argument positionally
final PreparedBatch	bind(int position, Date value)	Bind an argument positionally
final PreparedBatch	bind(int position, UUID value)	Bind an argument positionally
PreparedBatch	bind(int position, Argument argument)	Used if you need to have some exotic parameter bound.
final PreparedBatch	bind(String name, boolean value)	Bind an argument by name
final PreparedBatch	bind(String name, byte value)	Bind an argument by name
final PreparedBatch	bind(String name, byte[] value)	Bind an argument by name
final PreparedBatch	bind(String name, char value)	Bind an argument by name
final PreparedBatch	bind(String name, double value)	Bind an argument by name
final PreparedBatch	bind(String name, float value)	Bind an argument by name
final PreparedBatch	bind(String name, int value)	Bind an argument by name
final PreparedBatch	bind(String name, long value)	Bind an argument by name
final PreparedBatch	bind(String name, short value)	Bind an argument by name
final PreparedBatch	bind(String name, Reader value, int length)	Bind an argument by name
final PreparedBatch	bind(String name, Boolean value)	Bind an argument by name
final PreparedBatch	bind(String name, Byte value)	Bind an argument by name
final PreparedBatch	bind(String name, Character value)	Bind an argument by name
final PreparedBatch	bind(String name, Double value)	Bind an argument by name
final PreparedBatch	bind(String name, Float value)	Bind an argument by name
final PreparedBatch	bind(String name, Integer value)	Bind an argument by name
final PreparedBatch	bind(String name, Long value)	Bind an argument by name
final PreparedBatch	bind(String name, Object value)	Bind an argument by name
final PreparedBatch	bind(String name, Short value)	Bind an argument by name
final PreparedBatch	bind(String name, String value)	Bind an argument by name
final PreparedBatch	bind(String name, BigDecimal value)	Bind an argument by name
final PreparedBatch	bind(String name, URI value)	Bind an argument by name
final PreparedBatch	bind(String name, URL value)	Bind an argument by name
final PreparedBatch	bind(String name, Blob value)	Bind an argument by name
final PreparedBatch	bind(String name, Clob value)	Bind an argument by name
final PreparedBatch	bind(String name, Date value)	Bind an argument by name
final PreparedBatch	bind(String name, Time value)	Bind an argument by name
final PreparedBatch	bind(String name, Timestamp value)	Bind an argument by name
final PreparedBatch	bind(String name, Date value)	Bind an argument by name
final PreparedBatch	bind(String name, UUID value)	Bind an argument by name
PreparedBatch	bind(String name, Argument argument)	Used if you need to have some exotic parameter bound.
final PreparedBatch	bindArray(int pos, Type elementType, Iterable<?> iterable)	Bind an Iterable as a SQL array.
final PreparedBatch	bindArray(int pos, Type elementType, Object... array)	Bind a Java array as a SQL array, casting each element to a new type.
final PreparedBatch	bindArray(int pos, Type elementType, Iterator<?> iterator)	Bind an Iterator as a SQL array.
final <T> PreparedBatch	bindArray(int pos, T... array)	Bind a Java array as a SQL array.
final PreparedBatch	bindArray(String name, Type elementType, Iterable<?> iterable)	Bind an Iterable as a SQL array.
final PreparedBatch	bindArray(String name, Type elementType, Object... array)	Bind a Java array as a SQL array, casting each element to a new type.
final PreparedBatch	bindArray(String name, Type elementType, Iterator<?> iterator)	Bind an Iterator as a SQL array.
final <T> PreparedBatch	bindArray(String name, T... array)	Bind a Java array as a SQL array.
final PreparedBatch	bindASCIIStream(int position, InputStream value, int length)	Bind an argument positionally
final PreparedBatch	bindASCIIStream(String name, InputStream value, int length)	Bind an argument by name
PreparedBatch	bindBean(Object bean)	Binds named parameters from JavaBean properties on the argument.
PreparedBatch	bindBean(String prefix, Object bean)	Binds named parameters from JavaBean properties on the bean argument, with the given prefix.
final PreparedBatch	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 PreparedBatch	bindBinaryStream(int position, InputStream value, int length)	Bind an argument positionally
final PreparedBatch	bindBinaryStream(String name, InputStream value, int length)	Bind an argument by name
final PreparedBatch	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 PreparedBatch	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 PreparedBatch	bindByType(int position, Object value, Type argumentType)	Bind an argument dynamically by the type passed in.
final PreparedBatch	bindByType(int position, Object value, GenericType<?> argumentType)	Bind an argument dynamically by the generic type passed in.
final PreparedBatch	bindByType(int position, Object value, QualifiedType<?> argumentType)	Bind an argument dynamically by the qualified type passed in.
final PreparedBatch	bindByType(String name, Object value, Type argumentType)	Bind an argument dynamically by the type passed in.
final PreparedBatch	bindByType(String name, Object value, GenericType<?> argumentType)	Bind an argument dynamically by the generic type passed in.
final PreparedBatch	bindByType(String name, Object value, QualifiedType<?> argumentType)	Bind an argument dynamically by the type passed in.
PreparedBatch	bindFields(Object object)	Binds public fields of the specified object as arguments for the query.
PreparedBatch	bindFields(String prefix, Object object)	Binds public fields of the specified object as arguments for the query.
final PreparedBatch	bindList(String key, Iterable<?> values)	see SqlStatement.bindList(BiConsumer, String, List)
final PreparedBatch	bindList(String key, Object... values)	see SqlStatement.bindList(BiConsumer, String, List)
final PreparedBatch	bindList(String key, Iterator<?> values)	see SqlStatement.bindList(BiConsumer, String, List)
final PreparedBatch	bindList(BiConsumer<SqlStatement, String> onEmpty, String key, Iterable<?> values)	see SqlStatement.bindList(BiConsumer, String, List)
final PreparedBatch	bindList(BiConsumer<SqlStatement, String> onEmpty, String key, Object... values)	see SqlStatement.bindList(BiConsumer, String, List)
final PreparedBatch	bindList(BiConsumer<SqlStatement, String> onEmpty, String key, Iterator<?> values)	see SqlStatement.bindList(BiConsumer, String, List)
final PreparedBatch	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).
PreparedBatch	bindMap(Map<String,?> map)	Binds named parameters from a map of String to Object instances
PreparedBatch	bindMethods(Object object)	Binds methods with no parameters on the argument.
PreparedBatch	bindMethods(String prefix, Object object)	Binds methods with no parameters on the argument, with the given prefix.
final PreparedBatch	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.
PreparedBatch	bindNamedArgumentFinder(NamedArgumentFinder namedArgumentFinder)	Binds a new NamedArgumentFinder.
final PreparedBatch	bindNull(int position, int sqlType)	Bind NULL to be set for a given argument.
final PreparedBatch	bindNull(String name, int sqlType)	Bind NULL to be set for a given argument.
final PreparedBatch	bindNVarchar(int position, String value)	Bind a String argument positionally, as NVARCHAR type.
final PreparedBatch	bindNVarchar(String name, String value)	Bind a String argument by name, as NVARCHAR type.
PreparedBatch	bindPojo(Object pojo)	Binds named parameters from object properties on the argument.
PreparedBatch	bindPojo(Object pojo, Type type)	Binds named parameters from object properties on the argument.
PreparedBatch	bindPojo(Object pojo, GenericType<?> type)	Binds named parameters from object properties on the argument.
PreparedBatch	bindPojo(String prefix, Object pojo)	Binds named parameters from object properties on the bean argument, with the given prefix.
PreparedBatch	bindPojo(String prefix, Object pojo, Type type)	Binds named parameters from object properties on the bean argument, with the given prefix.
PreparedBatch	bindPojo(String prefix, Object pojo, GenericType<?> type)	Binds named parameters from object properties on the bean argument, with the given prefix.
PreparedBatch	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.
PreparedBatch	cleanupHandleRollback()	When the statement is closed, roll it back then close the owning Handle.
final PreparedBatch	defineList(String key, Object... values)	Define an attribute as the comma-separated String from the elements of the values argument.
final PreparedBatch	defineList(String key, List<?> values)	Define an attribute as the comma-separated String from the elements of the values argument.
PreparedBatch	defineNamedBindings()	Define all bound arguments that don't already have a definition with a boolean indicating their presence.
PreparedBatch	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 PreparedBatch	addCustomizer(StatementCustomizer customizer)
default <C extends JdbiConfig<C>> PreparedBatch	configure(Class<C> configClass, Consumer<C> configurer)	Passes the configuration object of the given type to the configurer, then returns this object.
default PreparedBatch	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 PreparedBatch	registerArgument(ArgumentFactory factory)	Convenience method for getConfig(Arguments.class).register(factory)
default PreparedBatch	registerArgument(QualifiedArgumentFactory factory)	Convenience method for getConfig(Arguments.class).register(factory)
default PreparedBatch	registerArrayType(Class<?> elementType, String sqlTypeName)	Convenience method for getConfig(SqlArrayTypes.class).register(elementType, sqlTypeName)
default <T> PreparedBatch	registerArrayType(Class<T> elementType, String sqlTypeName, Function<T,?> conversion)	Convenience method for registering an array type as SqlArrayTypeFactory.of(Class, String, Function).
default PreparedBatch	registerArrayType(SqlArrayType<?> arrayType)	Convenience method for getConfig(SqlArrayTypes.class).register(arrayType)
default PreparedBatch	registerArrayType(SqlArrayTypeFactory factory)	Convenience method for getConfig(SqlArrayTypes.class).register(factory)
default PreparedBatch	registerCodecFactory(CodecFactory codecFactory)	Convenience method to register a CodecFactory.
default PreparedBatch	registerCollector(Type collectionType, Collector<?,?,?> collector)	Convenience method for getConfig(JdbiCollectors.class).register(CollectorFactory.collectorFactory(collectionType, collector))
default PreparedBatch	registerCollector(CollectorFactory factory)	Convenience method for getConfig(JdbiCollectors.class).register(factory)
default PreparedBatch	registerColumnMapper(Type type, ColumnMapper<?> mapper)	Convenience method for getConfig(ColumnMappers.class).register(type, mapper)
default <T> PreparedBatch	registerColumnMapper(GenericType<T> type, ColumnMapper<T> mapper)	Convenience method for getConfig(ColumnMappers.class).register(type, mapper)
default PreparedBatch	registerColumnMapper(ColumnMapper<?> mapper)	Convenience method for getConfig(ColumnMappers.class).register(mapper)
default PreparedBatch	registerColumnMapper(ColumnMapperFactory factory)	Convenience method for getConfig(ColumnMappers.class).register(factory)
default PreparedBatch	registerColumnMapper(QualifiedColumnMapperFactory factory)	Convenience method for getConfig(ColumnMappers.class).register(factory)
default <T> PreparedBatch	registerColumnMapper(QualifiedType<T> type, ColumnMapper<T> mapper)	Convenience method for getConfig(ColumnMappers.class).register(type, mapper)
default PreparedBatch	registerExtension(ExtensionFactory factory)	Convenience method for getConfig(Extensions.class).register(factory)
default PreparedBatch	registerRowMapper(Type type, RowMapper<?> mapper)	Convenience method for getConfig(RowMappers.class).register(type, mapper)
default <T> PreparedBatch	registerRowMapper(GenericType<T> type, RowMapper<T> mapper)	Convenience method for getConfig(RowMappers.class).register(type, mapper)
default PreparedBatch	registerRowMapper(RowMapper<?> mapper)	Convenience method for getConfig(RowMappers.class).register(mapper)
default PreparedBatch	registerRowMapper(RowMapperFactory factory)	Convenience method for getConfig(RowMappers.class).register(factory)
default PreparedBatch	setMapKeyColumn(String keyColumn)	Convenience method for getConfig(MapEntryMappers.class).setKeyColumn(keyColumn)
default PreparedBatch	setMapValueColumn(String valueColumn)	Convenience method for getConfig(MapEntryMappers.class).setValueColumn(valueColumn)
default PreparedBatch	setSqlArrayArgumentStrategy(SqlArrayArgumentStrategy strategy)	Convenience method for getConfig(SqlArrayTypes.class).setArgumentStrategy(strategy)
default PreparedBatch	setSqlLogger(SqlLogger sqlLogger)
default PreparedBatch	setSqlParser(SqlParser parser)	Convenience method for getConfig(SqlStatements.class).setSqlParser(rewriter)
default PreparedBatch	setTemplateEngine(TemplateEngine templateEngine)	Convenience method for getConfig(SqlStatements.class).setTemplateEngine(rewriter)
default PreparedBatch	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

PreparedBatch

public PreparedBatch(Handle handle,
 CharSequence sql)

PreparedBatch

public PreparedBatch(Handle handle,
 String sql)

Backwards compatible constructor that takes an explicit string argument.

See Also:

• PreparedBatch(Handle, CharSequence)

Method Details

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.

execute

public int[] execute()

Execute the batch and return the number of rows affected for each batch part. Note that some database drivers might return special values like Statement.SUCCESS_NO_INFO or Statement.EXECUTE_FAILED.

Returns:

the number of rows affected per batch part

See Also:

• Statement.executeBatch()

executeAndGetModCount

public ResultIterator<Integer> executeAndGetModCount()

Execute the batch and return the mod counts as in execute, but as a Jdbi result iterator instead of an array.

Returns:

the number of rows affected per batch part

See Also:

• execute()
• Statement.executeBatch()

executeAndReturnGeneratedKeys

@Deprecated(since="3.32.0",
            forRemoval=true)
public ResultBearing executeAndReturnGeneratedKeys(String... columnNames)

Deprecated, for removal: This API element is subject to removal in a future version.

Use executePreparedBatch(String...) which has the same functionality but also returns the per-batch modified row counts.

Execute the batch and give access to any generated keys returned by the operation.

Parameters:

columnNames - The column names for generated keys.

Returns:

A ResultBearing object that can be used to access the results of the batch.

executePreparedBatch

public BatchResultBearing executePreparedBatch(String... columnNames)

Execute the batch and give access to any generated keys returned by the operation.

Parameters:

columnNames - The column names for generated keys.

Returns:

A BatchResultBearing object that can be used to access the results of the batch and the per-batch modified row counts.

execute

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

Executes the batch, 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.

add

public PreparedBatch add()

Add the current binding as a saved batch and clear the binding.

Returns:

this

add

public PreparedBatch add(Object... args)

Bind arguments positionally, add the binding as a saved batch, and then clear the current binding.

Parameters:

args - the positional arguments to bind

Returns:

this

add

public PreparedBatch add(Map<String,?> args)

Bind arguments from a Map, add the binding as a saved batch, then clear the current binding.

Parameters:

args - map to bind arguments from for named parameters on the statement

Returns:

this

size

public int size()

Returns the number of bindings in this batch.

Returns:

the number of bindings in this batch.

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