Package org.jdbi.v3.core.statement

Class Batch

java.lang.Object

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

org.jdbi.v3.core.statement.Batch

All Implemented Interfaces:

Closeable, AutoCloseable, Configurable<Batch>

public class Batch
extends BaseStatement<Batch>

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

Nested Class Summary

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

BaseStatement.StatementCustomizerInvocation

Field Summary

Fields

Modifier and Type	Field	Description
private static final org.slf4j.Logger	LOG
private final List<String>	parts

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

typedThis

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
(package private) void	cleanupStatement(Statement statement)
(package private) Statement	createStatement()
int[]	execute()	Execute the batch and return the number of rows affected for each batch part.
(package private) static SQLException	mungeBatchException(SQLException e)	SQLExceptions thrown from batch executions have errors in a SQLException.getNextException() chain, which doesn't print out when you log them.

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, 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, registerCollector, registerColumnMapper, registerColumnMapper, registerColumnMapper, registerColumnMapper, registerColumnMapper, registerColumnMapper, registerExtension, registerRowMapper, registerRowMapper, registerRowMapper, registerRowMapper, setMapKeyColumn, setMapValueColumn, setSqlArrayArgumentStrategy, setSqlLogger, setSqlParser, setTemplateEngine, setTimingCollector

Field Details

LOG

private static final org.slf4j.Logger LOG

parts

private final List<String> parts

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

createStatement

Statement createStatement()
                   throws SQLException

Throws:

SQLException

cleanupStatement

void cleanupStatement(Statement statement)
               throws SQLException

Throws:

SQLException

mungeBatchException

static SQLException mungeBatchException(SQLException e)

SQLExceptions thrown from batch executions have errors in a SQLException.getNextException() chain, which doesn't print out when you log them. Convert them to be Throwable.addSuppressed(Throwable) exceptions, which do print out with common logging frameworks.

Parameters:

e - the exception

Returns:

the 'suppressed' munged exception change