Package org.jdbi.v3.core.statement

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()
final boolean	equals(Object o)
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()
final int	hashCode()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, 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, registerColumnMapper, registerColumnMapper, registerColumnMapper, registerColumnMapper, registerColumnMapper, registerColumnMapper, registerExtension, registerRowMapper, registerRowMapper, registerRowMapper, registerRowMapper, setMapKeyColumn, setMapValueColumn, setSqlArrayArgumentStrategy, setSqlLogger, setSqlParser, setTemplateEngine, setTimingCollector

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

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

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object