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 and Description
Batch(Handle handle)

Method Summary

Modifier and Type	Method and Description
Batch	add(String sql) Add a statement to the batch
This	addCustomizer(StatementCustomizer customizer) Provides a means for custom statement modification.
void	close()
int[]	execute() Execute all the queued up statements
ConfigRegistry	getConfig() Returns the configuration registry associated with this object.
StatementContext	getContext()
Handle	getHandle()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jdbi.v3.core.config.Configurable

configure, define, getConfig, registerArgument, registerArrayType, registerArrayType, registerArrayType, registerCollector, registerColumnMapper, registerColumnMapper, registerColumnMapper, registerExtension, registerRowMapper, registerRowMapper, registerRowMapper, setMapKeyColumn, setMapValueColumn, setSqlArrayArgumentStrategy, setSqlParser, setTemplateEngine, setTimingCollector

Constructor Detail

Batch

public Batch(Handle handle)

Method Detail

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 all the queued up statements

Returns:

an array of integers representing the return values from each statement's execution

addCustomizer

public final This addCustomizer(StatementCustomizer customizer)

Provides a means for custom statement modification. Common customizations have their own methods, such as Query.setMaxRows(int)

Parameters:

customizer - instance to be used to customize a statement

Returns:

this

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

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

getHandle

public Handle getHandle()