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()
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.
long	executeLarge()	Executes the statement, returning the large update count.
ConfigRegistry	getConfig()	Returns the configuration registry associated with this object.
final StatementContext	getContext()	Returns the statement context associated with this statement.
final Handle	getHandle()
void	one()

Methods inherited from class 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

Modifier and Type	Method	Description
final Update	bind(int position, boolean value)	Bind an argument positionally
final Update	bind(int position, byte value)	Bind an argument positionally
final Update	bind(int position, byte[] value)	Bind an argument positionally
final Update	bind(int position, char value)	Bind an argument positionally
final Update	bind(int position, double value)	Bind an argument positionally
final Update	bind(int position, float value)	Bind an argument positionally
final Update	bind(int position, int value)	Bind an argument positionally
final Update	bind(int position, long value)	Bind an argument positionally
final Update	bind(int position, short value)	Bind an argument positionally
final Update	bind(int position, Reader value, int length)	Bind an argument positionally
final Update	bind(int position, Boolean value)	Bind an argument positionally
final Update	bind(int position, Byte value)	Bind an argument positionally
final Update	bind(int position, Character value)	Bind an argument positionally
final Update	bind(int position, Double value)	Bind an argument positionally
final Update	bind(int position, Float value)	Bind an argument positionally
final Update	bind(int position, Integer value)	Bind an argument positionally
final Update	bind(int position, Long value)	Bind an argument positionally
final Update	bind(int position, Object value)	Bind an argument positionally
final Update	bind(int position, Short value)	Bind an argument positionally
final Update	bind(int position, String value)	Bind an argument positionally
final Update	bind(int position, BigDecimal value)	Bind an argument positionally
final Update	bind(int position, URI value)	Bind an argument positionally
final Update	bind(int position, URL value)	Bind an argument positionally
final Update	bind(int position, Blob value)	Bind an argument positionally
final Update	bind(int position, Clob value)	Bind an argument positionally
final Update	bind(int position, Date value)	Bind an argument positionally
final Update	bind(int position, Time value)	Bind an argument positionally
final Update	bind(int position, Timestamp value)	Bind an argument positionally
final Update	bind(int position, Date value)	Bind an argument positionally
final Update	bind(int position, UUID value)	Bind an argument positionally
Update	bind(int position, Argument argument)	Used if you need to have some exotic parameter bound.
final Update	bind(String name, boolean value)	Bind an argument by name
final Update	bind(String name, byte value)	Bind an argument by name
final Update	bind(String name, byte[] value)	Bind an argument by name
final Update	bind(String name, char value)	Bind an argument by name
final Update	bind(String name, double value)	Bind an argument by name
final Update	bind(String name, float value)	Bind an argument by name
final Update	bind(String name, int value)	Bind an argument by name
final Update	bind(String name, long value)	Bind an argument by name
final Update	bind(String name, short value)	Bind an argument by name
final Update	bind(String name, Reader value, int length)	Bind an argument by name
final Update	bind(String name, Boolean value)	Bind an argument by name
final Update	bind(String name, Byte value)	Bind an argument by name
final Update	bind(String name, Character value)	Bind an argument by name
final Update	bind(String name, Double value)	Bind an argument by name
final Update	bind(String name, Float value)	Bind an argument by name
final Update	bind(String name, Integer value)	Bind an argument by name
final Update	bind(String name, Long value)	Bind an argument by name
final Update	bind(String name, Object value)	Bind an argument by name
final Update	bind(String name, Short value)	Bind an argument by name
final Update	bind(String name, String value)	Bind an argument by name
final Update	bind(String name, BigDecimal value)	Bind an argument by name
final Update	bind(String name, URI value)	Bind an argument by name
final Update	bind(String name, URL value)	Bind an argument by name
final Update	bind(String name, Blob value)	Bind an argument by name
final Update	bind(String name, Clob value)	Bind an argument by name
final Update	bind(String name, Date value)	Bind an argument by name
final Update	bind(String name, Time value)	Bind an argument by name
final Update	bind(String name, Timestamp value)	Bind an argument by name
final Update	bind(String name, Date value)	Bind an argument by name
final Update	bind(String name, UUID value)	Bind an argument by name
Update	bind(String name, Argument argument)	Used if you need to have some exotic parameter bound.
final Update	bindArray(int pos, Type elementType, Iterable<?> iterable)	Bind an Iterable as a SQL array.
final Update	bindArray(int pos, Type elementType, Object... array)	Bind a Java array as a SQL array, casting each element to a new type.
final Update	bindArray(int pos, Type elementType, Iterator<?> iterator)	Bind an Iterator as a SQL array.
final <T> Update	bindArray(int pos, T... array)	Bind a Java array as a SQL array.
final Update	bindArray(String name, Type elementType, Iterable<?> iterable)	Bind an Iterable as a SQL array.
final Update	bindArray(String name, Type elementType, Object... array)	Bind a Java array as a SQL array, casting each element to a new type.
final Update	bindArray(String name, Type elementType, Iterator<?> iterator)	Bind an Iterator as a SQL array.
final <T> Update	bindArray(String name, T... array)	Bind a Java array as a SQL array.
final Update	bindASCIIStream(int position, InputStream value, int length)	Bind an argument positionally
final Update	bindASCIIStream(String name, InputStream value, int length)	Bind an argument by name
Update	bindBean(Object bean)	Binds named parameters from JavaBean properties on the argument.
Update	bindBean(String prefix, Object bean)	Binds named parameters from JavaBean properties on the bean argument, with the given prefix.
final Update	bindBeanList(String key, List<?> values, List<String> propertyNames)	Bind a parameter for each value in the given list * number of property names, and defines an attribute as the comma-separated list of parameter references (using colon prefix).
final Update	bindBinaryStream(int position, InputStream value, int length)	Bind an argument positionally
final Update	bindBinaryStream(String name, InputStream value, int length)	Bind an argument by name
final Update	bindBySqlType(int position, Object value, int sqlType)	Bind a value using a specific type from java.sql.Types via PreparedStatement#setObject(int, Object, int)
final Update	bindBySqlType(String name, Object value, int sqlType)	Bind a value using a specific type from java.sql.Types via PreparedStatement#setObject(int, Object, int)
final Update	bindByType(int position, Object value, Type argumentType)	Bind an argument dynamically by the type passed in.
final Update	bindByType(int position, Object value, GenericType<?> argumentType)	Bind an argument dynamically by the generic type passed in.
final Update	bindByType(int position, Object value, QualifiedType<?> argumentType)	Bind an argument dynamically by the qualified type passed in.
final Update	bindByType(String name, Object value, Type argumentType)	Bind an argument dynamically by the type passed in.
final Update	bindByType(String name, Object value, GenericType<?> argumentType)	Bind an argument dynamically by the generic type passed in.
final Update	bindByType(String name, Object value, QualifiedType<?> argumentType)	Bind an argument dynamically by the type passed in.
Update	bindFields(Object object)	Binds public fields of the specified object as arguments for the query.
Update	bindFields(String prefix, Object object)	Binds public fields of the specified object as arguments for the query.
final Update	bindList(String key, Iterable<?> values)	see SqlStatement.bindList(BiConsumer, String, List)
final Update	bindList(String key, Object... values)	see SqlStatement.bindList(BiConsumer, String, List)
final Update	bindList(String key, Iterator<?> values)	see SqlStatement.bindList(BiConsumer, String, List)
final Update	bindList(BiConsumer<SqlStatement, String> onEmpty, String key, Iterable<?> values)	see SqlStatement.bindList(BiConsumer, String, List)
final Update	bindList(BiConsumer<SqlStatement, String> onEmpty, String key, Object... values)	see SqlStatement.bindList(BiConsumer, String, List)
final Update	bindList(BiConsumer<SqlStatement, String> onEmpty, String key, Iterator<?> values)	see SqlStatement.bindList(BiConsumer, String, List)
final Update	bindList(BiConsumer<SqlStatement, String> onEmpty, String key, List<?> values)	Bind a parameter for each value in the given list, and defines an attribute as the comma-separated list of parameter references (using colon prefix).
Update	bindMap(Map<String,?> map)	Binds named parameters from a map of String to Object instances
Update	bindMethods(Object object)	Binds methods with no parameters on the argument.
Update	bindMethods(String prefix, Object object)	Binds methods with no parameters on the argument, with the given prefix.
final Update	bindMethodsList(String key, Iterable<?> values, List<String> methodNames)	For each value given, create a tuple by invoking each given method in order, and bind the tuple into a VALUES (...) format insert clause.
Update	bindNamedArgumentFinder(NamedArgumentFinder namedArgumentFinder)	Binds a new NamedArgumentFinder.
final Update	bindNull(int position, int sqlType)	Bind NULL to be set for a given argument.
final Update	bindNull(String name, int sqlType)	Bind NULL to be set for a given argument.
final Update	bindNVarchar(int position, String value)	Bind a String argument positionally, as NVARCHAR type.
final Update	bindNVarchar(String name, String value)	Bind a String argument by name, as NVARCHAR type.
Update	bindPojo(Object pojo)	Binds named parameters from object properties on the argument.
Update	bindPojo(Object pojo, Type type)	Binds named parameters from object properties on the argument.
Update	bindPojo(Object pojo, GenericType<?> type)	Binds named parameters from object properties on the argument.
Update	bindPojo(String prefix, Object pojo)	Binds named parameters from object properties on the bean argument, with the given prefix.
Update	bindPojo(String prefix, Object pojo, Type type)	Binds named parameters from object properties on the bean argument, with the given prefix.
Update	bindPojo(String prefix, Object pojo, GenericType<?> type)	Binds named parameters from object properties on the bean argument, with the given prefix.
Update	cleanupHandleCommit()	Transfer ownership of the handle to the statement: when the statement is closed, commit the handle's transaction (if one exists) and close the handle.
Update	cleanupHandleRollback()	When the statement is closed, roll it back then close the owning Handle.
final Update	defineList(String key, Object... values)	Define an attribute as the comma-separated String from the elements of the values argument.
final Update	defineList(String key, List<?> values)	Define an attribute as the comma-separated String from the elements of the values argument.
Update	defineNamedBindings()	Define all bound arguments that don't already have a definition with a boolean indicating their presence.
Update	setQueryTimeout(int seconds)	Set the query timeout, in seconds, on the prepared statement.
String	toString()

Methods inherited from class Object

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

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

executeLarge

public long executeLarge()

Executes the statement, returning the large update count.

Returns:

the number of rows modified as a long

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