Class NamedQuery
NamedPreparedStatement only at prepare(Connection).
Unlike NamedPreparedStatement, this type does not call JDBC
prepareStatement in a constructor. Bindings are stored first; SQL is
parsed, optionally expanded, and only then prepared. That makes it possible
to expand collection parameters into multiple JDBC placeholders before the
statement is created.
The builder exposes the same set* methods as NamedPreparedStatement
plus setCollection(String, Collection) for IN (...) style
bindings. Scalar values are bound with the same JDBC setter semantics as
NamedPreparedStatement when prepare(Connection) is called.
Collection parameters expand each SQL occurrence into a comma-separated list
of positional placeholders. For example, WHERE id IN (:ids) with three
values becomes WHERE id IN (?,?,?). If the same collection parameter
appears more than once, each occurrence is expanded independently.
Use resolve() to inspect JDBC-ready SQL and bind values without
creating a PreparedStatement. By default colon-prefixed parameters
(:name) are parsed with ColonPrefixSqlParser; a custom
SqlParser can be supplied via of(String, SqlParser).
prepareCall(Connection) materializes a NamedCallableStatement
instead. OUT parameters are declared with registerOutParameter(String, int)
and do not accept an IN value. An INOUT parameter is both set and registered.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final recordJDBC-ready SQL and positional bind values produced byresolve(). -
Method Summary
Modifier and TypeMethodDescriptionclearBinding(String name) Removes the binding forname, if present.Removes all parameter bindings.static NamedQueryCreates a query builder with colon-prefixed named parameters.static NamedQueryCreates a query builder with a custom SQL parser.prepare(Connection connection) Resolves bindings and creates a fully boundNamedPreparedStatement.prepareCall(Connection connection) Resolves bindings and creates a fully boundNamedCallableStatement.registerOutParameter(String name, int sqlType) Registersnameas an OUT parameter.registerOutParameter(String name, int sqlType, int scale) Registersnameas an OUT parameter with scale.registerOutParameter(String name, int sqlType, String typeName) Registersnameas an OUT parameter with a database-specific type name.registerOutParameter(String name, SQLType sqlType) Registersnameas an OUT parameter of the givenSQLType.registerOutParameter(String name, SQLType sqlType, int scale) Registersnameas an OUT parameter of the givenSQLTypeand scale.registerOutParameter(String name, SQLType sqlType, String typeName) Registersnameas an OUT parameter of the givenSQLTypeand type name.resolve()Resolves named parameters to JDBC SQL and positional values without creating aPreparedStatement.Binds all map entries.setAsciiStream(String name, InputStream value) setAsciiStream(String name, InputStream value, int length) setAsciiStream(String name, InputStream value, long length) Binds@Bindmembers ofbean.setBigDecimal(String name, BigDecimal value) setBinaryStream(String name, InputStream value) setBinaryStream(String name, InputStream value, int length) setBinaryStream(String name, InputStream value, long length) setBlob(String name, InputStream inputStream) setBlob(String name, InputStream inputStream, long length) setBoolean(String name, boolean value) setCharacterStream(String name, Reader reader) setCharacterStream(String name, Reader reader, int length) setCharacterStream(String name, Reader reader, long length) setCollection(String name, Collection<?> values) Binds a collection value, expanding each SQL occurrence into multiple positional placeholders bound withPreparedStatement.setObject(int, Object).setNCharacterStream(String name, Reader value) setNCharacterStream(String name, Reader value, long length) setNString(String name, String value) setTimestamp(String name, Timestamp value) setTimestamp(String name, Timestamp value, Calendar cal)
-
Method Details
-
of
Creates a query builder with colon-prefixed named parameters. -
of
Creates a query builder with a custom SQL parser. -
setObject
-
setInt
-
setLong
-
setString
-
setBoolean
-
setByte
-
setShort
-
setFloat
-
setDouble
-
setBigDecimal
-
setBytes
-
setDate
-
setDate
-
setTime
-
setTime
-
setTimestamp
-
setTimestamp
-
setNull
-
setNull
-
setNull
-
setObject
-
setObject
-
setObject
-
setObject
-
setArray
-
setRef
-
setURL
-
setRowId
-
setSQLXML
-
setBlob
-
setBlob
-
setBlob
-
setClob
-
setClob
-
setClob
-
setNClob
-
setNClob
-
setNClob
-
setAsciiStream
-
setAsciiStream
-
setAsciiStream
-
setBinaryStream
-
setBinaryStream
-
setBinaryStream
-
setCharacterStream
-
setCharacterStream
-
setCharacterStream
-
setNCharacterStream
-
setNCharacterStream
-
setNString
-
registerOutParameter
Registersnameas an OUT parameter. The placeholder is kept, and no IN value is bound. Combine with aset*call on the same name for an INOUT parameter. -
registerOutParameter
Registersnameas an OUT parameter with scale. -
registerOutParameter
Registersnameas an OUT parameter with a database-specific type name. -
registerOutParameter
Registersnameas an OUT parameter of the givenSQLType. -
registerOutParameter
Registersnameas an OUT parameter of the givenSQLTypeand scale. -
registerOutParameter
Registersnameas an OUT parameter of the givenSQLTypeand type name. -
setCollection
Binds a collection value, expanding each SQL occurrence into multiple positional placeholders bound withPreparedStatement.setObject(int, Object).- Throws:
IllegalArgumentException- when the collection is empty
-
setAll
Binds all map entries. ACollectionvalue is bound withsetCollection(String, Collection); other non-null values usesetObject(String, Object). -
setBean
Binds@Bindmembers ofbean.Each member is read by reflection. When
Bind.converter()is notTypeConverter.DefaultConverter,TypeConverter.convert(Object)runs first. Anullresult is bound withsetNull(String). ACollectionis bound withsetCollection(String, Collection). Any other result usessetObject(String, Object). Members whose names are not parameters of this statement are ignored.- Throws:
IllegalArgumentException- whenbeanhas no@Bindmembers, none of those names are parameters of this statement, or a matching parameter is already boundIllegalStateException- when a converter cannot be created orconvertfailsNullPointerException- whenbeanisnull
-
clearBinding
Removes the binding forname, if present. -
clearBindings
Removes all parameter bindings. -
resolve
Resolves named parameters to JDBC SQL and positional values without creating aPreparedStatement.- Throws:
IllegalStateException- when required named parameters are not bound
-
prepare
Resolves bindings and creates a fully boundNamedPreparedStatement.- Throws:
SQLException
-
prepareCall
Resolves bindings and creates a fully boundNamedCallableStatement. OUT registrations are applied after IN values.- Throws:
SQLException
-