Module org.tquadrat.foundation.sql

Package org.tquadrat.foundation.sql

Interface EnhancedPreparedStatement

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

EnhancedPreparedStatementBase, EnhancedPreparedStatementImpl

@ClassVersion(sourceVersion="$Id: EnhancedPreparedStatement.java 1091 2024-01-25 23:10:08Z tquadrat $")
@API(status=STABLE,
     since="0.1.0")
public sealed interface EnhancedPreparedStatement
extends AutoCloseable
permits EnhancedPreparedStatementBase

The definition of an enhanced PreparedStatement.

The implementation of this interface wraps an instance of PreparedStatement and provides solutions for three issues that the original definition has:

1. The placeholders in a prepared statement are only identified by their position, and it is quite easy to mix those positions up, especially when modifying the statement. This can cause errors during runtime that are very difficult to detect.
2. The fact that the placeholders are only position based causes another inconvenience. Assume an SQL statement like that one below:

       SELECT *
       FROM table1,table2
       WHERE table1.key = table2.key
             AND table1.value < ?
             AND table2.value > ?

   where the question mark stands for the same value. This would require to call setInt() twice, with the same value, but a different position index.
3. PreparedStatement does not allow to log the SQL statement together with the assigned values for the placeholders; at least this is not defined in the interface itself; some vendor specific implementations may provide such an additional API, but there is no generic one. An implementation of this interface takes a method that can write any executed SQL statement to a logger.

Note:

• The interface EnhancedPreparedStatement does not extends the interface java.sql.PreparedStatement!

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: EnhancedPreparedStatement.java 1091 2024-01-25 23:10:08Z tquadrat $

Since:

0.1.0

See Also:

• PreparedStatement

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.sql.EnhancedPreparedStatement"

⁠

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EnhancedPreparedStatement.StatementLogger	The definition of logger method for a PreparedStatement.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	VARIABLE_PATTERN	The regular expression that is used to identify a named parameter in the SQL statement text: "[^:](:[a-zA-Z][a-zA-Z0-9]*)".

Method Summary

Modifier and Type	Method	Description
void	addBatch()	Adds a set of parameters to this EnhancedPreparedStatement instance's batch of commands.
void	cancel()	Cancels this EnhancedPreparedStatement object if both the DBMS and driver support aborting an SQL statement.
void	clearBatch()	Empties this EnhancedPreparedStatement instance's current list of SQL commands.
void	clearParameters()	Clears the current parameter values immediately.
void	clearWarnings()	Clears all the warnings reported on this EnhancedPreparedStatement instance.
void	close()	Releases this instance's database and JDBC resources immediately instead of waiting for this to happen when it is automatically closed.
void	closeOnCompletion()	Specifies that this EnhancedPreparedStatement will be closed when all its dependent result sets are closed.
static void	enableLogging(EnhancedPreparedStatement.StatementLogger logger, BooleanSupplier logCheck, boolean addStacktrace)	Enables the logging output for the EnhancedPreparedStatement instances.
String	enquoteIdentifier(String identifier, boolean alwaysQuote)	Returns a SQL identifier.
String	enquoteLiteral(String value)	Returns a String enclosed in single quotes.
String	enquoteNCharLiteral(String s)	Returns a String representing a National Character Set Literal enclosed in single quotes and prefixed with a upper case letter N.
boolean	execute()	Executes the SQL statement in this PreparedStatement object, which may be any kind of SQL statement.
int[]	executeBatch()	Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts.
long[]	executeLargeBatch()	Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts.
long	executeLargeUpdate()	Executes the SQL statement in this EnhancedPreparedStatement instance.
ResultSet	executeQuery()	Executes the SQL query in this PreparedStatement object and returns the ResultSet object generated by the query.
int	executeUpdate()	Executes the SQL statement in this EnhancedPreparedStatement instance.
Connection	getConnection()	Retrieves the Connection instance that produced the PreparedStatement instance wrapped by this EnhancedPreparedStatement.
int	getFetchDirection()	Retrieves the direction for fetching rows from database tables that is the default for result sets generated from this EnhancedPreparedStatement instance.
int	getFetchSize()	Retrieves the number of result set rows that is the default fetch size for ResultSet instances generated from this EnhancedPreparedStatement instance.
ResultSet	getGeneratedKeys()	Retrieves any auto-generated keys created as a result of executing this EnhancedPreparedStatement instance.
long	getLargeMaxRows()	Retrieves the maximum number of rows that a ResultSet instance produced by this EnhancedPreparedStatement instance can contain.
long	getLargeUpdateCount()	Retrieves the current result as an update count.
int	getMaxFieldSize()	Retrieves the maximum number of bytes that can be returned for character and binary column values in a ResultSet object produced by this EnhancedPreparedStatement object.
int	getMaxRows()	Retrieves the maximum number of rows that a ResultSet instance produced by this EnhancedPreparedStatement instance can contain.
ResultSetMetaData	getMetaData()	Retrieves a ResultSetMetaData object that contains information about the columns of the ResultSet instance that will be returned when this EnhancedPreparedStatement instance is executed.
boolean	getMoreResults()	Moves to this EnhancedPreparedStatement instance's next result, returns true if it is a ResultSet instance, and implicitly closes any current ResultSet instance(s) previously obtained with the method getResultSet().
boolean	getMoreResults(int current)	Moves to this EnhancedPreparedStatement instance's next result, deals with any current ResultSet instance(s) according to the instructions specified by the given flag, and returns true if the next result is a ResultSet object.
ParameterMetaData	getParameterMetaData()	Retrieves the number, types and properties of this EnhancedPreparedStatement instance's parameters.
int	getQueryTimeout()	Retrieves the number of seconds the driver will wait for a Statement instance to execute.
ResultSet	getResultSet()	Retrieves the current result as a ResultSet instance.
int	getResultSetConcurrency()	Retrieves the result set concurrency for ResultSet instances generated by this EnhancedPreparedStatement instance.
int	getResultSetHoldability()	Retrieves the result set holdability for ResultSet instances generated by this EnhancedPreparedStatement instance.
int	getResultSetType()	Retrieves the result set type for ResultSet instances generated by this EnhancedPreparedStatement instance.
int	getUpdateCount()	Retrieves the current result as an update count.
SQLWarning	getWarnings()	Retrieves the first warning reported by calls on this EnhancedPreparedStatement instance.
boolean	isClosed()	Retrieves whether this EnhancedPreparedStatement object has been closed.
boolean	isCloseOnCompletion()	Returns a value indicating whether this EnhancedPreparedStatement will be closed when all its dependent result sets are closed.
boolean	isLoggingEnabled()	Checks whether logging is currently enabled.
boolean	isPoolable()	Returns a value indicating whether the wrapped PreparedStatement is poolable or not.
boolean	isSimpleIdentifier(String identifier)	Retrieves whether identifier is a simple SQL identifier.
static EnhancedPreparedStatement	prepareStatement(Connection connection, String sql)	Creates a new EnhancedPreparedStatement instance.
void	setArray(String parameterName, Array value)	Sets the designated parameter to the given Array instance.
void	setAsciiStream(String parameterName, InputStream value)	Sets the designated parameter to the given InputStream.
void	setAsciiStream(String parameterName, InputStream value, int length)	Sets the designated parameter to the given InputStream which will have the specified number of bytes.
void	setAsciiStream(String parameterName, InputStream value, long length)	Sets the designated parameter to the given InputStream which will have the specified number of bytes.
void	setBigDecimal(String parameterName, BigDecimal value)	Sets the designated parameter to the given Java BigDecimal value.
void	setBinaryStream(String parameterName, InputStream value)	Sets the designated parameter to the given InputStream.
void	setBinaryStream(String parameterName, InputStream value, int length)	Sets the designated parameter to the given InputStream which will have the specified number of bytes.
void	setBinaryStream(String parameterName, InputStream value, long length)	Sets the designated parameter to the given InputStream which will have the specified number of bytes.
void	setBlob(String parameterName, InputStream value)	Sets the designated parameter to a InputStream object.
void	setBlob(String parameterName, InputStream value, long length)	Sets the designated parameter to a InputStream object.
void	setBlob(String parameterName, Blob value)	Sets the designated parameter to the given Java Blob instance.
void	setBoolean(String parameterName, boolean value)	Sets the designated parameter to the given Java boolean value.
void	setByte(String parameterName, byte value)	Sets the designated parameter to the given Java byte value.
void	setBytes(String parameterName, byte[] value)	Sets the designated parameter to the given Java array of bytes.
void	setCharacterStream(String parameterName, Reader value)	Sets the designated parameter to the given Reader instance.
void	setCharacterStream(String parameterName, Reader value, int length)	Sets the designated parameter to the given Reader instance, which provides the given number of characters.
void	setCharacterStream(String parameterName, Reader value, long length)	Sets the designated parameter to the given Reader instance, which provides the given number of characters.
void	setClob(String parameterName, Reader value)	Sets the designated parameter to a Reader instance.
void	setClob(String parameterName, Reader value, long length)	Sets the designated parameter to a Reader instance.
void	setClob(String parameterName, Clob value)	Sets the designated parameter to the given Clob instance.
void	setCursorName(String name)	Sets the SQL cursor name to the given String, which will be used by subsequent statement execute() methods.
void	setDate(String parameterName, Date value)	Sets the designated parameter to the given Date value using the default time zone of the virtual machine that is running the application.
void	setDate(String parameterName, Date value, Calendar calendar)	Sets the designated parameter to the given Date value using the given Calendar instance.
void	setDouble(String parameterName, double value)	Sets the designated parameter to the given Java double value.
void	setFetchDirection(int direction)	Gives the driver a hint as to the direction in which rows will be processed in ResultSet instances created using this EnhancedPreparedStatement object.
void	setFetchSize(int rows)	Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed for ResultSet instances generated by this EnhancedPreparedStatement instance.
void	setFloat(String parameterName, float value)	Sets the designated parameter to the given Java float value.
void	setInt(String parameterName, int value)	Sets the designated parameter to the given Java int value.
void	setLargeMaxRows(long max)	Sets the limit for the maximum number of rows that any ResultSet instance generated by this EnhancedPreparedStatement instance can contain.
void	setLong(String parameterName, long value)	Sets the designated parameter to the given Java long value.
void	setMaxFieldSize(int max)	Sets the limit for the maximum number of bytes that can be returned for character and binary column values in a ResultSet object produced by this Statement object.
void	setMaxRows(int max)	Sets the limit for the maximum number of rows, that any ResultSet instance generated by this EnhancedPreparedStatement instance can contain, to the given number.
void	setNCharacterStream(String parameterName, Reader value)	Sets the designated parameter to the given Reader instance.
void	setNCharacterStream(String parameterName, Reader value, long length)	Sets the designated parameter to the given Reader instance.
void	setNClob(String parameterName, Reader value)	Sets the designated parameter to a Reader instance.
void	setNClob(String parameterName, Reader value, long length)	Sets the designated parameter to a Reader instance.
void	setNClob(String parameterName, NClob value)	Sets the designated parameter to the given NClob value.
void	setNString(String parameterName, String value)	Sets the designated parameter to the given Java String value.
void	setNull(String parameterName, SQLType sqlType)	Sets the designated parameter to SQL NULL.
void	setNull(String parameterName, SQLType sqlType, String typeName)	Sets the designated parameter to SQL NULL.
void	setObject(String parameterName, Object value)	Sets the value of the designated parameter using the given object.
void	setObject(String parameterName, Object value, SQLType targetSqlType)	Sets the value of the designated parameter with the given object.
void	setObject(String parameterName, Object value, SQLType targetSqlType, int scaleOrLength)	Sets the value of the designated parameter using the given object.
void	setQueryTimeout(int timeout)	Sets the number of seconds the driver will wait for a Statement instance to execute to the given number of seconds.
void	setRef(String parameterName, Ref value)	Sets the designated parameter to the given REF(<structured-type>) value.
void	setRowId(String parameterName, RowId value)	Sets the designated parameter to the given RowId instance.
void	setShort(String parameterName, short value)	Sets the designated parameter to the given Java short value.
void	setSQLXML(String parameterName, SQLXML value)	Sets the designated parameter to the given SQLXML value.
void	setString(String parameterName, String value)	Sets the designated parameter to the given Java String value.
void	setTime(String parameterName, Time value)	Sets the designated parameter to the given Time value.
void	setTime(String parameterName, Time value, Calendar calendar)	Sets the designated parameter to the given Time value using the given Calendar instance.
void	setTimestamp(String parameterName, Timestamp value)	Sets the designated parameter to the given Timestamp value.
void	setTimestamp(String parameterName, Timestamp value, Calendar calendar)	Sets the designated parameter to the given Timestamp value using the given Calendar instance.
void	setURL(String parameterName, URL value)	Sets the designated parameter to the given URL value.

Field Details

VARIABLE_PATTERN

static final String VARIABLE_PATTERN

The regular expression that is used to identify a named parameter in the SQL statement text: "[^:](:[a-zA-Z][a-zA-Z0-9]*)".

See Also:

• prepareStatement(Connection,String)
• Constant Field Values

Method Details

addBatch

void addBatch()
       throws SQLException

Adds a set of parameters to this EnhancedPreparedStatement instance's batch of commands.

Throws:

SQLException - A database access error occurred or this method was called on a closed EnhancedPreparedStatement.

See Also:

• Statement.addBatch(String)

cancel

void cancel()
     throws SQLException

Cancels this EnhancedPreparedStatement object if both the DBMS and driver support aborting an SQL statement.

This method can be used by one thread to cancel a statement that is being executed by another thread.

Throws:

SQLException - A database access error occurred or this method was called on a closed EnhancedPreparedStatement.

SQLFeatureNotSupportedException - The JDBC driver does not support this method.

clearBatch

void clearBatch()
         throws SQLException

Empties this EnhancedPreparedStatement instance's current list of SQL commands.

Throws:

SQLException - A database access error occurred, this method was called on a closed EnhancedPreparedStatement, or the driver does not support batch updates.

See Also:

• addBatch()
• DatabaseMetaData.supportsBatchUpdates()

clearParameters

void clearParameters()
              throws SQLException

Clears the current parameter values immediately.

In general, parameter values remain in force for repeated use of a statement. Setting a parameter value automatically clears its previous value. However, in some cases it is useful to immediately release the resources used by the current parameter values; this can be done by calling the method clearParameters().

Throws:

SQLException - A database access error occurred or this method was called on a closed EnhancedPreparedStatement.

clearWarnings

void clearWarnings()
            throws SQLException

Clears all the warnings reported on this EnhancedPreparedStatement instance. After a call to this method, the method getWarnings() will return null until a new warning is reported for this EnhancedPreparedStatement instance.

Throws:

SQLException - A database access error occurred or this method was called on a closed EnhancedPreparedStatement.

close

void close()
    throws SQLException

Releases this instance's database and JDBC resources immediately instead of waiting for this to happen when it is automatically closed. It is generally good practice to release resources as soon as you are finished with them to avoid tying up database resources.

Calling the method close on a EnhancedPreparedStatement object that is already closed has no effect.

Specified by:

close in interface AutoCloseable

Note:

• When a EnhancedPreparedStatement instance is closed, its current ResultSet instance, if one exists, is also closed.

Throws:

SQLException - A database access error occurred.

closeOnCompletion

void closeOnCompletion()
                throws SQLException

Specifies that this EnhancedPreparedStatement will be closed when all its dependent result sets are closed. If the execution of the EnhancedPreparedStatement does not produce any result sets, this method has no effect.

Note:

• Multiple calls to closeOnCompletion() do not toggle the effect on this EnhancedPreparedStatement. However, a call to closeOnCompletion() does affect both the subsequent execution of statements, and statements that currently have open, dependent, result sets.

Throws:

SQLException - This method was called on a closed EnhancedPreparedStatement.

enableLogging

static void enableLogging(EnhancedPreparedStatement.StatementLogger logger,
 BooleanSupplier logCheck,
 boolean addStacktrace)

Enables the logging output for the EnhancedPreparedStatement instances.

The logger method takes three arguments:

1. operation – The name of the operation that logs.
2. statement – The source of the prepared statement.
3. values – A list of the values in the format

   <name> [<type>]:<value>

   A type of NULL indicates an unknown type; for large values (like Blob or Reader) only the class is given instead of the real value.
4. stacktrace – The stacktrace; will be null if addStacktrace is false.

The logCheck method returns true only when logging should be done. No information is collected while it returns false. As the method is called for nearly any operation, its implementation should be as efficient as possible.

Parameters:

logger - The method that takes the logging information.

logCheck - The method that returns a flag whether log output is desired.

addStacktrace - true if the stacktrace should be added to the log output.

enquoteIdentifier

String enquoteIdentifier(String identifier,
 boolean alwaysQuote)
                  throws SQLException

Returns a SQL identifier. If identifier is a simple SQL identifier:

• Return the original value if alwaysQuote is false
• Return a delimited identifier if alwaysQuote is true

If identifier is not a simple SQL identifier, identifier will be enclosed in double quotes if not already present. If the datasource does not support double quotes for delimited identifiers, the identifier should be enclosed by the string returned from DatabaseMetaData.getIdentifierQuoteString(). If the datasource does not support delimited identifiers, a SQLFeatureNotSupportedException should be thrown.

A SQLException will be thrown if identifier contains any characters invalid in a delimited identifier or the identifier length is invalid for the datasource.

Parameters:

identifier - An SQL identifier.

alwaysQuote - Indicates if a simple SQL identifier should be returned as a quoted identifier.

Returns:

A simple SQL identifier or a delimited identifier

Throws:

SQLException - The identifier was not a valid identifier.

SQLFeatureNotSupportedException - The datasource does not support delimited identifiers.

NullPointerException - The identifier was null.

enquoteLiteral

String enquoteLiteral(String value)
               throws SQLException

Returns a String enclosed in single quotes. Any occurrence of a single quote within the string will be replaced by two single quotes.

Examples of the conversion:

Value	Result
Hello	'Hello'
G'Day	'G''Day'
'G''Day'	'''G''''Day'''
I'''M	'I''''''M'

Parameters:

value - A character String.

Returns:

A string enclosed by single quotes with every single quote converted to two single quotes

Throws:

NullPointerException - The value argument was null.

SQLException - A database access error occurred.

enquoteNCharLiteral

String enquoteNCharLiteral(String s)
                    throws SQLException

Returns a String representing a National Character Set Literal enclosed in single quotes and prefixed with a upper case letter N. Any occurrence of a single quote within the string will be replaced by two single quotes.

Examples of the conversion:

Value	Result
Hello	N'Hello'
G'Day	N'G''Day'
'G''Day'	N'''G''''Day'''
I'''M	N'I''''''M'
N'Hello'	N'N''Hello'''

Parameters:

s - A character string

Returns:

The result of replacing every single quote character in the argument by two single quote characters where this entire result is then prefixed with 'N'.

Throws:

SQLException - A database access error occurred.

See Also:

• Statement.enquoteNCharLiteral(String)

execute

boolean execute()
         throws SQLException

Executes the SQL statement in this PreparedStatement object, which may be any kind of SQL statement.

Some prepared statements return multiple results; the execute() method handles these complex statements as well as the simpler form of statements handled by the methods executeQuery() and executeUpdate().

The execute() method returns a boolean to indicate the form of the first result. You must call either the method getResultSet() or getUpdateCount() to retrieve the result; you must call getMoreResults() to move to any subsequent result(s).

Returns:

true if the first result is a ResultSet instance; false if the first result is an update count or there is no result.

Throws:

SQLException - A database access error occurred, this method was called on a closed EnhancedPreparedStatement or no argument was supplied for at least one parameter.

SQLTimeoutException - The driver determined that the timeout value that was specified by the setQueryTimeout(int) method has been exceeded and has at least attempted to cancel the currently running Statement.

See Also:

• Statement.execute(java.lang.String)
• getResultSet()
• getUpdateCount()
• getMoreResults()

executeBatch

int[] executeBatch()
            throws SQLException

Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts. The int elements of the array that is returned are ordered to correspond to the commands in the batch, which are ordered according to the order in which they were added to the batch.

The elements in the array returned by the method executeBatch() may be one of the following:

1. A number greater than or equal to zero – indicates that the command was processed successfully and is an update count giving the number of rows in the database that were affected by the command's execution.
2. A value of Statement.SUCCESS_NO_INFO (-2 – indicates that the command was processed successfully but that the number of rows affected is unknown.

If one of the commands in a batch update fails to execute properly, this method throws a BatchUpdateException, and a JDBC driver may or may not continue to process the remaining commands in the batch. However, the driver's behaviour must be consistent with a particular DBMS, either always continuing to process commands or never continuing to process commands. If the driver continues processing after a failure, the array returned by the method BatchUpdateException.getUpdateCounts() will contain as many elements as there are commands in the batch, and at least one of the elements will be Statement.EXECUTE_FAILED (-3 – indicating that the command failed to execute successfully); it occurs only if a driver continues to process commands after a command failed.

Note:

• The possible implementations and return values have been modified in the Java 2 SDK, Standard Edition, version 1.3 to accommodate the option of continuing to process commands in a batch update after a BatchUpdateException object has been thrown.

Returns:

An array of update counts containing one element for each command in the batch. The elements of the array are ordered according to the order in which commands were added to the batch.

Throws:

SQLException - A database access error occurred, this method was called on a closed EnhancedPreparedStatement or the driver does not support batch statements.

BatchUpdateException - One of the commands sent to the database failed to execute properly or attempts to return a result set.

SQLTimeoutException - The driver determined that the timeout value that was specified by a call to setQueryTimeout(int) was exceeded and at least attempted to cancel the currently running statement.

See Also:

• addBatch()
• DatabaseMetaData.supportsBatchUpdates()

executeLargeBatch

long[] executeLargeBatch()
                  throws SQLException

Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts. The int elements of the array that is returned are ordered to correspond to the commands in the batch, which are ordered according to the order in which they were added to the batch.

The elements in the array returned by the method executeBatch() may be one of the following:

1. A number greater than or equal to zero – indicates that the command was processed successfully and is an update count giving the number of rows in the database that were affected by the command's execution.
2. A value of Statement.SUCCESS_NO_INFO (-2 – indicates that the command was processed successfully but that the number of rows affected is unknown.

If one of the commands in a batch update fails to execute properly, this method throws a BatchUpdateException, and a JDBC driver may or may not continue to process the remaining commands in the batch. However, the driver's behaviour must be consistent with a particular DBMS, either always continuing to process commands or never continuing to process commands. If the driver continues processing after a failure, the array returned by the method BatchUpdateException.getLargeUpdateCounts() will contain as many elements as there are commands in the batch, and at least one of the elements will be Statement.EXECUTE_FAILED (-3 – indicating that the command failed to execute successfully); it occurs only if a driver continues to process commands after a command failed.

This method should be used when the returned row count may exceed Integer.MAX_VALUE.

Returns:

An array of update counts containing one element for each command in the batch. The elements of the array are ordered according to the order in which commands were added to the batch.

Throws:

SQLException - A database access error occurred, this method was called on a closed EnhancedPreparedStatement or the driver does not support batch statements.

BatchUpdateException - One of the commands sent to the database failed to execute properly or attempts to return a result set.

SQLTimeoutException - The driver determined that the timeout value that was specified by a call to setQueryTimeout(int) was exceeded and at least attempted to cancel the currently running statement.

See Also:

• addBatch()
• executeBatch()
• Statement.executeLargeBatch()
• DatabaseMetaData.supportsBatchUpdates()

executeLargeUpdate

long executeLargeUpdate()
                 throws SQLException

Executes the SQL statement in this EnhancedPreparedStatement instance. It must be an SQL Data Manipulation Language (DML) statement, such as INSERT, UPDATE or DELETE; or an SQL statement that returns nothing, such as a DDL statement.

This method should be used when the returned row count may exceed Integer.MAX_VALUE.

The default implementation will throw UnsupportedOperationException.

Returns:

Either the row count for SQL Data Manipulation Language (DML) statements or 0 for SQL statements that return nothing.

Throws:

SQLException - A database access error occurred, this method was called on a closed EnhancedPreparedStatement or the SQL statement returns a ResultSet object.

SQLTimeoutException - The driver determined that the timeout value that was specified by the setQueryTimeout(int) method has been exceeded and has at least attempted to cancel the currently running Statement.

executeQuery

ResultSet executeQuery()
                throws SQLException

Executes the SQL query in this PreparedStatement object and returns the ResultSet object generated by the query.

Returns:

A ResultSet instance that contains the data produced by the query; never null.

Throws:

SQLException - A database access error occurred, this method was called on a closed EnhancedPreparedStatement or the SQL statement did not return a ResultSet object.

SQLTimeoutException - The driver determined that the timeout value that was specified by the setQueryTimeout(int) method has been exceeded and has at least attempted to cancel the currently running Statement.

executeUpdate

int executeUpdate()
           throws SQLException

Executes the SQL statement in this EnhancedPreparedStatement instance. It must be an SQL Data Manipulation Language (DML) statement, such as INSERT, UPDATE or DELETE; or an SQL statement that returns nothing, such as a DDL statement.

Returns:

Either the row count for SQL Data Manipulation Language (DML) statements or 0 for SQL statements that return nothing.

Throws:

SQLException - A database access error occurred, this method was called on a closed EnhancedPreparedStatement or the SQL statement returns a ResultSet object.

SQLTimeoutException - The driver determined that the timeout value that was specified by the setQueryTimeout(int) method has been exceeded and has at least attempted to cancel the currently running Statement.

getConnection

Connection getConnection()
                  throws SQLException

Retrieves the Connection instance that produced the PreparedStatement instance wrapped by this EnhancedPreparedStatement.

Returns:

The connection that produced the wrapped prepared statement.

Throws:

SQLException - A database access error occurred or this method was called on a closed EnhancedPreparedStatement.

getFetchDirection

int getFetchDirection()
               throws SQLException

Retrieves the direction for fetching rows from database tables that is the default for result sets generated from this EnhancedPreparedStatement instance.

If this EnhancedPreparedStatement instance has not set a fetch direction by calling the method setFetchDirection(int), the return value is implementation-specific.

Returns:

The default fetch direction for result sets generated from this EnhancedPreparedStatement instance.

Throws:

SQLException - A database access error occurred or this method was called on a closed EnhancedPreparedStatement.

See Also:

• setFetchDirection(int)

getFetchSize

int getFetchSize()
          throws SQLException

Retrieves the number of result set rows that is the default fetch size for ResultSet instances generated from this EnhancedPreparedStatement instance. If this statement instance has not set a fetch size by calling the method setFetchSize(int), the return value is implementation-specific.

Returns:

The default fetch size for result sets generated from this EnhancedPreparedStatement instance.

Throws:

SQLException - A database access error occurred or this method was called on a closed EnhancedPreparedStatement.

See Also:

• setFetchSize(int)

getGeneratedKeys

ResultSet getGeneratedKeys()
                    throws SQLException

Retrieves any auto-generated keys created as a result of executing this EnhancedPreparedStatement instance. If this statement did not generate any keys, an empty ResultSet object is returned.

Note:

• If the columns which represent the auto-generated keys were not specified, the JDBC driver implementation will determine the columns which best represent the auto-generated keys.

Returns:

A ResultSet instance containing the auto-generated key(s) generated by the execution of this EnhancedPreparedStatement instance.

Throws:

SQLException - A database access error occurred or this method was called on a closed Statement.

SQLFeatureNotSupportedException - The JDBC driver does not support this method.

getLargeMaxRows

long getLargeMaxRows()
              throws SQLException

Retrieves the maximum number of rows that a ResultSet instance produced by this EnhancedPreparedStatement instance can contain. If this limit is exceeded, the excess rows are silently dropped.

This method should be used when the returned row limit may exceed Integer.MAX_VALUE.

The default implementation will return 0.

Returns:

The current maximum number of rows for a ResultSet instance produced by this EnhancedPreparedStatement instance; zero means there is no limit, or that the method is not supported by the JDBC driver.

Throws:

SQLException - A database access error occurred or this method was called on a closed EnhancedPreparedStatement.

See Also:

• getMaxRows()
• setMaxRows(int)
• setLargeMaxRows(long)

getLargeUpdateCount

long getLargeUpdateCount()
                  throws SQLException

Retrieves the current result as an update count. If the result is a ResultSet object or there are no more results, -1 is returned.

This method should be used when the returned row count may exceed Integer.MAX_VALUE.

The default implementation will throw UnsupportedOperationException

Returns:

The current result as an update count; -1 if the current result is a ResultSet object or there are no more results.

Throws:

SQLException - A database access error occurred or this method was called on a closed EnhancedPreparedStatement.

See Also:

• execute()

getMaxFieldSize

int getMaxFieldSize()
             throws SQLException

Retrieves the maximum number of bytes that can be returned for character and binary column values in a ResultSet object produced by this EnhancedPreparedStatement object.

This limit applies only to JDBCType.BINARY, JDBCType.VARBINARY, JDBCType.LONGVARBINARY, JDBCType.CHAR, JDBCType.VARCHAR, JDBCType.NCHAR, JDBCType.NVARCHAR, JDBCType.LONGNVARCHAR and JDBCType.LONGVARCHAR columns. If the limit is exceeded, the excess data is silently discarded.

Returns:

The current column size limit for columns storing character and binary values; zero means there is no limit.

Throws:

SQLException - A database access error occurred or this method was called on a closed EnhancedPreparedStatement

See Also:

• setMaxFieldSize(int)

getMaxRows

int getMaxRows()
        throws SQLException

Retrieves the maximum number of rows that a ResultSet instance produced by this EnhancedPreparedStatement instance can contain. If this limit is exceeded, the excess rows are silently dropped.

Returns:

The current maximum number of rows for a ResultSet instance produced by this EnhancedPreparedStatement instance; zero means there is no limit.

Throws:

SQLException - A database access error occurred or this method was called on a closed EnhancedPreparedStatement.

See Also:

• getLargeMaxRows()
• setMaxRows(int)
• setLargeMaxRows(long)

getMetaData

ResultSetMetaData getMetaData()
                       throws SQLException

Retrieves a ResultSetMetaData object that contains information about the columns of the ResultSet instance that will be returned when this EnhancedPreparedStatement instance is executed.

Because the PreparedStatement that is wrapped by this EnhancedPreparedStatement is precompiled, it is possible to know about the ResultSet object that it will return without having to execute it. Consequently, it is possible to invoke the method getMetaData() on a EnhancedPreparedStatement instance rather than waiting to execute it and then invoking the ResultSet.getMetaData() method on the ResultSet instance that is returned.

Note:

• Using this method may be expensive for some drivers due to the lack of underlying DBMS support.

Returns:

The description of a ResultSet object's columns or null if the driver cannot return a ResultSetMetaData object.

Throws:

SQLException - A database access error occurred or this method was called on a closed PreparedStatement.

SQLFeatureNotSupportedException - The JDBC driver does not support this method.

getMoreResults

boolean getMoreResults()
                throws SQLException

Moves to this EnhancedPreparedStatement instance's next result, returns true if it is a ResultSet instance, and implicitly closes any current ResultSet instance(s) previously obtained with the method getResultSet().

There are no more results when the following is true:

     // stmt is a EnhancedPreparedStatement object
     ((stmt.getMoreResults() == false) && (stmt.getUpdateCount() == -1))
  

Returns:

true if the next result is a ResultSet instance; false if it is an update count or there are no more results.

Throws:

SQLException - A database access error occurred or this method was called on a closed EnhancedPreparedStatement.

See Also:

• execute()

getMoreResults

boolean getMoreResults(int current)
                throws SQLException

Moves to this EnhancedPreparedStatement instance's next result, deals with any current ResultSet instance(s) according to the instructions specified by the given flag, and returns true if the next result is a ResultSet object.

There are no more results when the following is true:

     // stmt is a Statement object
     ((stmt.getMoreResults( current ) == false) && (stmt.getUpdateCount() == -1))
  

Parameters:

current - One of the following Statement constants indicating what should happen to current ResultSet instances obtained using the method getResultSet(): Statement.CLOSE_CURRENT_RESULT, Statement.KEEP_CURRENT_RESULT, or Statement.CLOSE_ALL_RESULTS.

Returns:

true if the next result is a ResultSet instance, false if it is an update count or there are no more results

Throws:

SQLException - A database access error occurred, this method was called on a closed EnhancedPreparedStatement or the argument supplied is not one of the following: Statement.CLOSE_CURRENT_RESULT, Statement.KEEP_CURRENT_RESULT, or Statement.CLOSE_ALL_RESULTS.

SQLFeatureNotSupportedException - DatabaseMetaData.supportsMultipleOpenResults() returned false and either Statement.KEEP_CURRENT_RESULT or Statement.CLOSE_ALL_RESULTS are supplied as the argument.

See Also:

• execute()
• getMoreResults()

getParameterMetaData

ParameterMetaData getParameterMetaData()
                                throws SQLException

Retrieves the number, types and properties of this EnhancedPreparedStatement instance's parameters.

Returns:

An instance of ParameterMetaData that contains information about the number, types and properties for each named parameter of this EnhancedPreparedStatement instance.

Throws:

SQLException - A database access error occurred or this method was called on a closed EnhancedPreparedStatement.

See Also:

• ParameterMetaData
• ParameterMetaData

getQueryTimeout

int getQueryTimeout()
             throws SQLException

Retrieves the number of seconds the driver will wait for a Statement instance to execute. If the limit is exceeded, a SQLTimeoutException is thrown.

Returns:

The current query timeout limit in seconds; zero means there is no limit.

Throws:

SQLException - A database access error occurred or this method was called on a closed EnhancedPreparedStatement.

See Also:

• setQueryTimeout(int)

getResultSet

ResultSet getResultSet()
                throws SQLException

Retrieves the current result as a ResultSet instance.

Note:

• This method should be called only once per result.

Returns:

The current result as a ResultSet instance or null if the result is an update count or there are no more results.

Throws:

SQLException - A database access error occurred or this method was called on a closed EnhancedPreparedStatement.

See Also:

• execute()

getResultSetConcurrency

int getResultSetConcurrency()
                     throws SQLException

Retrieves the result set concurrency for ResultSet instances generated by this EnhancedPreparedStatement instance.

Returns:

Either ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE.

Throws:

SQLException - A database access error occurred or this method was called on a closed EnhancedPreparedStatement.

getResultSetHoldability

int getResultSetHoldability()
                     throws SQLException

Retrieves the result set holdability for ResultSet instances generated by this EnhancedPreparedStatement instance.

Returns:

Either ResultSet.HOLD_CURSORS_OVER_COMMIT (1) or ResultSet.CLOSE_CURSORS_AT_COMMIT (2).

Throws:

SQLException - A database access error occurred or this method was called on a closed EnhancedPreparedStatement.

getResultSetType

int getResultSetType()
              throws SQLException

Retrieves the result set type for ResultSet instances generated by this EnhancedPreparedStatement instance.

Returns:

One of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE.

Throws:

SQLException - A database access error occurred or this method was called on a closed EnhancedPreparedStatement.

getUpdateCount

int getUpdateCount()
            throws SQLException

Retrieves the current result as an update count. If the result is a ResultSet object or there are no more results, -1 is returned.

Note:

• This method should be called only once per result.

Returns:

The current result as an update count; -1 if the current result is a ResultSet object or there are no more results.

Throws:

SQLException - A database access error occurred or this method was called on a closed EnhancedPreparedStatement.

See Also:

• execute()

getWarnings

SQLWarning getWarnings()
                throws SQLException

Retrieves the first warning reported by calls on this EnhancedPreparedStatement instance. Subsequent warnings regarding the execution of this instance will be chained to this SQLWarning instance

.

The warning chain is automatically cleared each time a statement is (re)executed. This method may not be called on a closed EnhancedPreparedStatement instance; doing so will cause an SQLException to be thrown.

Note:

• If you are processing a ResultSet instance, any warnings associated with reads on that ResultSet instance will be chained on it rather than on the statement instance that produced it.

Returns:

The first SQLWarning object or null if there are no warnings.

Throws:

SQLException - A database access error occurred or this method was called on a closed EnhancedPreparedStatement.

See Also:

• clearWarnings()

isClosed

boolean isClosed()
          throws SQLException

Retrieves whether this EnhancedPreparedStatement object has been closed. An EnhancedPreparedStatement is closed if the method close() has been called on it, or if it is automatically closed.

Returns:

true if this EnhancedPreparedStatement object is closed; false if it is still open.

Throws:

SQLException - A database access error occurred.

isCloseOnCompletion

boolean isCloseOnCompletion()
                     throws SQLException

Returns a value indicating whether this EnhancedPreparedStatement will be closed when all its dependent result sets are closed.

Returns:

true if this EnhancedPreparedStatement will be closed when all of its dependent result sets are closed, false otherwise.

Throws:

SQLException - This method was called on a closed EnhancedPreparedStatement.

isLoggingEnabled

boolean isLoggingEnabled()

Checks whether logging is currently enabled.

Returns:

true if logging is enabled and log information have to be collected, false otherwise.

isPoolable

boolean isPoolable()
            throws SQLException

Returns a value indicating whether the wrapped PreparedStatement is poolable or not.

Returns:

true if the PreparedStatement is poolable, false otherwise

Throws:

SQLException - This method was called on a closed EnhancedPreparedStatement

See Also:

• setPoolable(boolean)

isSimpleIdentifier

boolean isSimpleIdentifier(String identifier)
                    throws SQLException

Retrieves whether identifier is a simple SQL identifier.

Parameters:

identifier - An SQL identifier

Returns:

true if the given value is a simple SQL identifier, false otherwise

Throws:

SQLException - A database access error occurred.

prepareStatement

@API(status=STABLE,
     since="0.1.0")
static EnhancedPreparedStatement prepareStatement(Connection connection,
 String sql)
                                           throws SQLException

Creates a new EnhancedPreparedStatement instance.

The text for the SQL statement is different from the format that is used by Connection.prepareStatement(String) to create an instance of PreparedStatement: this format uses explicit names instead of simple question marks as placeholders. This means, instead of

SELECT value FROM table WHERE key = ?

one will write

SELECT value FROM table WHERE key = :key

This allows to address the variables by name, and it makes it possible that the same value is only provided once, despite it occurs multiple time.

A parameter name is prefixed by a colon, followed by an ASCII letter, then by an arbitrary number of ASCII letters and digits. No special characters are allowed.

Parameters:

connection - The connection to the database.

sql - The text of the SQL statement with the placeholders.

Returns:

The new statement.

Throws:

SQLException - A database access error occurred, or the given statement could not be parsed properly.

setArray

void setArray(String parameterName,
 Array value)
       throws SQLException

Sets the designated parameter to the given Array instance.

The driver converts this to an SQL ARRAY value when it sends it to the database.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The parameter value.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

SQLFeatureNotSupportedException - The JDBC driver does not support this method

setAsciiStream

void setAsciiStream(String parameterName,
 InputStream value,
 int length)
             throws SQLException

Sets the designated parameter to the given InputStream which will have the specified number of bytes.

When a very large ASCII value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.InputStream. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.

Note:

• This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The parameter value.

length - The number of bytes in the stream.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

setAsciiStream

void setAsciiStream(String parameterName,
 InputStream value,
 long length)
             throws SQLException

Sets the designated parameter to the given InputStream which will have the specified number of bytes.

When a very large ASCII value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.InputStream. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.

Note:

• This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The parameter value.

length - The number of bytes in the stream.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

setAsciiStream

void setAsciiStream(String parameterName,
 InputStream value)
             throws SQLException

Sets the designated parameter to the given InputStream.

When a very large ASCII value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.InputStream. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.

Notes:

• This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
• Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setAsciiStream() which takes a length parameter.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The parameter value.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

SQLFeatureNotSupportedException - The JDBC driver does not support this method.

setBinaryStream

void setBinaryStream(String parameterName,
 InputStream value,
 int length)
              throws SQLException

Sets the designated parameter to the given InputStream which will have the specified number of bytes.

When a very large binary value is input to a LONGVARBINARY parameter, it may be more practical to send it via a java.io.InputStream. The data will be read from the stream as needed until end-of-file is reached.

Note:

• This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The parameter value.

length - The number of bytes in the stream.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

setBinaryStream

void setBinaryStream(String parameterName,
 InputStream value,
 long length)
              throws SQLException

Sets the designated parameter to the given InputStream which will have the specified number of bytes.

When a very large binary value is input to a LONGVARBINARY parameter, it may be more practical to send it via a java.io.InputStream. The data will be read from the stream as needed until end-of-file is reached.

Note:

• This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The parameter value.

length - The number of bytes in the stream.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

setBinaryStream

void setBinaryStream(String parameterName,
 InputStream value)
              throws SQLException

Sets the designated parameter to the given InputStream.

When a very large binary value is input to a LONGVARBINARY parameter, it may be more practical to send it via a java.io.InputStream. The data will be read from the stream as needed until end-of-file is reached.

Notes:

• This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
• Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setBinaryStream() which takes a length parameter.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The parameter value.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

SQLFeatureNotSupportedException - The JDBC driver does not support this method.

setBigDecimal

void setBigDecimal(String parameterName,
 BigDecimal value)
            throws SQLException

Sets the designated parameter to the given Java BigDecimal value.

The driver converts this to an SQL NUMERIC value when it sends it to the database.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The parameter value.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

setBlob

void setBlob(String parameterName,
 Blob value)
      throws SQLException

Sets the designated parameter to the given Java Blob instance.

The driver converts this to an SQL BLOB value when it sends it to the database.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The parameter value.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

SQLFeatureNotSupportedException - The JDBC driver does not support this method.

setBlob

void setBlob(String parameterName,
 InputStream value,
 long length)
      throws SQLException

Sets the designated parameter to a InputStream object. The InputStream must contain the number of characters as specified by the length argument, otherwise a SQLException will be generated when the EnhancedPreparedStatement is executed.

This method differs from the (String,InputStream,int) method because it informs the driver that the parameter value should be sent to the server as a BLOB. When the setBinaryStream() method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGVARBINARY or a BLOB.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The InputStream instance that contains the data to set the parameter value to.

length - The number of bytes in the parameter data.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred, this method was called on a closed EnhancedPreparedStatement, the specified length was less than zero or if the number of bytes in the InputStream did not match the specified length.

SQLFeatureNotSupportedException - The JDBC driver does not support this method.

setBlob

void setBlob(String parameterName,
 InputStream value)
      throws SQLException

Sets the designated parameter to a InputStream object.

This method differs from the (String,InputStream,int) method because it informs the driver that the parameter value should be sent to the server as a BLOB. When the setBinaryStream() method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGVARBINARY or a BLOB.

Note:

• Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setBlob() which takes a length parameter.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The InputStream instance that contains the data to set the parameter value to.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred, or this method was called on a closed EnhancedPreparedStatement.

SQLFeatureNotSupportedException - The JDBC driver does not support this method.

setBoolean

void setBoolean(String parameterName,
 boolean value)
         throws SQLException

Sets the designated parameter to the given Java boolean value.

The driver converts this to an SQL BIT or BOOLEAN value when it sends it to the database.

For the logging, it is always BOOLEAN.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The parameter value.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

setByte

void setByte(String parameterName,
 byte value)
      throws SQLException

Sets the designated parameter to the given Java byte value.

The driver converts this to an SQL TINYINT value when it sends it to the database.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The parameter value.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

setBytes

void setBytes(String parameterName,
 byte[] value)
       throws SQLException

Sets the designated parameter to the given Java array of bytes.

The driver converts this to an SQL VARBINARY or LONGVARBINARY (depending on the argument's size relative to the driver's limits on VARBINARY values) when it sends it to the database.

For the logging, it is always VARBINARY.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The parameter value.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

setCharacterStream

void setCharacterStream(String parameterName,
 Reader value,
 int length)
                 throws SQLException

Sets the designated parameter to the given Reader instance, which provides the given number of characters.

When a very large UNICODE value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.Reader instance. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The java.io.Reader object that contains the Unicode data.

length - The number of characters in the stream.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

setCharacterStream

void setCharacterStream(String parameterName,
 Reader value,
 long length)
                 throws SQLException

Sets the designated parameter to the given Reader instance, which provides the given number of characters.

When a very large UNICODE value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.Reader instance. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The java.io.Reader object that contains the Unicode data.

length - The number of characters in the stream.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

setCharacterStream

void setCharacterStream(String parameterName,
 Reader value)
                 throws SQLException

Sets the designated parameter to the given Reader instance.

When a very large UNICODE value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.Reader instance. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.

Notes:

• This reader object can either be a standard Java Reader object or your own subclass that implements the standard interface.
• Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setCharacterStream() which takes a length parameter.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The java.io.Reader object that contains the Unicode data.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

SQLFeatureNotSupportedException - The JDBC driver does not support this method.

setClob

void setClob(String parameterName,
 Clob value)
      throws SQLException

Sets the designated parameter to the given Clob instance.

The driver converts this to an SQL CLOB value when it sends it to the database.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The parameter value.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

SQLFeatureNotSupportedException - The JDBC driver does not support this method

setClob

void setClob(String parameterName,
 Reader value,
 long length)
      throws SQLException

Sets the designated parameter to a Reader instance. The reader must contain the number of characters specified by the length argument, otherwise a SQLException will be generated when the EnhancedPreparedStatement is executed.

This method differs from the setCharacterStream(String,Reader,int) method because it informs the driver that the parameter value should be sent to the server as a CLOB. When the setCharacterStream() method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGVARCHAR or a CLOB.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The java.io.Reader object that contains the data to set the parameter value to.

length - The number of characters in the stream.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement, the Reader was shorter than specified, or the specified length was less than zero.

SQLFeatureNotSupportedException - The JDBC driver does not support this method.

setClob

void setClob(String parameterName,
 Reader value)
      throws SQLException

Sets the designated parameter to a Reader instance.

This method differs from the setCharacterStream(String,Reader,int) method because it informs the driver that the parameter value should be sent to the server as a CLOB. When the setCharacterStream() method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGVARCHAR or a CLOB.

Note:

• Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setClob() which takes a length parameter.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The java.io.Reader object that contains the data to set the parameter value to.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

SQLFeatureNotSupportedException - The JDBC driver does not support this method.

setCursorName

void setCursorName(String name)
            throws SQLException

Sets the SQL cursor name to the given String, which will be used by subsequent statement execute() methods. This name can then be used in SQL positioned update or delete statements to identify the current row in the ResultSet instance generated by this statement. If the database does not support positioned update/delete, this method is a noop. To ensure that a cursor has the proper isolation level to support updates, the cursor's SELECT statement should have the form SELECT FOR UPDATE. If FOR UPDATE is not present, positioned updates may fail.

Note:

• By definition, the execution of positioned updates and deletes must be done by a different statement instances than the one that generated the ResultSet object being used for positioning. Also, cursor names must be unique within a connection.

Parameters:

name - The new cursor name, which must be unique within a connection.

Throws:

SQLException - A database access error occurred or this method was called on a closed EnhancedPreparedStatement.

SQLFeatureNotSupportedException - The JDBC driver does not support this method.

setDate

void setDate(String parameterName,
 Date value)
      throws SQLException

Sets the designated parameter to the given Date value using the default time zone of the virtual machine that is running the application.

The driver converts this to an SQL DATE value when it sends it to the database.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The parameter value.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

setDate

void setDate(String parameterName,
 Date value,
 Calendar calendar)
      throws SQLException

Sets the designated parameter to the given Date value using the given Calendar instance. The driver used the Calendar instance to construct an SQL DATE value, which the driver then sends to the database. With the Calendar instance, the driver can calculate the date taking into account a custom timezone. If no Calendar instance is specified, the driver uses the default timezone, which is that of the virtual machine running the application.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The parameter value.

calendar - The Calendar instance the driver will use to construct the date.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

setDouble

void setDouble(String parameterName,
 double value)
        throws SQLException

Sets the designated parameter to the given Java double value.

The driver converts this to an SQL DOUBLE value when it sends it to the database.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The parameter value.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

setFetchDirection

void setFetchDirection(int direction)
                throws SQLException

Gives the driver a hint as to the direction in which rows will be processed in ResultSet instances created using this EnhancedPreparedStatement object. The default value is ResultSet.FETCH_FORWARD.

Note that this method sets only the default fetch direction for result sets generated by this EnhancedPreparedStatement instance. Each result set has its own methods for getting and setting its own fetch direction.

Parameters:

direction - The initial direction for processing rows.

Throws:

SQLException - A database access error occurred, this method was called on a closed EnhancedPreparedStatement or the given direction is not one of ResultSet.FETCH_FORWARD, ResultSet.FETCH_REVERSE, or ResultSet.FETCH_UNKNOWN

See Also:

• getFetchDirection()
• ResultSet.setFetchDirection(int)
• ResultSet.getFetchDirection()

setFetchSize

void setFetchSize(int rows)
           throws SQLException

Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed for ResultSet instances generated by this EnhancedPreparedStatement instance. If the specified value is zero, then the hint is ignored.

The default value is zero.

Parameters:

rows - The number of rows to fetch.

Throws:

SQLException - A database access error occurred, this method was called on a closed EnhancedPreparedStatement or the condition rows >= 0 was not satisfied.

setFloat

void setFloat(String parameterName,
 float value)
       throws SQLException

Sets the designated parameter to the given Java float value.

The driver converts this to an SQL REAL value when it sends it to the database.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The parameter value.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

setInt

void setInt(String parameterName,
 int value)
     throws SQLException

Sets the designated parameter to the given Java int value.

The driver converts this to an SQL INTEGER value when it sends it to the database.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The parameter value.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

setLargeMaxRows

void setLargeMaxRows(long max)
              throws SQLException

Sets the limit for the maximum number of rows that any ResultSet instance generated by this EnhancedPreparedStatement instance can contain. If the limit is exceeded, the excess rows are silently dropped.

This method should be used when the row limit may exceed Integer.MAX_VALUE.

The default implementation will throw UnsupportedOperationException.

Parameters:

max - The new max rows limit; zero means there is no limit.

Throws:

SQLException - A database access error occurred, this method was called on a closed EnhancedPreparedStatement or the condition max >= 0 is not satisfied.

See Also:

• setMaxRows(int)
• getMaxRows()
• getLargeMaxRows()

setLong

void setLong(String parameterName,
 long value)
      throws SQLException

Sets the designated parameter to the given Java long value.

The driver converts this to an SQL BIGINT value when it sends it to the database.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The parameter value.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

setMaxFieldSize

void setMaxFieldSize(int max)
              throws SQLException

Sets the limit for the maximum number of bytes that can be returned for character and binary column values in a ResultSet object produced by this Statement object.

This limit applies only to JDBCType.BINARY, JDBCType.VARBINARY, JDBCType.LONGVARBINARY, JDBCType.CHAR, JDBCType.VARCHAR, JDBCType.NCHAR, JDBCType.NVARCHAR, JDBCType.LONGNVARCHAR and JDBCType.LONGVARCHAR columns. If the limit is exceeded, the excess data is silently discarded. For maximum portability, use values greater than 256.

Parameters:

max - The new column size limit in bytes; zero means there is no limit.

Throws:

SQLException - A database access error occurred, this method was called on a closed EnhancedPreparedStatement or the condition max >= 0 is not satisfied.

See Also:

• getMaxFieldSize()

setMaxRows

void setMaxRows(int max)
         throws SQLException

Sets the limit for the maximum number of rows, that any ResultSet instance generated by this EnhancedPreparedStatement instance can contain, to the given number. If the limit is exceeded, the excess rows are silently dropped.

Parameters:

max - The new max rows limit; zero means there is no limit.

Throws:

SQLException - A database access error occurred, this method was called on a closed EnhancedPreparedStatement or the condition max >= 0 was not satisfied.

See Also:

• getMaxRows()
• getLargeMaxRows()
• setLargeMaxRows(long)

setNCharacterStream

void setNCharacterStream(String parameterName,
 Reader value,
 long length)
                  throws SQLException

Sets the designated parameter to the given Reader instance.

The Reader reads the data till end-of-file is reached. The driver does the necessary conversion from Java character format to the national character set in the database.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The java.io.Reader object that contains the data.

length - The number of characters in the stream.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, the driver does not support national character sets, the driver detected that a data conversion error could occur, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

SQLFeatureNotSupportedException - The JDBC driver does not support this method,

setNCharacterStream

void setNCharacterStream(String parameterName,
 Reader value)
                  throws SQLException

Sets the designated parameter to the given Reader instance.

The Reader reads the data till end-of-file is reached. The driver does the necessary conversion from Java character format to the national character set in the database.

Notes:

• This reader object can either be a standard Java Reader object or your own subclass that implements the standard interface.
• Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setNCharacterStream() which takes a length parameter.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The java.io.Reader object that contains the data.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, the driver does not support national character sets, the driver detected that a data conversion error could occur, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

SQLFeatureNotSupportedException - The JDBC driver does not support this method,

setNClob

void setNClob(String parameterName,
 NClob value)
       throws SQLException

Sets the designated parameter to the given NClob value.

The driver converts this to an SQL NCLOB value when it sends it to the database.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The parameter value.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, the driver does not support national character sets, the driver detected that a data conversion error could occur, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

SQLFeatureNotSupportedException - The JDBC driver does not support this method,

setNClob

void setNClob(String parameterName,
 Reader value,
 long length)
       throws SQLException

Sets the designated parameter to a Reader instance. The reader must contain the number of characters specified by the length argument, otherwise a SQLException will be generated when the EnhancedPreparedStatement is executed.

This method differs from the setNCharacterStream(String,Reader,long) method because it informs the driver that the parameter value should be sent to the server as a NCLOB. When the setNCharacterStream() method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGNVARCHAR or a NCLOB.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The java.io.Reader object that contains the data to set the parameter value to.

length - The number of characters in the stream.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement, the Reader was shorter than specified, or the specified length was less than zero.

SQLFeatureNotSupportedException - The JDBC driver does not support this method.

setNClob

void setNClob(String parameterName,
 Reader value)
       throws SQLException

Sets the designated parameter to a Reader instance.

This method differs from the setNCharacterStream(String,Reader,long) method because it informs the driver that the parameter value should be sent to the server as a NCLOB. When the setNCharacterStream() method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGNVARCHAR or a NCLOB.

Note:

• Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setNClob() which takes a length parameter.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The java.io.Reader object that contains the data to set the parameter value to.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

SQLFeatureNotSupportedException - The JDBC driver does not support this method.

setNString

void setNString(String parameterName,
 String value)
         throws SQLException

Sets the designated parameter to the given Java String value.

The driver converts this to an SQL NCHAR, NVARCHAR, or LONGNVARCHAR value (depending on the argument's size relative to the driver's limits on NVARCHAR values)when it sends it to the database.

For the logging, it is always NCHAR.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The parameter value.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, the driver does not support national character sets, the driver detected that a data conversion error could occur, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

SQLFeatureNotSupportedException - The JDBC driver does not support this method.

setNull

void setNull(String parameterName,
 SQLType sqlType)
      throws SQLException

Sets the designated parameter to SQL NULL.

Note:

• You must specify the parameter's SQL type.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

sqlType - The SQL type code.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

SQLFeatureNotSupportedException - The sqlType is a JDBCType.ARRAY, JDBCType.BLOB, JDBCType.CLOB, JDBCType.DATALINK, JDBCType.JAVA_OBJECT, JDBCType.NCHAR, JDBCType.NCLOB, JDBCType.NVARCHAR, JDBCType.LONGNVARCHAR, JDBCType.REF, JDBCType.ROWID, JDBCType.SQLXML or JDBCType.STRUCT data type and the JDBC driver does not support this data type.

See Also:

• JDBCType

setNull

void setNull(String parameterName,
 SQLType sqlType,
 String typeName)
      throws SQLException

Sets the designated parameter to SQL NULL.

This version of the method setNull() should be used for user-defined types and REF type parameters. Examples of user-defined types include: STRUCT, DISTINCT, JAVA_OBJECT, and named array types.

Although this method is intended for user-defined and REF parameters, this method may be used to set a null parameter of any JDBC type. If the parameter does not have a user-defined or REF type, the given typeName is ignored.

Note:

• To be portable, applications must give the SQL type code and the fully-qualified SQL type name when specifying a NULL user-defined or REF parameter. In the case of a user-defined type the name is the type name of the parameter itself. For a REF parameter, the name is the type name of the referenced type. If a JDBC driver does not need the type code or type name information, it may ignore it.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

sqlType - The SQL type code.

typeName - The fully-qualified name of an SQL user-defined type; ignored if the parameter is not a user-defined type or REF.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

SQLFeatureNotSupportedException - The sqlType is a JDBCType.ARRAY, JDBCType.BLOB, JDBCType.CLOB, JDBCType.DATALINK, JDBCType.JAVA_OBJECT, JDBCType.NCHAR, JDBCType.NCLOB, JDBCType.NVARCHAR, JDBCType.LONGNVARCHAR, JDBCType.REF, JDBCType.ROWID, JDBCType.SQLXML or JDBCType.STRUCT data type and the JDBC driver does not support this data type.

setObject

void setObject(String parameterName,
 Object value)
        throws SQLException

Sets the value of the designated parameter using the given object.

The JDBC specification specifies a standard mapping from Java Object types to SQL types. The given argument will be converted to the corresponding SQL type before being sent to the database.

Note that this method may be used to pass database- specific abstract data types, by using a driver-specific Java type.

If the object is of a class implementing the interface SQLData, the JDBC driver should call the method SQLData.writeSQL to write it to the SQL data stream.

If, on the other hand, the object is of a class implementing Ref, Blob, Clob, NClob, Struct, URL, RowId, SQLXML or Array, the driver should pass it to the database as a value of the corresponding SQL type.

Notes:

• Not all databases allow for a non-typed NULL to be sent to the backend. For maximum portability, the setNull() or the setObject( final String parameterName, final Object x, int sqlType ) method should be used instead of setObject( final String parameterName, final Object value ) with value set to null
• This method throws an exception if there is an ambiguity, for example, if the object is of a class implementing more than one of the interfaces named above.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The object containing the input parameter value.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred, this method was called on a closed EnhancedPreparedStatement or the type of the given object is ambiguous.

setObject

void setObject(String parameterName,
 Object value,
 SQLType targetSqlType,
 int scaleOrLength)
        throws SQLException

Sets the value of the designated parameter using the given object.

If the second argument is an InputStream or a Reader then the stream must contain the number of bytes specified by the scaleOrLength argument

.

If these conditions are not true the driver will generate a SQLException when the prepared statement is executed.

The given Java object will be converted to the given targetSqlType before being sent to the database.

If the object has a custom mapping (is of a class implementing the interface SQLData), the JDBC driver should call the method SQLData.writeSQL(SQLOutput) to write it to the SQL data stream.

If, on the other hand, the object is of a class implementing Ref, Blob, Clob, NClob, Struct, URL, or Array, the driver should pass it to the database as a value of the corresponding SQL type.

Note that this method may be used to pass database-specific abstract data types.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The object containing the input parameter value.

targetSqlType - The SQL type to be sent to the database. The scale argument may further qualify this type.

scaleOrLength - For JDBCType.DECIMAL or JDBCType.NUMERIC types, this is the number of digits after the decimal point. For Java Object types InputStream and Reader, this is the length of the data in the stream or reader. For all other types, this value will be ignored.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred, this method was called on a closed EnhancedPreparedStatement or the Java Object specified by value is an InputStream or Reader instance and the value of the scale parameter is less than zero.

SQLFeatureNotSupportedException - The JDBC driver does not support the specified targetSqlType.

See Also:

• JDBCType
• SQLType

setObject

void setObject(String parameterName,
 Object value,
 SQLType targetSqlType)
        throws SQLException

Sets the value of the designated parameter with the given object.

This method is similar to setObject(String,Object,SQLType,int), except that it assumes a scale of zero.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The object containing the input parameter value.

targetSqlType - The SQL type to be sent to the database. The scale argument may further qualify this type.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred, or this method was called on a closed EnhancedPreparedStatement.

SQLFeatureNotSupportedException - The JDBC driver does not support the specified targetSqlType.

See Also:

• JDBCType
• SQLType

setQueryTimeout

void setQueryTimeout(int timeout)
              throws SQLException

Sets the number of seconds the driver will wait for a Statement instance to execute to the given number of seconds. By default there is no limit on the amount of time allowed for a running statement to complete.

If the limit is exceeded, an SQLTimeoutException is thrown.

A JDBC driver must apply this limit to the Statement.execute(String), Statement.executeQuery(String) and Statement.executeUpdate(String) methods.

Notes:

• JDBC driver implementations may also apply this limit to ResultSet methods (consult your driver vendor documentation for details).
• In the case of Statement batching, it is implementation defined whether the time-out is applied to individual SQL commands added via the #addBatch() method or to the entire batch of SQL commands invoked by the executeBatch() method (consult your driver vendor documentation for details).

Parameters:

timeout - The new query timeout limit in seconds; zero means there is no limit

Throws:

SQLException - A database access error occurred, this method was called on a closed EnhancedPreparedStatement or the condition seconds >= 0 is not satisfied

See Also:

• getQueryTimeout()

setRef

void setRef(String parameterName,
 Ref value)
     throws SQLException

Sets the designated parameter to the given REF(<structured-type>) value.

The driver converts this to an SQL REF value when it sends it to the database.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The parameter value.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

SQLFeatureNotSupportedException - The JDBC driver does not support this method.

setRowId

void setRowId(String parameterName,
 RowId value)
       throws SQLException

Sets the designated parameter to the given RowId instance.

The driver converts this to an SQL ROWID value when it sends it to the database.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The parameter value.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

SQLFeatureNotSupportedException - The JDBC driver does not support this method.

setShort

void setShort(String parameterName,
 short value)
       throws SQLException

Sets the designated parameter to the given Java short value.

The driver converts this to an SQL SMALLINT value when it sends it to the database.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The parameter value.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

setSQLXML

void setSQLXML(String parameterName,
 SQLXML value)
        throws SQLException

Sets the designated parameter to the given SQLXML value.

The driver converts this to an SQL SQLXML value when it sends it to the database.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - An SQLXML instance that maps an SQL SQLXML value.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred, this method was called on a closed EnhancedPreparedStatement, or the Result, Writer or OutputStream was closed for the SQLXML object.

SQLFeatureNotSupportedException - The JDBC driver does not support this method.

setString

void setString(String parameterName,
 String value)
        throws SQLException

Sets the designated parameter to the given Java String value.

The driver converts this to an SQL VARCHAR or LONGVARCHAR value (depending on the argument's size relative to the driver's limits on VARCHAR values) when it sends it to the database.

For the logging, it is always VARCHAR.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The parameter value.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

setTime

void setTime(String parameterName,
 Time value)
      throws SQLException

Sets the designated parameter to the given Time value.

The driver converts this to an SQL TIME value when it sends it to the database.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The parameter value.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

setTime

void setTime(String parameterName,
 Time value,
 Calendar calendar)
      throws SQLException

Sets the designated parameter to the given Time value using the given Calendar instance. The driver used the Calendar instance to construct an SQL TIME value, which the driver then sends to the database. With the Calendar instance, the driver can calculate the date taking into account a custom timezone. If no Calendar instance is specified, the driver uses the default timezone, which is that of the virtual machine running the application.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The parameter value.

calendar - The Calendar instance the driver will use to construct the date.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

setTimestamp

void setTimestamp(String parameterName,
 Timestamp value)
           throws SQLException

Sets the designated parameter to the given Timestamp value.

The driver converts this to an SQL TIMESTAMP value when it sends it to the database.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The parameter value.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

setTimestamp

void setTimestamp(String parameterName,
 Timestamp value,
 Calendar calendar)
           throws SQLException

Sets the designated parameter to the given Timestamp value using the given Calendar instance. The driver used the Calendar instance to construct an SQL TIMESTAMP value, which the driver then sends to the database. With the Calendar instance, the driver can calculate the timestamp taking into account a custom timezone. If no Calendar instance is specified, the driver uses the default timezone, which is that of the virtual machine running the application.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The parameter value.

calendar - The Calendar instance the driver will use to construct the date.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

setURL

void setURL(String parameterName,
 URL value)
     throws SQLException

Sets the designated parameter to the given URL value.

The driver converts this to an SQL DATALINK value when it sends it to the database.

Parameters:

parameterName - The name of the parameter, prefixed by a colon.

value - The parameter value.

Throws:

SQLException - The parameter name did not correspond to any defined parameter in the SQL statement, a database access error occurred or this method was called on a closed EnhancedPreparedStatement.

SQLFeatureNotSupportedException - The JDBC driver does not support this method.