Class Script

java.lang.Object

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

org.jdbi.v3.core.statement.Script

All Implemented Interfaces:

Closeable, AutoCloseable, Configurable<Script>

public class Script
extends SqlStatement<Script>

Represents a number of SQL statements delimited by semicolon which will be executed in order in a batch statement.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final Script	attachToHandleForCleanup()	Registers with the handle for cleaning when the handle is closed.
void	close()
int[]	execute()	Execute this script in a batch statement
void	executeAsSeparateStatements()	Execute this script as a set of separate statements
ConfigRegistry	getConfig()	Returns the configuration registry associated with this object.
final StatementContext	getContext()	Returns the statement context associated with this statement.
final Handle	getHandle()
List<String>	getStatements()	Locate the Script and split it into statements.

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 Script	bind(int position, boolean value)	Bind an argument positionally
final Script	bind(int position, byte value)	Bind an argument positionally
final Script	bind(int position, byte[] value)	Bind an argument positionally
final Script	bind(int position, char value)	Bind an argument positionally
final Script	bind(int position, double value)	Bind an argument positionally
final Script	bind(int position, float value)	Bind an argument positionally
final Script	bind(int position, int value)	Bind an argument positionally
final Script	bind(int position, long value)	Bind an argument positionally
final Script	bind(int position, short value)	Bind an argument positionally
final Script	bind(int position, Reader value, int length)	Bind an argument positionally
final Script	bind(int position, Boolean value)	Bind an argument positionally
final Script	bind(int position, Byte value)	Bind an argument positionally
final Script	bind(int position, Character value)	Bind an argument positionally
final Script	bind(int position, Double value)	Bind an argument positionally
final Script	bind(int position, Float value)	Bind an argument positionally
final Script	bind(int position, Integer value)	Bind an argument positionally
final Script	bind(int position, Long value)	Bind an argument positionally
final Script	bind(int position, Object value)	Bind an argument positionally
final Script	bind(int position, Short value)	Bind an argument positionally
final Script	bind(int position, String value)	Bind an argument positionally
final Script	bind(int position, BigDecimal value)	Bind an argument positionally
final Script	bind(int position, URI value)	Bind an argument positionally
final Script	bind(int position, URL value)	Bind an argument positionally
final Script	bind(int position, Blob value)	Bind an argument positionally
final Script	bind(int position, Clob value)	Bind an argument positionally
final Script	bind(int position, Date value)	Bind an argument positionally
final Script	bind(int position, Time value)	Bind an argument positionally
final Script	bind(int position, Timestamp value)	Bind an argument positionally
final Script	bind(int position, Date value)	Bind an argument positionally
final Script	bind(int position, UUID value)	Bind an argument positionally
Script	bind(int position, Argument argument)	Used if you need to have some exotic parameter bound.
final Script	bind(String name, boolean value)	Bind an argument by name
final Script	bind(String name, byte value)	Bind an argument by name
final Script	bind(String name, byte[] value)	Bind an argument by name
final Script	bind(String name, char value)	Bind an argument by name
final Script	bind(String name, double value)	Bind an argument by name
final Script	bind(String name, float value)	Bind an argument by name
final Script	bind(String name, int value)	Bind an argument by name
final Script	bind(String name, long value)	Bind an argument by name
final Script	bind(String name, short value)	Bind an argument by name
final Script	bind(String name, Reader value, int length)	Bind an argument by name
final Script	bind(String name, Boolean value)	Bind an argument by name
final Script	bind(String name, Byte value)	Bind an argument by name
final Script	bind(String name, Character value)	Bind an argument by name
final Script	bind(String name, Double value)	Bind an argument by name
final Script	bind(String name, Float value)	Bind an argument by name
final Script	bind(String name, Integer value)	Bind an argument by name
final Script	bind(String name, Long value)	Bind an argument by name
final Script	bind(String name, Object value)	Bind an argument by name
final Script	bind(String name, Short value)	Bind an argument by name
final Script	bind(String name, String value)	Bind an argument by name
final Script	bind(String name, BigDecimal value)	Bind an argument by name
final Script	bind(String name, URI value)	Bind an argument by name
final Script	bind(String name, URL value)	Bind an argument by name
final Script	bind(String name, Blob value)	Bind an argument by name
final Script	bind(String name, Clob value)	Bind an argument by name
final Script	bind(String name, Date value)	Bind an argument by name
final Script	bind(String name, Time value)	Bind an argument by name
final Script	bind(String name, Timestamp value)	Bind an argument by name
final Script	bind(String name, Date value)	Bind an argument by name
final Script	bind(String name, UUID value)	Bind an argument by name
Script	bind(String name, Argument argument)	Used if you need to have some exotic parameter bound.
final Script	bindArray(int pos, Type elementType, Iterable<?> iterable)	Bind an Iterable as a SQL array.
final Script	bindArray(int pos, Type elementType, Object... array)	Bind a Java array as a SQL array, casting each element to a new type.
final Script	bindArray(int pos, Type elementType, Iterator<?> iterator)	Bind an Iterator as a SQL array.
final <T> Script	bindArray(int pos, T... array)	Bind a Java array as a SQL array.
final Script	bindArray(String name, Type elementType, Iterable<?> iterable)	Bind an Iterable as a SQL array.
final Script	bindArray(String name, Type elementType, Object... array)	Bind a Java array as a SQL array, casting each element to a new type.
final Script	bindArray(String name, Type elementType, Iterator<?> iterator)	Bind an Iterator as a SQL array.
final <T> Script	bindArray(String name, T... array)	Bind a Java array as a SQL array.
final Script	bindASCIIStream(int position, InputStream value, int length)	Bind an argument positionally
final Script	bindASCIIStream(String name, InputStream value, int length)	Bind an argument by name
Script	bindBean(Object bean)	Binds named parameters from JavaBean properties on the argument.
Script	bindBean(String prefix, Object bean)	Binds named parameters from JavaBean properties on the bean argument, with the given prefix.
final Script	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 Script	bindBinaryStream(int position, InputStream value, int length)	Bind an argument positionally
final Script	bindBinaryStream(String name, InputStream value, int length)	Bind an argument by name
final Script	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 Script	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 Script	bindByType(int position, Object value, Type argumentType)	Bind an argument dynamically by the type passed in.
final Script	bindByType(int position, Object value, GenericType<?> argumentType)	Bind an argument dynamically by the generic type passed in.
final Script	bindByType(int position, Object value, QualifiedType<?> argumentType)	Bind an argument dynamically by the qualified type passed in.
final Script	bindByType(String name, Object value, Type argumentType)	Bind an argument dynamically by the type passed in.
final Script	bindByType(String name, Object value, GenericType<?> argumentType)	Bind an argument dynamically by the generic type passed in.
final Script	bindByType(String name, Object value, QualifiedType<?> argumentType)	Bind an argument dynamically by the type passed in.
Script	bindFields(Object object)	Binds public fields of the specified object as arguments for the query.
Script	bindFields(String prefix, Object object)	Binds public fields of the specified object as arguments for the query.
final Script	bindList(String key, Iterable<?> values)	see SqlStatement.bindList(BiConsumer, String, List)
final Script	bindList(String key, Object... values)	see SqlStatement.bindList(BiConsumer, String, List)
final Script	bindList(String key, Iterator<?> values)	see SqlStatement.bindList(BiConsumer, String, List)
final Script	bindList(BiConsumer<SqlStatement, String> onEmpty, String key, Iterable<?> values)	see SqlStatement.bindList(BiConsumer, String, List)
final Script	bindList(BiConsumer<SqlStatement, String> onEmpty, String key, Object... values)	see SqlStatement.bindList(BiConsumer, String, List)
final Script	bindList(BiConsumer<SqlStatement, String> onEmpty, String key, Iterator<?> values)	see SqlStatement.bindList(BiConsumer, String, List)
final Script	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).
Script	bindMap(Map<String,?> map)	Binds named parameters from a map of String to Object instances
Script	bindMethods(Object object)	Binds methods with no parameters on the argument.
Script	bindMethods(String prefix, Object object)	Binds methods with no parameters on the argument, with the given prefix.
final Script	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.
Script	bindNamedArgumentFinder(NamedArgumentFinder namedArgumentFinder)	Binds a new NamedArgumentFinder.
final Script	bindNull(int position, int sqlType)	Bind NULL to be set for a given argument.
final Script	bindNull(String name, int sqlType)	Bind NULL to be set for a given argument.
final Script	bindNVarchar(int position, String value)	Bind a String argument positionally, as NVARCHAR type.
final Script	bindNVarchar(String name, String value)	Bind a String argument by name, as NVARCHAR type.
Script	bindPojo(Object pojo)	Binds named parameters from object properties on the argument.
Script	bindPojo(Object pojo, Type type)	Binds named parameters from object properties on the argument.
Script	bindPojo(Object pojo, GenericType<?> type)	Binds named parameters from object properties on the argument.
Script	bindPojo(String prefix, Object pojo)	Binds named parameters from object properties on the bean argument, with the given prefix.
Script	bindPojo(String prefix, Object pojo, Type type)	Binds named parameters from object properties on the bean argument, with the given prefix.
Script	bindPojo(String prefix, Object pojo, GenericType<?> type)	Binds named parameters from object properties on the bean argument, with the given prefix.
Script	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.
Script	cleanupHandleRollback()	When the statement is closed, roll it back then close the owning Handle.
final Script	defineList(String key, Object... values)	Define an attribute as the comma-separated String from the elements of the values argument.
final Script	defineList(String key, List<?> values)	Define an attribute as the comma-separated String from the elements of the values argument.
Script	defineNamedBindings()	Define all bound arguments that don't already have a definition with a boolean indicating their presence.
Script	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 Script	addCustomizer(StatementCustomizer customizer)
default <C extends JdbiConfig<C>> Script	configure(Class<C> configClass, Consumer<C> configurer)	Passes the configuration object of the given type to the configurer, then returns this object.
default Script	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 Script	registerArgument(ArgumentFactory factory)	Convenience method for getConfig(Arguments.class).register(factory)
default Script	registerArgument(QualifiedArgumentFactory factory)	Convenience method for getConfig(Arguments.class).register(factory)
default Script	registerArrayType(Class<?> elementType, String sqlTypeName)	Convenience method for getConfig(SqlArrayTypes.class).register(elementType, sqlTypeName)
default <T> Script	registerArrayType(Class<T> elementType, String sqlTypeName, Function<T,?> conversion)	Convenience method for registering an array type as SqlArrayTypeFactory.of(Class, String, Function).
default Script	registerArrayType(SqlArrayType<?> arrayType)	Convenience method for getConfig(SqlArrayTypes.class).register(arrayType)
default Script	registerArrayType(SqlArrayTypeFactory factory)	Convenience method for getConfig(SqlArrayTypes.class).register(factory)
default Script	registerCodecFactory(CodecFactory codecFactory)	Convenience method to register a CodecFactory.
default Script	registerCollector(Type collectionType, Collector<?,?,?> collector)	Convenience method for getConfig(JdbiCollectors.class).register(CollectorFactory.collectorFactory(collectionType, collector))
default Script	registerCollector(CollectorFactory factory)	Convenience method for getConfig(JdbiCollectors.class).register(factory)
default Script	registerColumnMapper(Type type, ColumnMapper<?> mapper)	Convenience method for getConfig(ColumnMappers.class).register(type, mapper)
default <T> Script	registerColumnMapper(GenericType<T> type, ColumnMapper<T> mapper)	Convenience method for getConfig(ColumnMappers.class).register(type, mapper)
default Script	registerColumnMapper(ColumnMapper<?> mapper)	Convenience method for getConfig(ColumnMappers.class).register(mapper)
default Script	registerColumnMapper(ColumnMapperFactory factory)	Convenience method for getConfig(ColumnMappers.class).register(factory)
default Script	registerColumnMapper(QualifiedColumnMapperFactory factory)	Convenience method for getConfig(ColumnMappers.class).register(factory)
default <T> Script	registerColumnMapper(QualifiedType<T> type, ColumnMapper<T> mapper)	Convenience method for getConfig(ColumnMappers.class).register(type, mapper)
default Script	registerExtension(ExtensionFactory factory)	Convenience method for getConfig(Extensions.class).register(factory)
default Script	registerRowMapper(Type type, RowMapper<?> mapper)	Convenience method for getConfig(RowMappers.class).register(type, mapper)
default <T> Script	registerRowMapper(GenericType<T> type, RowMapper<T> mapper)	Convenience method for getConfig(RowMappers.class).register(type, mapper)
default Script	registerRowMapper(RowMapper<?> mapper)	Convenience method for getConfig(RowMappers.class).register(mapper)
default Script	registerRowMapper(RowMapperFactory factory)	Convenience method for getConfig(RowMappers.class).register(factory)
default Script	setMapKeyColumn(String keyColumn)	Convenience method for getConfig(MapEntryMappers.class).setKeyColumn(keyColumn)
default Script	setMapValueColumn(String valueColumn)	Convenience method for getConfig(MapEntryMappers.class).setValueColumn(valueColumn)
default Script	setSqlArrayArgumentStrategy(SqlArrayArgumentStrategy strategy)	Convenience method for getConfig(SqlArrayTypes.class).setArgumentStrategy(strategy)
default Script	setSqlLogger(SqlLogger sqlLogger)
default Script	setSqlParser(SqlParser parser)	Convenience method for getConfig(SqlStatements.class).setSqlParser(rewriter)
default Script	setTemplateEngine(TemplateEngine templateEngine)	Convenience method for getConfig(SqlStatements.class).setTemplateEngine(rewriter)
default Script	setTimingCollector(TimingCollector collector)	Deprecated, for removal: This API element is subject to removal in a future version. use Configurable.setSqlLogger(SqlLogger) instead

Constructor Details

Script

public Script(Handle handle,
 CharSequence sql)

Script

public Script(Handle handle,
 String sql)

Backwards compatible constructor that takes an explicit string argument.

See Also:

• Script(Handle, CharSequence)

Method Details

execute

public int[] execute()

Execute this script in a batch statement

Returns:

an array of ints which are the results of each statement in the script

executeAsSeparateStatements

public void executeAsSeparateStatements()

Execute this script as a set of separate statements

getStatements

public List<String> getStatements()

Locate the Script and split it into statements.

Returns:

the split statements

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