Class Batch

java.lang.Object

org.jdbi.v3.core.statement.Batch

All Implemented Interfaces:

Closeable, AutoCloseable, Configurable<Batch>

public class Batch
extends Object

Represents a group of non-prepared statements to be sent to the RDMBS in one "request".

Constructor Summary

Constructors

Constructor	Description
Batch(Handle handle)

Method Summary

Modifier and Type	Method	Description
Batch	add(String sql)	Add a statement to the batch
final Batch	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.
ConfigRegistry	getConfig()	Returns the configuration registry associated with this object.
final StatementContext	getContext()	Returns the statement context associated with this statement.
final Handle	getHandle()

Methods inherited from class Object

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

Constructor Details

Batch

public Batch(Handle handle)

Method Details

add

public Batch add(String sql)

Add a statement to the batch

Parameters:

sql - SQL to be added to the batch, possibly a named statement

Returns:

the same Batch statement

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

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