Package org.jdbi.v3.core.statement

Class Update

java.lang.Object

org.jdbi.v3.core.statement.SqlStatement<Update>

org.jdbi.v3.core.statement.Update

All Implemented Interfaces:

Closeable, AutoCloseable, Configurable<Update>

public class Update
extends SqlStatement<Update>

Used for INSERT, UPDATE, and DELETE statements

Constructor Summary

Constructors

Constructor	Description
Update(Handle handle, CharSequence sql)
Update(Handle handle, String sql)	Backwards compatible constructor that takes an explicit string argument.

Method Summary

Modifier and Type	Method	Description
final Update	attachToHandleForCleanup()	Registers with the handle for cleaning when the handle is closed.
void	close()
final boolean	equals(Object o)
int	execute()	Executes the statement, returning the update count.
<R> R	execute(ResultProducer<R> producer)	Executes the update, returning the result obtained from the given ResultProducer.
ResultBearing	executeAndReturnGeneratedKeys(String... generatedKeyColumnNames)	Execute the statement and returns any auto-generated keys.
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()
void	one()

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

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, defineList, defineList, defineNamedBindings, setQueryTimeout, toString

Methods inherited from class java.lang.Object

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

Constructor Details

Update

public Update(Handle handle,
 CharSequence sql)

Update

public Update(Handle handle,
 String sql)

Backwards compatible constructor that takes an explicit string argument.

See Also:

• Update(Handle, CharSequence)

Method Details

one

public void one()

execute

public int execute()

Executes the statement, returning the update count.

Returns:

the number of rows modified

execute

public <R> R execute(ResultProducer<R> producer)

Executes the update, returning the result obtained from the given ResultProducer.

Type Parameters:

R - the result type

Parameters:

producer - the result producer.

Returns:

value returned by the result producer.

executeAndReturnGeneratedKeys

public ResultBearing executeAndReturnGeneratedKeys(String... generatedKeyColumnNames)

Execute the statement and returns any auto-generated keys. This requires the JDBC driver to support the Statement.getGeneratedKeys() method.

Parameters:

generatedKeyColumnNames - optional list of generated key column names.

Returns:

ResultBearing of generated keys

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