Package org.jdbi.v3.core.statement

Class PreparedBatch

java.lang.Object

org.jdbi.v3.core.statement.BaseStatement<This>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	PreparedBatch.ExecutedBatch
private static final class	PreparedBatch.ExecutedBatchConsumer

Nested classes/interfaces inherited from class org.jdbi.v3.core.statement.BaseStatement

BaseStatement.StatementCustomizerInvocation

Field Summary

Fields

Modifier and Type	Field	Description
private final List<PreparedBinding>	bindings
(package private) final Map<NamedArgumentFinderFactory.PrepareKey,Function<String,Optional<Function<Object,Argument>>>>	preparedFinders

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

stmt

Fields inherited from class org.jdbi.v3.core.statement.BaseStatement

typedThis

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.
(package private) PreparedBatch	bindNamedArgumentFinder(NamedArgumentFinderFactory factory, String prefix, Object value, Type type, Supplier<NamedArgumentFinder> backupArgumentFinder)
(package private) Function<Object,Argument>	buildArgument(QualifiedType<?> type)
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.
private <R> R	execute(ResultProducer<R> producer, Consumer<PreparedBatch.ExecutedBatch> batchConsumer)
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. 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.
protected PreparedBinding	getBinding()
private PreparedBatch.ExecutedBatch	internalBatchExecute()
<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 org.jdbi.v3.core.statement.SqlStatement

afterExecution, beforeBinding, beforeExecution, beforeTemplating, 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, cleanupStatement, createStatement, defineList, defineList, defineNamedBindings, getSql, internalExecute, mapperForType, mapperForType, mapperForType, parseSql, setQueryTimeout, toString

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

addCustomizers, attachToHandleForCleanup, callCustomizers, cleanUpForException, close, equals, getConfig, getContext, getHandle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, 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, 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

Field Details

bindings

private final List<PreparedBinding> bindings

preparedFinders

final Map<NamedArgumentFinderFactory.PrepareKey,Function<String,Optional<Function<Object,Argument>>>> preparedFinders

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

bindNamedArgumentFinder

PreparedBatch bindNamedArgumentFinder(NamedArgumentFinderFactory factory,
 String prefix,
 Object value,
 Type type,
 Supplier<NamedArgumentFinder> backupArgumentFinder)

Overrides:

bindNamedArgumentFinder in class SqlStatement<PreparedBatch>

getBinding

protected PreparedBinding getBinding()

Overrides:

getBinding in class SqlStatement<PreparedBatch>

buildArgument

Function<Object,Argument> buildArgument(QualifiedType<?> type)

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
public ResultBearing executeAndReturnGeneratedKeys(String... columnNames)

Deprecated.

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.

execute

private <R> R execute(ResultProducer<R> producer,
 Consumer<PreparedBatch.ExecutedBatch> batchConsumer)

internalBatchExecute

private PreparedBatch.ExecutedBatch internalBatchExecute()

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.