- java.lang.Object
-
- org.hsqldb.jdbc.JDBCPreparedStatement
-
- All Implemented Interfaces:
java.lang.AutoCloseable,java.sql.PreparedStatement,java.sql.Statement,java.sql.Wrapper
- Direct Known Subclasses:
JDBCCallableStatement
public class JDBCPreparedStatement extends java.lang.Object implements java.sql.PreparedStatementAn object that represents a precompiled SQL statement.A SQL statement is precompiled and stored in a
PreparedStatementobject. This object can then be used to efficiently execute this statement multiple times.Note: The setter methods (
setShort,setString, and so on) for setting IN parameter values must specify types that are compatible with the defined SQL type of the input parameter. For instance, if the IN parameter has SQL typeINTEGER, then the methodsetIntshould be used.If arbitrary parameter type conversions are required, the method
setObjectshould be used with a target SQL type.In the following example of setting a parameter,
conrepresents an active connection:BigDecimal sal = new BigDecimal("153833.00"); PreparedStatement pstmt = con.prepareStatement("UPDATE EMPLOYEES SET SALARY = ? WHERE ID = ?"); pstmt.setBigDecimal(1, sal); pstmt.setInt(2, 110592);HSQLDB-Specific Information:
From version 2.0, the implementation meets the JDBC specification requirement that any existing ResultSet is closed when execute() or executeQuery() methods are called. The connection property close_result=true is required for this behaviour.JDBCPreparedStatement objects are backed by a true compiled parametric representation. Hence, there are now significant performance gains to be had by using a JDBCPreparedStatement object in preference to a JDBCStatement object when a short-running SQL statement is to be executed more than once.
When it can be otherwise avoided, it should be considered poor practice to fully prepare (construct), parameterize, execute, fetch and close a JDBCParameterMetaData object for each execution cycle. Indeed, because the prepare and execute phases both represent a round-trip to the engine, this practice is likely to be noticeably less performant for short-running statements (and possibly even orders of magnitude less performant over network connections for short-running statements) than the equivalent process using JDBCStatement objects, albeit far more convenient, less error prone and certainly much less resource-intensive, especially when large binary and character values are involved, due to the optimized parameterization facility.
Instead, when developing an application that is not totally oriented toward the execution of ad hoc SQL, it is recommended to expend some effort toward identifying the SQL statements that are good candidates for regular reuse and adapting the structure of the application accordingly. Often, this is done by recording the text of candidate SQL statements in an application resource object (which has the nice side-benefit of isolating and hiding differences in SQL dialects across different drivers) and caching for possible reuse the PreparedStatement objects derived from the recorded text.
Starting with 2.0, when built under a JDBC 4 environment, statement caching can be transparently enabled or disabled on a statement-by-statement basis by invoking setPoolable(true | false), respectively, upon Statement objects of interest.
Multi thread use:
A PreparedStatement object is stateful and should not normally be shared by multiple threads. If it has to be shared, the calls to set the parameters, calls to add batch statements, the execute call and any post-execute calls should be made within a block synchronized on the PreparedStatement Object.
(fredt@users)
(campbell-burnet@users)- Since:
- JDK 1.1, HSQLDB 1.9.0
- Author:
- Campbell Burnet (campbell-burnet@users dot sourceforge.net), Fred Toussi (fredt@users dot sourceforge.net)
- See Also:
JDBCConnection.prepareStatement(java.lang.String),JDBCResultSet
-
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidaddBatch()Adds a set of parameters to thisPreparedStatementobject's batch of commands.voidaddBatch(java.lang.String sql)This method should always throw if called for a PreparedStatement or CallableStatement.voidcancel()Cancels thisStatementobject if both the DBMS and driver support aborting an SQL statement.voidclearBatch()Empties thisStatementobject's current list of SQL commands.voidclearParameters()Clears the current parameter values immediately.voidclearWarnings()Clears all the warnings reported on thisStatementobject.voidclose()Does the specialized work required to free this object's resources and that of its parent class.voidcloseOnCompletion()Specifies that thisStatementwill be closed when all its dependent result sets are closed.booleanexecute()Executes the SQL statement in thisPreparedStatementobject, which may be any kind of SQL statement.booleanexecute(java.lang.String sql)This method should always throw if called for a PreparedStatement or CallableStatement.booleanexecute(java.lang.String sql, int autoGeneratedKeys)booleanexecute(java.lang.String sql, int[] columnIndexes)booleanexecute(java.lang.String sql, java.lang.String[] columnNames)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.longexecuteLargeUpdate()Executes the SQL statement in thisPreparedStatementobject, which must be an SQL Data Manipulation Language (DML) statement, such asINSERT,UPDATEorDELETE; or an SQL statement that returns nothing, such as a DDL statement.java.sql.ResultSetexecuteQuery()Executes the SQL query in thisPreparedStatementobject and returns theResultSetobject generated by the query.java.sql.ResultSetexecuteQuery(java.lang.String sql)This method should always throw if called for a PreparedStatement or CallableStatement.intexecuteUpdate()Executes the SQL statement in thisPreparedStatementobject, which must be an SQL Data Manipulation Language (DML) statement, such asINSERT,UPDATEorDELETE; or an SQL statement that returns nothing, such as a DDL statement.intexecuteUpdate(java.lang.String sql)This method should always throw if called for a PreparedStatement or CallableStatement.intexecuteUpdate(java.lang.String sql, int autoGeneratedKeys)Statement methods that must be overridden in this class and throw an exception.intexecuteUpdate(java.lang.String sql, int[] columnIndexes)intexecuteUpdate(java.lang.String sql, java.lang.String[] columnNames)java.sql.ConnectiongetConnection()Retrieves theConnectionobject that produced thisStatementobject.intgetFetchDirection()Retrieves the direction for fetching rows from database tables that is the default for result sets generated from thisStatementobject.intgetFetchSize()Retrieves the number of result set rows that is the default fetch size forResultSetobjects generated from thisStatementobject.java.sql.ResultSetgetGeneratedKeys()Retrieves any auto-generated keys created as a result of executing thisStatementobject.longgetLargeMaxRows()Retrieves the maximum number of rows that aResultSetobject produced by thisStatementobject can contain.longgetLargeUpdateCount()Retrieves the current result as an update count; if the result is aResultSetobject or there are no more results, -1 is returned.intgetMaxFieldSize()Retrieves the maximum number of bytes that can be returned for character and binary column values in aResultSetobject produced by thisStatementobject.intgetMaxRows()Retrieves the maximum number of rows that aResultSetobject produced by thisStatementobject can contain.java.sql.ResultSetMetaDatagetMetaData()Retrieves aResultSetMetaDataobject that contains information about the columns of theResultSetobject that will be returned when thisPreparedStatementobject is executed.booleangetMoreResults()Moves to thisStatementobject's next result, returnstrueif it is aResultSetobject, and implicitly closes any currentResultSetobject(s) obtained with the methodgetResultSet.booleangetMoreResults(int current)Moves to thisStatementobject's next result, deals with any currentResultSetobject(s) according to the instructions specified by the given flag, and returnstrueif the next result is aResultSetobject.java.sql.ParameterMetaDatagetParameterMetaData()Retrieves the number, types and properties of thisPreparedStatementobject's parameters.org.hsqldb.result.ResultMetaDatagetParameterMetaDataDirect()intgetQueryTimeout()Retrieves the number of seconds the driver will wait for aStatementobject to execute.java.sql.ResultSetgetResultSet()Retrieves the current result as aResultSetobject.intgetResultSetConcurrency()Retrieves the result set concurrency forResultSetobjects generated by thisStatementobject.intgetResultSetHoldability()Retrieves the result set holdability forResultSetobjects generated by thisStatementobject.JDBCResultSetMetaDatagetResultSetMetaData()intgetResultSetType()Retrieves the result set type forResultSetobjects generated by thisStatementobject.java.lang.StringgetSQL()longgetStatementID()intgetUpdateCount()Retrieves the current result as an update count; if the result is aResultSetobject or there are no more results, -1 is returned.java.sql.SQLWarninggetWarnings()Retrieves the first warning reported by calls on thisStatementobject.booleanisClosed()Retrieves whether thisStatementobject has been closed.booleanisCloseOnCompletion()Returns a value indicating whether thisStatementwill be closed when all its dependent result sets are closed.booleanisPoolable()Returns a value indicating whether theStatementis poolable or not.booleanisRowCount()booleanisWrapperFor(java.lang.Class<?> iface)Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does.voidsetArray(int parameterIndex, java.sql.Array x)Sets the designated parameter to the givenjava.sql.Arrayobject.voidsetAsciiStream(int parameterIndex, java.io.InputStream x)Sets the designated parameter to the given input stream.voidsetAsciiStream(int parameterIndex, java.io.InputStream x, int length)Sets the designated parameter to the given input stream, which will have the specified number of bytes.voidsetAsciiStream(int parameterIndex, java.io.InputStream x, long length)Sets the designated parameter to the given input stream, which will have the specified number of bytes.voidsetBigDecimal(int parameterIndex, java.math.BigDecimal x)Sets the designated parameter to the givenjava.math.BigDecimalvalue.voidsetBinaryStream(int parameterIndex, java.io.InputStream x)Sets the designated parameter to the given input stream.voidsetBinaryStream(int parameterIndex, java.io.InputStream x, int length)Sets the designated parameter to the given input stream, which will have the specified number of bytes.voidsetBinaryStream(int parameterIndex, java.io.InputStream x, long length)Sets the designated parameter to the given input stream, which will have the specified number of bytes.voidsetBlob(int parameterIndex, java.io.InputStream inputStream)Sets the designated parameter to aInputStreamobject.voidsetBlob(int parameterIndex, java.io.InputStream inputStream, long length)Sets the designated parameter to aInputStreamobject.voidsetBlob(int parameterIndex, java.sql.Blob x)Sets the designated parameter to the givenjava.sql.Blobobject.voidsetBoolean(int parameterIndex, boolean x)Sets the designated parameter to the given Javabooleanvalue.voidsetByte(int parameterIndex, byte x)Sets the designated parameter to the given Javabytevalue.voidsetBytes(int parameterIndex, byte[] x)Sets the designated parameter to the given Java array of bytes.voidsetCharacterStream(int parameterIndex, java.io.Reader reader)Sets the designated parameter to the givenReaderobject.voidsetCharacterStream(int parameterIndex, java.io.Reader reader, int length)Sets the designated parameter to the givenReaderobject, which is the given number of characters long.voidsetCharacterStream(int parameterIndex, java.io.Reader reader, long length)Sets the designated parameter to the givenReaderobject, which is the given number of characters long.voidsetClob(int parameterIndex, java.io.Reader reader)Sets the designated parameter to aReaderobject.voidsetClob(int parameterIndex, java.io.Reader reader, long length)Sets the designated parameter to aReaderobject.voidsetClob(int parameterIndex, java.sql.Clob x)Sets the designated parameter to the givenjava.sql.Clobobject.voidsetCursorName(java.lang.String name)Sets the SQL cursor name to the givenString, which will be used by subsequentStatementobjectexecutemethods.voidsetDate(int parameterIndex, java.sql.Date x)Sets the designated parameter to the givenjava.sql.Datevalue using the default time zone of the virtual machine that is running the application.voidsetDate(int parameterIndex, java.sql.Date x, java.util.Calendar cal)Sets the designated parameter to the givenjava.sql.Datevalue, using the givenCalendarobject.voidsetDouble(int parameterIndex, double x)Sets the designated parameter to the given Javadoublevalue.voidsetEscapeProcessing(boolean enable)Sets escape processing on or off.voidsetFetchDirection(int direction)Gives the driver a hint as to the direction in which rows will be processed inResultSetobjects created using thisStatementobject.voidsetFetchSize(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 forResultSetobjects generated by thisStatement.voidsetFloat(int parameterIndex, float x)Sets the designated parameter to the given Javafloatvalue.voidsetInt(int parameterIndex, int x)Sets the designated parameter to the given Javaintvalue.voidsetLargeMaxRows(long max)Sets the limit for the maximum number of rows that anyResultSetobject generated by thisStatementobject can contain to the given number.voidsetLong(int parameterIndex, long x)Sets the designated parameter to the given Javalongvalue.voidsetMaxFieldSize(int max)Sets the limit for the maximum number of bytes in aResultSetSets the limit for the maximum number of bytes that can be returned for character and binary column values in aResultSetobject produced by thisStatementobject.voidsetMaxRows(int max)Sets the limit for the maximum number of rows that anyResultSetobject generated by thisStatementobject can contain to the given number.voidsetNCharacterStream(int parameterIndex, java.io.Reader value)Sets the designated parameter to aReaderobject.voidsetNCharacterStream(int parameterIndex, java.io.Reader value, long length)Sets the designated parameter to aReaderobject.voidsetNClob(int parameterIndex, java.io.Reader reader)Sets the designated parameter to aReaderobject.voidsetNClob(int parameterIndex, java.io.Reader reader, long length)Sets the designated parameter to aReaderobject.voidsetNClob(int parameterIndex, java.sql.NClob value)Sets the designated parameter to ajava.sql.NClobobject.voidsetNString(int parameterIndex, java.lang.String value)Sets the designated parameter to the givenStringobject.voidsetNull(int parameterIndex, int sqlType)Sets the designated parameter to SQLNULL.voidsetNull(int parameterIndex, int sqlType, java.lang.String typeName)Sets the designated parameter to SQLNULL.voidsetObject(int parameterIndex, java.lang.Object x)Sets the value of the designated parameter using the given object.voidsetObject(int parameterIndex, java.lang.Object x, int targetSqlType)Sets the value of the designated parameter with the given object.voidsetObject(int parameterIndex, java.lang.Object x, int targetSqlType, int scaleOrLength)Sets the value of the designated parameter with the given object.voidsetObject(int parameterIndex, java.lang.Object x, java.sql.SQLType targetSqlType)Sets the value of the designated parameter with the given object.voidsetObject(int parameterIndex, java.lang.Object x, java.sql.SQLType targetSqlType, int scaleOrLength)Sets the value of the designated parameter with the given object.voidsetPoolable(boolean poolable)Requests that aStatementbe pooled or not pooled.voidsetQueryTimeout(int seconds)Sets the number of seconds the driver will wait for aStatementobject to execute to the given number of seconds.voidsetRef(int parameterIndex, java.sql.Ref x)Sets the designated parameter to the givenREF(<structured-type>)value.voidsetRowId(int parameterIndex, java.sql.RowId x)Sets the designated parameter to the givenjava.sql.RowIdobject.voidsetShort(int parameterIndex, short x)Sets the designated parameter to the given Javashortvalue.voidsetSQLXML(int parameterIndex, java.sql.SQLXML xmlObject)Sets the designated parameter to the givenjava.sql.SQLXMLobject.voidsetString(int parameterIndex, java.lang.String x)Sets the designated parameter to the given JavaStringvalue.voidsetTime(int parameterIndex, java.sql.Time x)Sets the designated parameter to the givenjava.sql.Timevalue.voidsetTime(int parameterIndex, java.sql.Time x, java.util.Calendar cal)Sets the designated parameter to the givenjava.sql.Timevalue, using the givenCalendarobject.voidsetTimestamp(int parameterIndex, java.sql.Timestamp x)Sets the designated parameter to the givenjava.sql.Timestampvalue.voidsetTimestamp(int parameterIndex, java.sql.Timestamp x, java.util.Calendar cal)Sets the designated parameter to the givenjava.sql.Timestampvalue, using the givenCalendarobject.voidsetUnicodeStream(int parameterIndex, java.io.InputStream x, int length)Deprecated.UsesetCharacterStreamvoidsetURL(int parameterIndex, java.net.URL x)Sets the designated parameter to the givenjava.net.URLvalue.java.lang.StringtoString()Retrieves a String representation of this object.<T> Tunwrap(java.lang.Class<T> iface)Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy.
-
-
-
Method Detail
-
executeQuery
public java.sql.ResultSet executeQuery() throws java.sql.SQLExceptionExecutes the SQL query in thisPreparedStatementobject and returns theResultSetobject generated by the query.- Specified by:
executeQueryin interfacejava.sql.PreparedStatement- Returns:
- a
ResultSetobject that contains the data produced by the query; nevernull - Throws:
java.sql.SQLException- if a database access error occurs; this method is called on a closedPreparedStatementor the SQL statement does not return aResultSetobjectjava.sql.SQLTimeoutException- when the driver has determined that the timeout value that was specified by thesetQueryTimeoutmethod has been exceeded and has at least attempted to cancel the currently runningStatement
-
executeUpdate
public int executeUpdate() throws java.sql.SQLExceptionExecutes the SQL statement in thisPreparedStatementobject, which must be an SQL Data Manipulation Language (DML) statement, such asINSERT,UPDATEorDELETE; or an SQL statement that returns nothing, such as a DDL statement.- Specified by:
executeUpdatein interfacejava.sql.PreparedStatement- Returns:
- either (1) the row count for SQL Data Manipulation Language (DML) statements or (2) 0 for SQL statements that return nothing
- Throws:
java.sql.SQLException- if a database access error occurs; this method is called on a closedPreparedStatementor the SQL statement returns aResultSetobjectjava.sql.SQLTimeoutException- when the driver has determined that the timeout value that was specified by thesetQueryTimeoutmethod has been exceeded and has at least attempted to cancel the currently runningStatement
-
setNull
public void setNull(int parameterIndex, int sqlType) throws java.sql.SQLExceptionSets the designated parameter to SQLNULL.Note: You must specify the parameter's SQL type.
HSQLDB-Specific Information:
HSQLDB currently ignores the sqlType argument.- Specified by:
setNullin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...sqlType- the SQL type code defined injava.sql.Types- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatementjava.sql.SQLFeatureNotSupportedException- ifsqlTypeis aARRAY,BLOB,CLOB,DATALINK,JAVA_OBJECT,NCHAR,NCLOB,NVARCHAR,LONGNVARCHAR,REF,ROWID,SQLXMLorSTRUCTdata type and the JDBC driver does not support this data type
-
setBoolean
public void setBoolean(int parameterIndex, boolean x) throws java.sql.SQLExceptionSets the designated parameter to the given Javabooleanvalue. The driver converts this to an SQLBITorBOOLEANvalue when it sends it to the database.HSQLDB-Specific Information:
HSQLDB supports BOOLEAN type for boolean values. This method can also be used to set the value of a parameter of the SQL type BIT(1), which is a bit string consisting of a 0 or 1.- Specified by:
setBooleanin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setByte
public void setByte(int parameterIndex, byte x) throws java.sql.SQLExceptionSets the designated parameter to the given Javabytevalue. The driver converts this to an SQLTINYINTvalue when it sends it to the database.- Specified by:
setBytein interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setShort
public void setShort(int parameterIndex, short x) throws java.sql.SQLExceptionSets the designated parameter to the given Javashortvalue. The driver converts this to an SQLSMALLINTvalue when it sends it to the database.- Specified by:
setShortin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setInt
public void setInt(int parameterIndex, int x) throws java.sql.SQLExceptionSets the designated parameter to the given Javaintvalue. The driver converts this to an SQLINTEGERvalue when it sends it to the database.- Specified by:
setIntin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setLong
public void setLong(int parameterIndex, long x) throws java.sql.SQLExceptionSets the designated parameter to the given Javalongvalue. The driver converts this to an SQLBIGINTvalue when it sends it to the database.- Specified by:
setLongin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setFloat
public void setFloat(int parameterIndex, float x) throws java.sql.SQLExceptionSets the designated parameter to the given Javafloatvalue. The driver converts this to an SQLREALvalue when it sends it to the database.HSQLDB-Specific Information:
Since 1.7.1, HSQLDB handles Java positive/negative Infinity and NaNfloatvalues consistent with the Java Language Specification; these special values are now correctly stored to and retrieved from the database.- Specified by:
setFloatin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setDouble
public void setDouble(int parameterIndex, double x) throws java.sql.SQLExceptionSets the designated parameter to the given Javadoublevalue. The driver converts this to an SQLDOUBLEvalue when it sends it to the database.HSQLDB-Specific Information:
Since 1.7.1, HSQLDB handles Java positive/negative Infinity and NaNdoublevalues consistent with the Java Language Specification; these special values are now correctly stored to and retrieved from the database.- Specified by:
setDoublein interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setBigDecimal
public void setBigDecimal(int parameterIndex, java.math.BigDecimal x) throws java.sql.SQLExceptionSets the designated parameter to the givenjava.math.BigDecimalvalue. The driver converts this to an SQLNUMERICvalue when it sends it to the database.- Specified by:
setBigDecimalin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setString
public void setString(int parameterIndex, java.lang.String x) throws java.sql.SQLExceptionSets the designated parameter to the given JavaStringvalue. The driver converts this to an SQLVARCHARorLONGVARCHARvalue (depending on the argument's size relative to the driver's limits onVARCHARvalues) when it sends it to the database.HSQLDB-Specific Information:
Including 2.0, HSQLDB represents all XXXCHAR values internally as java.lang.String objects; there is no appreciable difference between CHAR, VARCHAR and LONGVARCHAR.- Specified by:
setStringin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setBytes
public void setBytes(int parameterIndex, byte[] x) throws java.sql.SQLExceptionSets the designated parameter to the given Java array of bytes. The driver converts this to an SQLVARBINARYorLONGVARBINARY(depending on the argument's size relative to the driver's limits onVARBINARYvalues) when it sends it to the database.HSQLDB-Specific Information:
Including 2.0, HSQLDB represents all XXXBINARY values the same way internally; there is no appreciable difference between BINARY, VARBINARY and LONGVARBINARY as far as JDBC is concerned.- Specified by:
setBytesin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setDate
public void setDate(int parameterIndex, java.sql.Date x) throws java.sql.SQLExceptionSets the designated parameter to the givenjava.sql.Datevalue using the default time zone of the virtual machine that is running the application. The driver converts this to an SQLDATEvalue when it sends it to the database.HSQLDB-Specific Information:
When a setXXX method is used to set a parameter of type TIMESTAMP WITH TIME ZONE or TIME WITH TIME ZONE the time zone of the client application is used as time zone- Specified by:
setDatein interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setTime
public void setTime(int parameterIndex, java.sql.Time x) throws java.sql.SQLExceptionSets the designated parameter to the givenjava.sql.Timevalue. The driver converts this to an SQLTIMEvalue when it sends it to the database.HSQLDB-Specific Information:
When a setXXX method is used to set a parameter of type TIMESTAMP WITH TIME ZONE or TIME WITH TIME ZONE the time zone of the client application is used as time zone- Specified by:
setTimein interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setTimestamp
public void setTimestamp(int parameterIndex, java.sql.Timestamp x) throws java.sql.SQLExceptionSets the designated parameter to the givenjava.sql.Timestampvalue. The driver converts this to an SQLTIMESTAMPvalue when it sends it to the database.HSQLDB-Specific Information:
When a setXXX method is used to set a parameter of type TIMESTAMP WITH TIME ZONE or TIME WITH TIME ZONE the time zone of the client application is used as time zone.When this method is used to set a parameter of type TIME or TIME WITH TIME ZONE, then the nanosecond value of the Timestamp object will be used if the TIME parameter accepts fractional seconds.
- Specified by:
setTimestampin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setAsciiStream
public void setAsciiStream(int parameterIndex, java.io.InputStream x, int length) throws java.sql.SQLExceptionSets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large ASCII value is input to aLONGVARCHARparameter, it may be more practical to send it via ajava.io.InputStream. 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.
HSQLDB-Specific Information:
From HSQLDB 2.0 this method uses the US-ASCII character encoding to convert bytes from the stream into the characters of a String.This method does not use streaming to send the data, whether the target is a CLOB or other binary object.
For long streams (larger than a few megabytes) with CLOB targets, it is more efficient to use a version of setCharacterStream which takes the a length parameter.
- Specified by:
setAsciiStreamin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the Java input stream that contains the ASCII parameter valuelength- the number of bytes in the stream- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
setUnicodeStream
@Deprecated public void setUnicodeStream(int parameterIndex, java.io.InputStream x, int length) throws java.sql.SQLExceptionDeprecated.UsesetCharacterStreamSets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large Unicode value is input to aLONGVARCHARparameter, it may be more practical to send it via ajava.io.InputStreamobject. 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. The byte format of the Unicode stream must be a Java UTF-8, as defined in the Java Virtual Machine Specification.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
HSQLDB-Specific Information:
Starting with 2.0, this method behaves according to the JDBC4 specification (the stream is treated as though it has UTF-8 encoding. This method is deprecated: please use setCharacterStream(...) instead.- Specified by:
setUnicodeStreamin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- ajava.io.InputStreamobject that contains the Unicode parameter valuelength- the number of bytes in the stream- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method
-
setBinaryStream
public void setBinaryStream(int parameterIndex, java.io.InputStream x, int length) throws java.sql.SQLExceptionSets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large binary value is input to aLONGVARBINARYparameter, it may be more practical to send it via ajava.io.InputStreamobject. 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.
HSQLDB-Specific Information:
Since 1.7.2, this method works according to the standard.- Specified by:
setBinaryStreamin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the java input stream which contains the binary parameter valuelength- the number of bytes in the stream- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement
-
clearParameters
public void clearParameters() throws java.sql.SQLExceptionClears 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.- Specified by:
clearParametersin interfacejava.sql.PreparedStatement- Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedPreparedStatement
-
setObject
public void setObject(int parameterIndex, java.lang.Object x, int targetSqlType) throws java.sql.SQLExceptionSets the value of the designated parameter with the given object. This method is similar tosetObject(int parameterIndex, Object x, int targetSqlType, int scaleOrLength), except that it assumes a scale of zero.HSQLDB-Specific Information:
Since 1.7.2, this method supports conversions listed in the conversion table B-5 of the JDBC 3 specification.- Specified by:
setObjectin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the object containing the input parameter valuetargetSqlType- the SQL type (as defined in java.sql.Types) to be sent to the database- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support the specified targetSqlType- See Also:
Types
-
setObject
public void setObject(int parameterIndex, java.lang.Object x) throws java.sql.SQLExceptionSets the value of the designated parameter using the given object.
The JDBC specification specifies a standard mapping from Java
Objecttypes 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 methodSQLData.writeSQLto write it to the SQL data stream. If, on the other hand, the object is of a class implementingRef,Blob,Clob,NClob,Struct,java.net.URL,RowId,SQLXMLorArray, the driver should pass it to the database as a value of the corresponding SQL type.Note: Not all databases allow for a non-typed Null to be sent to the backend. For maximum portability, the
setNullor thesetObject(int parameterIndex, Object x, int sqlType)method should be used instead ofsetObject(int parameterIndex, Object x).Note: 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.
HSQLDB-Specific Information:
Since 1.7.2, this method supports conversions listed in the conversion table B-5 of the JDBC 3 specification.- Specified by:
setObjectin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the object containing the input parameter value- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs; this method is called on a closedPreparedStatementor the type of the given object is ambiguous
-
execute
public boolean execute() throws java.sql.SQLExceptionExecutes the SQL statement in thisPreparedStatementobject, which may be any kind of SQL statement. Some prepared statements return multiple results; theexecutemethod handles these complex statements as well as the simpler form of statements handled by the methodsexecuteQueryandexecuteUpdate.The
executemethod returns abooleanto indicate the form of the first result. You must call either the methodgetResultSetorgetUpdateCountto retrieve the result; you must callgetMoreResultsto move to any subsequent result(s).HSQLDB-Specific Information:
If the statement is a call to a PROCEDURE, it may return multiple fetchable results.- Specified by:
executein interfacejava.sql.PreparedStatement- Returns:
trueif the first result is aResultSetobject;falseif the first result is an update count or there is no result- Throws:
java.sql.SQLException- if a database access error occurs; this method is called on a closedPreparedStatementor an argument is supplied to this methodjava.sql.SQLTimeoutException- when the driver has determined that the timeout value that was specified by thesetQueryTimeoutmethod has been exceeded and has at least attempted to cancel the currently runningStatement- See Also:
JDBCStatement.execute(java.lang.String),JDBCStatement.getResultSet(),JDBCStatement.getUpdateCount(),JDBCStatement.getMoreResults()
-
addBatch
public void addBatch() throws java.sql.SQLExceptionAdds a set of parameters to thisPreparedStatementobject's batch of commands.HSQLDB-Specific Information:
Since 1.7.2, this feature is supported.- Specified by:
addBatchin interfacejava.sql.PreparedStatement- Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedPreparedStatement- Since:
- JDK 1.2
- See Also:
JDBCStatement.addBatch(java.lang.String)
-
setCharacterStream
public void setCharacterStream(int parameterIndex, java.io.Reader reader, int length) throws java.sql.SQLExceptionSets the designated parameter to the givenReaderobject, which is the given number of characters long. When a very large UNICODE value is input to aLONGVARCHARparameter, it may be more practical to send it via ajava.io.Readerobject. 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.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
HSQLDB-Specific Information:
From HSQLDB 2.0 this method uses streaming to send data when the target is a CLOB.HSQLDB represents CHARACTER and related SQL types as UTF16 Unicode internally, so this method does not perform any conversion.
- Specified by:
setCharacterStreamin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...reader- thejava.io.Readerobject that contains the Unicode datalength- the number of characters in the stream- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement- Since:
- JDK 1.2
-
setRef
public void setRef(int parameterIndex, java.sql.Ref x) throws java.sql.SQLExceptionSets the designated parameter to the givenREF(<structured-type>)value. The driver converts this to an SQLREFvalue when it sends it to the database.HSQLDB-Specific Information:
Including 2.0 HSQLDB does not support the SQL REF type. Calling this method throws an exception.- Specified by:
setRefin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- an SQLREFvalue- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.2
-
setBlob
public void setBlob(int parameterIndex, java.sql.Blob x) throws java.sql.SQLExceptionSets the designated parameter to the givenjava.sql.Blobobject. The driver converts this to an SQLBLOBvalue when it sends it to the database.HSQLDB-Specific Information:
For parameters of type Blob, setBlob works normally.In addition since 1.7.2, setBlob is supported for BINARY and VARBINARY parameters. In this context, the Blob object is hard-limited to those of length less than or equal to Integer.MAX_VALUE. In practice, soft limits such as available heap and maximum disk usage per file (such as the transaction log) dictate a much smaller maximum length.
For BINARY and VARBINARY parameter types setBlob(i,x) is roughly equivalent (null and length handling not shown) to:
setBinaryStream(i, x.getBinaryStream(), (int) x.length());- Specified by:
setBlobin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- aBlobobject that maps an SQLBLOBvalue- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.2
-
setClob
public void setClob(int parameterIndex, java.sql.Clob x) throws java.sql.SQLExceptionSets the designated parameter to the givenjava.sql.Clobobject. The driver converts this to an SQLCLOBvalue when it sends it to the database.HSQLDB-Specific Information:
For parameters of type Clob, setClob works normally.In addition since 1.7.2, setClob is supported for CHARACTER and VARCHAR parameters. In this context, the Clob object is hard-limited to those of length less than or equal to Integer.MAX_VALUE. In practice, soft limits such as available heap and maximum disk usage per file (such as the transaction log) dictate a much smaller maximum length.
For CHARACTER and VARCHAR parameter types setClob(i,x) is roughly equivalent (null and length handling not shown) to:
setCharacterStream(i, x.getCharacterStream(), (int) x.length());- Specified by:
setClobin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- aClobobject that maps an SQLCLOBvalue- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.2
-
setArray
public void setArray(int parameterIndex, java.sql.Array x) throws java.sql.SQLExceptionSets the designated parameter to the givenjava.sql.Arrayobject. The driver converts this to an SQLARRAYvalue when it sends it to the database.HSQLDB-Specific Information:
From version 2.0, HSQLDB supports the SQL ARRAY type.- Specified by:
setArrayin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- anArrayobject that maps an SQLARRAYvalue- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.2
-
getMetaData
public java.sql.ResultSetMetaData getMetaData() throws java.sql.SQLExceptionRetrieves aResultSetMetaDataobject that contains information about the columns of theResultSetobject that will be returned when thisPreparedStatementobject is executed.Because a
PreparedStatementobject is precompiled, it is possible to know about theResultSetobject that it will return without having to execute it. Consequently, it is possible to invoke the methodgetMetaDataon aPreparedStatementobject rather than waiting to execute it and then invoking theResultSet.getMetaDatamethod on theResultSetobject that is returned.NOTE: Using this method may be expensive for some drivers due to the lack of underlying DBMS support.
HSQLDB-Specific Information:
Since 1.7.2, this feature is supported and is inexpensive as it is backed by underlying DBMS support. If the statement generates an update count, then null is returned.- Specified by:
getMetaDatain interfacejava.sql.PreparedStatement- Returns:
- the description of a
ResultSetobject's columns ornullif the driver cannot return aResultSetMetaDataobject - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedPreparedStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.2
-
setDate
public void setDate(int parameterIndex, java.sql.Date x, java.util.Calendar cal) throws java.sql.SQLExceptionSets the designated parameter to the givenjava.sql.Datevalue, using the givenCalendarobject. The driver uses theCalendarobject to construct an SQLDATEvalue, which the driver then sends to the database. With aCalendarobject, the driver can calculate the date taking into account a custom timezone. If noCalendarobject is specified, the driver uses the default timezone, which is that of the virtual machine running the application.- Specified by:
setDatein interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter valuecal- theCalendarobject the driver will use to construct the date- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement- Since:
- JDK 1.2
-
setTime
public void setTime(int parameterIndex, java.sql.Time x, java.util.Calendar cal) throws java.sql.SQLExceptionSets the designated parameter to the givenjava.sql.Timevalue, using the givenCalendarobject. The driver uses theCalendarobject to construct an SQLTIMEvalue, which the driver then sends to the database. With aCalendarobject, the driver can calculate the time taking into account a custom timezone. If noCalendarobject is specified, the driver uses the default timezone, which is that of the virtual machine running the application.HSQLDB-Specific Information:
When a setXXX method is used to set a parameter of type TIMESTAMP WITH TIME ZONE or TIME WITH TIME ZONE the time zone (including Daylight Saving Time) of the Calendar is used as time zone for the value.- Specified by:
setTimein interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter valuecal- theCalendarobject the driver will use to construct the time- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement- Since:
- JDK 1.2
-
setTimestamp
public void setTimestamp(int parameterIndex, java.sql.Timestamp x, java.util.Calendar cal) throws java.sql.SQLExceptionSets the designated parameter to the givenjava.sql.Timestampvalue, using the givenCalendarobject. The driver uses theCalendarobject to construct an SQLTIMESTAMPvalue, which the driver then sends to the database. With aCalendarobject, the driver can calculate the timestamp taking into account a custom timezone. If noCalendarobject is specified, the driver uses the default timezone, which is that of the virtual machine running the application.HSQLDB-Specific Information:
When a setXXX method is used to set a parameter of type TIMESTAMP WITH TIME ZONE or TIME WITH TIME ZONE the time zone (including Daylight Saving Time) of the Calendar is used as time zone.In this case, if the Calendar argument is null, then the default Calendar for the clients JVM is used as the Calendar
When this method is used to set a parameter of type TIME or TIME WITH TIME ZONE, then the nanosecond value of the Timestamp object is used if the TIME parameter accepts fractional seconds.
- Specified by:
setTimestampin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter valuecal- theCalendarobject the driver will use to construct the timestamp- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement- Since:
- JDK 1.2
-
setNull
public void setNull(int parameterIndex, int sqlType, java.lang.String typeName) throws java.sql.SQLExceptionSets the designated parameter to SQLNULL. This version of the methodsetNullshould be used for user-defined types and REF type parameters. Examples of user-defined types include: STRUCT, DISTINCT, JAVA_OBJECT, and named array types.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. Although it 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.
HSQLDB-Specific Information:
HSQLDB simply ignores the sqlType and typeName arguments.- Specified by:
setNullin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...sqlType- a value fromjava.sql.TypestypeName- the fully-qualified name of an SQL user-defined type; ignored if the parameter is not a user-defined type or REF- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatementjava.sql.SQLFeatureNotSupportedException- ifsqlTypeis aARRAY,BLOB,CLOB,DATALINK,JAVA_OBJECT,NCHAR,NCLOB,NVARCHAR,LONGNVARCHAR,REF,ROWID,SQLXMLorSTRUCTdata type and the JDBC driver does not support this data type or if the JDBC driver does not support this method- Since:
- JDK 1.2
-
executeBatch
public int[] executeBatch() throws java.sql.SQLExceptionSubmits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts. Theintelements 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 methodexecuteBatchmay be one of the following:- 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
- A value of
SUCCESS_NO_INFO-- indicates that the command was processed successfully but that the number of rows affected is unknownIf 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 behavior 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 methodBatchUpdateException.getUpdateCountswill contain as many elements as there are commands in the batch, and at least one of the elements will be the following: - A value of
EXECUTE_FAILED-- indicates that the command failed to execute successfully and occurs only if a driver continues to process commands after a command fails
A driver is not required to implement this method. 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
BatchUpdateExceptionobject has been thrown.HSQLDB-Specific Information:
Starting with HSQLDB 1.7.2, this feature is supported.HSQLDB stops execution of commands in a batch when one of the commands results in an exception. The size of the returned array equals the number of commands that were executed successfully.
- Specified by:
executeBatchin interfacejava.sql.Statement- 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:
java.sql.SQLException- if a database access error occurs, this method is called on a closedStatementor the driver does not support batch statements. ThrowsBatchUpdateException(a subclass ofSQLException) if one of the commands sent to the database fails to execute properly or attempts to return a result set.- Since:
- JDK 1.3
- See Also:
addBatch(),DatabaseMetaData.supportsBatchUpdates()
-
setEscapeProcessing
public void setEscapeProcessing(boolean enable) throws java.sql.SQLExceptionSets escape processing on or off.HSQLDB-Specific Information:
As per JDBC spec, calling this method has no effect.- Specified by:
setEscapeProcessingin interfacejava.sql.Statement- Parameters:
enable-trueto enable escape processing;falseto disable it- Throws:
java.sql.SQLException- if a database access error occurs
-
addBatch
public void addBatch(java.lang.String sql) throws java.sql.SQLExceptionThis method should always throw if called for a PreparedStatement or CallableStatement.- Specified by:
addBatchin interfacejava.sql.Statement- Parameters:
sql- ignored- Throws:
java.sql.SQLException- always
-
executeQuery
public java.sql.ResultSet executeQuery(java.lang.String sql) throws java.sql.SQLExceptionThis method should always throw if called for a PreparedStatement or CallableStatement.- Specified by:
executeQueryin interfacejava.sql.Statement- Parameters:
sql- ignored- Returns:
- nothing
- Throws:
java.sql.SQLException- always
-
execute
public boolean execute(java.lang.String sql) throws java.sql.SQLExceptionThis method should always throw if called for a PreparedStatement or CallableStatement.- Specified by:
executein interfacejava.sql.Statement- Parameters:
sql- ignored- Returns:
- nothing
- Throws:
java.sql.SQLException- always
-
executeUpdate
public int executeUpdate(java.lang.String sql) throws java.sql.SQLExceptionThis method should always throw if called for a PreparedStatement or CallableStatement.- Specified by:
executeUpdatein interfacejava.sql.Statement- Parameters:
sql- ignored- Returns:
- nothing
- Throws:
java.sql.SQLException- always
-
close
public void close() throws java.sql.SQLExceptionDoes the specialized work required to free this object's resources and that of its parent class.- Specified by:
closein interfacejava.lang.AutoCloseable- Specified by:
closein interfacejava.sql.Statement- Throws:
java.sql.SQLException- if a database access error occurs
-
toString
public java.lang.String toString()
Retrieves a String representation of this object.The representation is of the form:
class-name@hash[sql=[char-sequence], parameters=[p1, ...pi, ...pn]]
p1, ...pi, ...pn are the String representations of the currently set parameter values that will be used with the non-batch execution methods.
- Overrides:
toStringin classjava.lang.Object- Returns:
- a String representation of this object
-
setURL
public void setURL(int parameterIndex, java.net.URL x) throws java.sql.SQLExceptionSets the designated parameter to the givenjava.net.URLvalue. The driver converts this to an SQLDATALINKvalue when it sends it to the database.HSQLDB-Specific Information:
Including 2.0, HSQLDB does not support the DATALINK SQL type for which this method is intended. Calling this method throws an exception.- Specified by:
setURLin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- thejava.net.URLobject to be set- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQL 1.7.0
-
getParameterMetaData
public java.sql.ParameterMetaData getParameterMetaData() throws java.sql.SQLExceptionRetrieves the number, types and properties of thisPreparedStatementobject's parameters.HSQLDB-Specific Information:
Since 1.7.2, this feature is supported.- Specified by:
getParameterMetaDatain interfacejava.sql.PreparedStatement- Returns:
- a
ParameterMetaDataobject that contains information about the number, types and properties for each parameter marker of thisPreparedStatementobject - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedPreparedStatement- Since:
- JDK 1.4, HSQL 1.7.0
- See Also:
ParameterMetaData
-
executeUpdate
public int executeUpdate(java.lang.String sql, int autoGeneratedKeys) throws java.sql.SQLExceptionStatement methods that must be overridden in this class and throw an exception.- Specified by:
executeUpdatein interfacejava.sql.Statement- Throws:
java.sql.SQLException
-
execute
public boolean execute(java.lang.String sql, int autoGeneratedKeys) throws java.sql.SQLException- Specified by:
executein interfacejava.sql.Statement- Throws:
java.sql.SQLException
-
executeUpdate
public int executeUpdate(java.lang.String sql, int[] columnIndexes) throws java.sql.SQLException- Specified by:
executeUpdatein interfacejava.sql.Statement- Throws:
java.sql.SQLException
-
execute
public boolean execute(java.lang.String sql, int[] columnIndexes) throws java.sql.SQLException- Specified by:
executein interfacejava.sql.Statement- Throws:
java.sql.SQLException
-
executeUpdate
public int executeUpdate(java.lang.String sql, java.lang.String[] columnNames) throws java.sql.SQLException- Specified by:
executeUpdatein interfacejava.sql.Statement- Throws:
java.sql.SQLException
-
execute
public boolean execute(java.lang.String sql, java.lang.String[] columnNames) throws java.sql.SQLException- Specified by:
executein interfacejava.sql.Statement- Throws:
java.sql.SQLException
-
getMoreResults
public boolean getMoreResults(int current) throws java.sql.SQLExceptionMoves to thisStatementobject's next result, deals with any currentResultSetobject(s) according to the instructions specified by the given flag, and returnstrueif the next result is aResultSetobject.There are no more results when the following is true:
// stmt is a Statement object ((stmt.getMoreResults(current) == false) && (stmt.getUpdateCount() == -1))HSQLDB-Specific Information:
HSQLDB supports this feature.This is used with CallableStatement objects that return multiple ResultSet objects.
- Specified by:
getMoreResultsin interfacejava.sql.Statement- Parameters:
current- one of the followingStatementconstants indicating what should happen to currentResultSetobjects obtained using the methodgetResultSet:Statement.CLOSE_CURRENT_RESULT,Statement.KEEP_CURRENT_RESULT, orStatement.CLOSE_ALL_RESULTS- Returns:
trueif the next result is aResultSetobject;falseif it is an update count or there are no more results- Throws:
java.sql.SQLException- if a database access error occurs, this method is called on a closedStatementor the argument supplied is not one of the following:Statement.CLOSE_CURRENT_RESULT,Statement.KEEP_CURRENT_RESULT, orStatement.CLOSE_ALL_RESULTS- Since:
- JDK 1.4, HSQLDB 1.7
- See Also:
execute()
-
getGeneratedKeys
public java.sql.ResultSet getGeneratedKeys() throws java.sql.SQLExceptionRetrieves any auto-generated keys created as a result of executing thisStatementobject. If thisStatementobject did not generate any keys, an emptyResultSetobject 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.
HSQLDB-Specific Information:
Starting with version 2.0, HSQLDB supports this feature with single-row and multi-row insert, update and merge statements.This method returns a result set only if the executeUpdate methods that was used is one of the three methods that have the extra parameter indicating return of generated keys
If the executeUpdate method did not specify the columns which represent the auto-generated keys the IDENTITY column or GENERATED column(s) of the table are returned.
The executeUpdate methods with column indexes or column names return the post-insert or post-update values of the specified columns, whether the columns are generated or not. This allows values that have been modified by execution of triggers to be returned.
If column names or indexes provided by the user in the executeUpdate() method calls do not correspond to table columns (incorrect names or indexes larger than the column count), an empty result is returned.
- Specified by:
getGeneratedKeysin interfacejava.sql.Statement- Returns:
- a
ResultSetobject containing the auto-generated key(s) generated by the execution of thisStatementobject - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7
-
getResultSetHoldability
public int getResultSetHoldability() throws java.sql.SQLExceptionRetrieves the result set holdability forResultSetobjects generated by thisStatementobject.- Specified by:
getResultSetHoldabilityin interfacejava.sql.Statement- Returns:
- either
ResultSet.HOLD_CURSORS_OVER_COMMITorResultSet.CLOSE_CURSORS_AT_COMMIT - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatement- Since:
- JDK 1.4, HSQLDB 1.7
-
isClosed
public boolean isClosed()
Retrieves whether thisStatementobject has been closed. AStatementis closed if the method close has been called on it, or if it is automatically closed.- Specified by:
isClosedin interfacejava.sql.Statement- Returns:
- true if this
Statementobject is closed; false if it is still open - Since:
- JDK 1.6, HSQLDB 2.0
-
setRowId
public void setRowId(int parameterIndex, java.sql.RowId x) throws java.sql.SQLExceptionSets the designated parameter to the givenjava.sql.RowIdobject. The driver converts this to a SQLROWIDvalue when it sends it to the database- Specified by:
setRowIdin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
setNString
public void setNString(int parameterIndex, java.lang.String value) throws java.sql.SQLExceptionSets the designated parameter to the givenStringobject. The driver converts this to a SQLNCHARorNVARCHARorLONGNVARCHARvalue (depending on the argument's size relative to the driver's limits onNVARCHARvalues) when it sends it to the database.- Specified by:
setNStringin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- of the first parameter is 1, the second is 2, ...value- the parameter value- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs; or this method is called on a closedPreparedStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
setNCharacterStream
public void setNCharacterStream(int parameterIndex, java.io.Reader value, long length) throws java.sql.SQLExceptionSets the designated parameter to aReaderobject. TheReaderreads 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.- Specified by:
setNCharacterStreamin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- of the first parameter is 1, the second is 2, ...value- the parameter valuelength- the number of characters in the parameter data.- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs; or this method is called on a closedPreparedStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
setNClob
public void setNClob(int parameterIndex, java.sql.NClob value) throws java.sql.SQLExceptionSets the designated parameter to ajava.sql.NClobobject. The driver converts this to a SQLNCLOBvalue when it sends it to the database.- Specified by:
setNClobin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- of the first parameter is 1, the second is 2, ...value- the parameter value- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs; or this method is called on a closedPreparedStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
setClob
public void setClob(int parameterIndex, java.io.Reader reader, long length) throws java.sql.SQLExceptionSets the designated parameter to aReaderobject. The reader must contain the number of characters specified by length otherwise aSQLExceptionwill be generated when thePreparedStatementis executed. This method differs from thesetCharacterStream (int, Reader, int)method because it informs the driver that the parameter value should be sent to the server as aCLOB. When thesetCharacterStreammethod is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGVARCHARor aCLOB- Specified by:
setClobin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- index of the first parameter is 1, the second is 2, ...reader- An object that contains the data to set the parameter value to.length- the number of characters in the parameter data.- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs; this method is called on a closedPreparedStatementor if the length specified is less than zero.java.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
setBlob
public void setBlob(int parameterIndex, java.io.InputStream inputStream, long length) throws java.sql.SQLExceptionSets the designated parameter to aInputStreamobject. TheInputstreammust contain the number of characters specified by length otherwise aSQLExceptionwill be generated when thePreparedStatementis executed. This method differs from thesetBinaryStream (int, InputStream, int)method because it informs the driver that the parameter value should be sent to the server as aBLOB. When thesetBinaryStreammethod is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGVARBINARYor aBLOBHSQLDB-Specific Information:
In HSQLDB 2.0, this method uses streaming to send the data when the stream is assigned to a BLOB target. For other binary targets the stream is read on the client side and a byte array is sent.- Specified by:
setBlobin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- index of the first parameter is 1, the second is 2, ...inputStream- An object that contains the data to set the parameter value to.length- the number of bytes in the parameter data.- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs; this method is called on a closedPreparedStatement; if the length specified is less than zero or if the number of bytes in theInputStreamdoes not match the specified length.java.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
setNClob
public void setNClob(int parameterIndex, java.io.Reader reader, long length) throws java.sql.SQLExceptionSets the designated parameter to aReaderobject. The reader must contain the number of characters specified by length otherwise aSQLExceptionwill be generated when thePreparedStatementis executed. This method differs from thesetCharacterStream (int, Reader, int)method because it informs the driver that the parameter value should be sent to the server as aNCLOB. When thesetCharacterStreammethod is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGNVARCHARor aNCLOB- Specified by:
setNClobin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- index of the first parameter is 1, the second is 2, ...reader- An object that contains the data to set the parameter value to.length- the number of characters in the parameter data.- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if the length specified is less than zero; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closedPreparedStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
setSQLXML
public void setSQLXML(int parameterIndex, java.sql.SQLXML xmlObject) throws java.sql.SQLExceptionSets the designated parameter to the givenjava.sql.SQLXMLobject. The driver converts this to an SQLXMLvalue when it sends it to the database.- Specified by:
setSQLXMLin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- index of the first parameter is 1, the second is 2, ...xmlObject- aSQLXMLobject that maps an SQLXMLvalue- Throws:
java.sql.SQLException- if a database access error occurs, this method is called on a closedPreparedStatementor thejava.xml.transform.Result,WriterorOutputStreamhas not been closed for theSQLXMLobjectjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
setObject
public void setObject(int parameterIndex, java.lang.Object x, int targetSqlType, int scaleOrLength) throws java.sql.SQLExceptionSets the value of the designated parameter with the given object. If the second argument is an
InputStreamthen the stream must contain the number of bytes specified by scaleOrLength. If the second argument is aReaderthen the reader must contain the number of characters specified by scaleOrLength. If these conditions are not true the driver will generate aSQLExceptionwhen 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 methodSQLData.writeSQLto write it to the SQL data stream. If, on the other hand, the object is of a class implementingRef,Blob,Clob,NClob,Struct,java.net.URL, orArray, 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.
- Specified by:
setObjectin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the object containing the input parameter valuetargetSqlType- the SQL type (as defined in java.sql.Types) to be sent to the database. The scale argument may further qualify this type.scaleOrLength- forjava.sql.Types.DECIMALorjava.sql.Types.NUMERIC types, this is the number of digits after the decimal point. For Java Object typesInputStreamandReader, this is the length of the data in the stream or reader. For all other types, this value will be ignored.- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs; this method is called on a closedPreparedStatementor if the Java Object specified by x is an InputStream or Reader object and the value of the scale parameter is less than zerojava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support the specified targetSqlType- See Also:
Types
-
setAsciiStream
public void setAsciiStream(int parameterIndex, java.io.InputStream x, long length) throws java.sql.SQLExceptionSets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large ASCII value is input to aLONGVARCHARparameter, it may be more practical to send it via ajava.io.InputStream. 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.
HSQLDB-Specific Information:
From HSQLDB 2.0 this method uses the US-ASCII character encoding to convert bytes from the stream into the characters of a String.This method does not use streaming to send the data, whether the target is a CLOB or other binary object.
For long streams (larger than a few megabytes) with CLOB targets, it is more efficient to use a version of setCharacterStream which takes the a length parameter.
- Specified by:
setAsciiStreamin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the Java input stream that contains the ASCII parameter valuelength- the number of bytes in the stream- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement- Since:
- JDK 1.6, HSQLDB 2.0
-
setBinaryStream
public void setBinaryStream(int parameterIndex, java.io.InputStream x, long length) throws java.sql.SQLExceptionSets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large binary value is input to aLONGVARBINARYparameter, it may be more practical to send it via ajava.io.InputStreamobject. 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.
HSQLDB-Specific Information:
This method uses streaming to send the data when the stream is assigned to a BLOB target. For other binary targets the stream is read on the client side and a byte array is sent.- Specified by:
setBinaryStreamin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the java input stream which contains the binary parameter valuelength- the number of bytes in the stream- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement- Since:
- JDK 1.6, HSQLDB 2.0
-
setCharacterStream
public void setCharacterStream(int parameterIndex, java.io.Reader reader, long length) throws java.sql.SQLExceptionSets the designated parameter to the givenReaderobject, which is the given number of characters long. When a very large UNICODE value is input to aLONGVARCHARparameter, it may be more practical to send it via ajava.io.Readerobject. 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.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
HSQLDB-Specific Information:
This method uses streaming to send data when the target is a CLOB.- Specified by:
setCharacterStreamin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...reader- thejava.io.Readerobject that contains the Unicode datalength- the number of characters in the stream- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatement- Since:
- JDK 1.6, HSQLDB 2.0
-
setAsciiStream
public void setAsciiStream(int parameterIndex, java.io.InputStream x) throws java.sql.SQLExceptionSets the designated parameter to the given input stream. When a very large ASCII value is input to aLONGVARCHARparameter, it may be more practical to send it via ajava.io.InputStream. 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.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setAsciiStreamwhich takes a length parameter.HSQLDB-Specific Information:
In HSQLDB 2.0, this method does not use streaming to send the data, whether the target is a CLOB or other binary object. For long streams (larger than a few megabytes), it is more efficient to use a version of setCharacterStream which takes the a length parameter.- Specified by:
setAsciiStreamin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the Java input stream that contains the ASCII parameter value- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setBinaryStream
public void setBinaryStream(int parameterIndex, java.io.InputStream x) throws java.sql.SQLExceptionSets the designated parameter to the given input stream. When a very large binary value is input to aLONGVARBINARYparameter, it may be more practical to send it via ajava.io.InputStreamobject. 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.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setBinaryStreamwhich takes a length parameter.HSQLDB-Specific Information:
This method does not use streaming to send the data, whether the target is a CLOB or other binary object.For long streams (larger than a few megabytes) with CLOB targets, it is more efficient to use a version of setCharacterStream which takes the a length parameter.
- Specified by:
setBinaryStreamin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the java input stream which contains the binary parameter value- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setCharacterStream
public void setCharacterStream(int parameterIndex, java.io.Reader reader) throws java.sql.SQLExceptionSets the designated parameter to the givenReaderobject. When a very large UNICODE value is input to aLONGVARCHARparameter, it may be more practical to send it via ajava.io.Readerobject. 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.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setCharacterStreamwhich takes a length parameter.HSQLDB-Specific Information:
In HSQLDB 2.0, this method does not use streaming to send the data, whether the target is a CLOB or other binary object. For long streams (larger than a few megabytes), it is more efficient to use a version of setCharacterStream which takes the a length parameter.- Specified by:
setCharacterStreamin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...reader- thejava.io.Readerobject that contains the Unicode data- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setNCharacterStream
public void setNCharacterStream(int parameterIndex, java.io.Reader value) throws java.sql.SQLExceptionSets the designated parameter to aReaderobject. TheReaderreads 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.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setNCharacterStreamwhich takes a length parameter.- Specified by:
setNCharacterStreamin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- of the first parameter is 1, the second is 2, ...value- the parameter value- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs; or this method is called on a closedPreparedStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setClob
public void setClob(int parameterIndex, java.io.Reader reader) throws java.sql.SQLExceptionSets the designated parameter to aReaderobject. This method differs from thesetCharacterStream (int, Reader)method because it informs the driver that the parameter value should be sent to the server as aCLOB. When thesetCharacterStreammethod is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGVARCHARor aCLOBNote: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setClobwhich takes a length parameter.- Specified by:
setClobin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- index of the first parameter is 1, the second is 2, ...reader- An object that contains the data to set the parameter value to.- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs; this method is called on a closedPreparedStatementor if parameterIndex does not correspond to a parameter marker in the SQL statementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setBlob
public void setBlob(int parameterIndex, java.io.InputStream inputStream) throws java.sql.SQLExceptionSets the designated parameter to aInputStreamobject. This method differs from thesetBinaryStream (int, InputStream)method because it informs the driver that the parameter value should be sent to the server as aBLOB. When thesetBinaryStreammethod is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGVARBINARYor aBLOBNote: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setBlobwhich takes a length parameter.- Specified by:
setBlobin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- index of the first parameter is 1, the second is 2, ...inputStream- An object that contains the data to set the parameter value to.- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs; this method is called on a closedPreparedStatementor if parameterIndex does not correspond to a parameter marker in the SQL statement,java.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setNClob
public void setNClob(int parameterIndex, java.io.Reader reader) throws java.sql.SQLExceptionSets the designated parameter to aReaderobject. This method differs from thesetCharacterStream (int, Reader)method because it informs the driver that the parameter value should be sent to the server as aNCLOB. When thesetCharacterStreammethod is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGNVARCHARor aNCLOBNote: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setNClobwhich takes a length parameter.- Specified by:
setNClobin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- index of the first parameter is 1, the second is 2, ...reader- An object that contains the data to set the parameter value to.- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closedPreparedStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
getMaxFieldSize
public int getMaxFieldSize() throws java.sql.SQLExceptionRetrieves the maximum number of bytes that can be returned for character and binary column values in aResultSetobject produced by thisStatementobject. This limit applies only toBINARY,VARBINARY,LONGVARBINARY,CHAR,VARCHAR,NCHAR,NVARCHAR,LONGNVARCHARandLONGVARCHARcolumns. If the limit is exceeded, the excess data is silently discarded.HSQLDB-Specific Information:
HSQLDB always returns zero, meaning there is no limit.- Specified by:
getMaxFieldSizein interfacejava.sql.Statement- Returns:
- the current column size limit for columns storing character and binary values; zero means there is no limit
- Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatement- See Also:
setMaxFieldSize(int)
-
setMaxFieldSize
public void setMaxFieldSize(int max) throws java.sql.SQLExceptionSets the limit for the maximum number of bytes in aResultSetSets the limit for the maximum number of bytes that can be returned for character and binary column values in aResultSetobject produced by thisStatementobject. This limit applies only toBINARY,VARBINARY,LONGVARBINARY,CHAR,VARCHAR,NCHAR,NVARCHAR,LONGNVARCHARandLONGVARCHARfields. If the limit is exceeded, the excess data is silently discarded. For maximum portability, use values greater than 256.HSQLDB-Specific Information:
To present, calls to this method are simply ignored; HSQLDB always stores the full number of bytes when dealing with any of the field types mentioned above. These types all have an absolute maximum element upper bound determined by the Java array index limit java.lang.Integer.MAX_VALUE. For XXXBINARY types, this translates to Integer.MAX_VALUE bytes. For XXXCHAR types, this translates to 2 * Integer.MAX_VALUE bytes (2 bytes / character).In practice, field sizes are limited to values much smaller than the absolute maximum element upper bound, in particular due to limits imposed on the maximum available Java heap memory.
- Specified by:
setMaxFieldSizein interfacejava.sql.Statement- Parameters:
max- the new column size limit in bytes; zero means there is no limit- Throws:
java.sql.SQLException- if a database access error occurs, this method is called on a closedStatementor the conditionmax >= 0is not satisfied- See Also:
getMaxFieldSize()
-
getMaxRows
public int getMaxRows() throws java.sql.SQLExceptionRetrieves the maximum number of rows that aResultSetobject produced by thisStatementobject can contain. If this limit is exceeded, the excess rows are silently dropped.- Specified by:
getMaxRowsin interfacejava.sql.Statement- Returns:
- the current maximum number of rows for a
ResultSetobject produced by thisStatementobject; zero means there is no limit - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatement- See Also:
setMaxRows(int)
-
setMaxRows
public void setMaxRows(int max) throws java.sql.SQLExceptionSets the limit for the maximum number of rows that anyResultSetobject generated by thisStatementobject can contain to the given number. If the limit is exceeded, the excess rows are silently dropped.- Specified by:
setMaxRowsin interfacejava.sql.Statement- Parameters:
max- the new max rows limit; zero means there is no limit- Throws:
java.sql.SQLException- if a database access error occurs, this method is called on a closedStatementor the conditionmax >= 0is not satisfied- See Also:
getMaxRows()
-
getQueryTimeout
public int getQueryTimeout() throws java.sql.SQLExceptionRetrieves the number of seconds the driver will wait for aStatementobject to execute. If the limit is exceeded, aSQLExceptionis thrown.HSQLDB-Specific Information:
To present, HSQLDB always returns zero, meaning there is no limit.- Specified by:
getQueryTimeoutin interfacejava.sql.Statement- Returns:
- the current query timeout limit in seconds; zero means there is no limit
- Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatement- See Also:
setQueryTimeout(int)
-
setQueryTimeout
public void setQueryTimeout(int seconds) throws java.sql.SQLExceptionSets the number of seconds the driver will wait for aStatementobject to execute to the given number of seconds. If the limit is exceeded, anSQLExceptionis thrown. A JDBC driver must apply this limit to theexecute,executeQueryandexecuteUpdatemethods. JDBC driver implementations may also apply this limit toResultSetmethods (consult your driver vendor documentation for details).HSQLDB-Specific Information:
The maximum number of seconds to wait is 32767.- Specified by:
setQueryTimeoutin interfacejava.sql.Statement- Parameters:
seconds- the new query timeout limit in seconds; zero means there is no limit- Throws:
java.sql.SQLException- if a database access error occurs, this method is called on a closedStatementor the conditionseconds >= 0is not satisfied- See Also:
getQueryTimeout()
-
cancel
public void cancel() throws java.sql.SQLExceptionCancels thisStatementobject 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.HSQLDB-Specific Information:
HSQLDB version 2.3.4 and later supports aborting an SQL query or data update statement.- Specified by:
cancelin interfacejava.sql.Statement- Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method
-
getWarnings
public java.sql.SQLWarning getWarnings() throws java.sql.SQLExceptionRetrieves the first warning reported by calls on thisStatementobject. SubsequentStatementobject warnings will be chained to thisSQLWarningobject.The warning chain is automatically cleared each time a statement is (re)executed. This method may not be called on a closed
Statementobject; doing so will cause anSQLExceptionto be thrown.Note: If you are processing a
ResultSetobject, any warnings associated with reads on thatResultSetobject will be chained on it rather than on theStatementobject that produced it.HSQLDB-Specific Information:
From 1.9 HSQLDB, produces Statement warnings.- Specified by:
getWarningsin interfacejava.sql.Statement- Returns:
- the first
SQLWarningobject ornullif there are no warnings - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatement
-
clearWarnings
public void clearWarnings() throws java.sql.SQLExceptionClears all the warnings reported on thisStatementobject. After a call to this method, the methodgetWarningswill returnnulluntil a new warning is reported for thisStatementobject.HSQLDB-Specific Information:
Supported in HSQLDB 1.9.- Specified by:
clearWarningsin interfacejava.sql.Statement- Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatement
-
setCursorName
public void setCursorName(java.lang.String name) throws java.sql.SQLExceptionSets the SQL cursor name to the givenString, which will be used by subsequentStatementobjectexecutemethods. This name can then be used in SQL positioned update or delete statements to identify the current row in theResultSetobject 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'sSELECTstatement should have the formSELECT FOR UPDATE. IfFOR UPDATEis not present, positioned updates may fail.Note: By definition, the execution of positioned updates and deletes must be done by a different
Statementobject than the one that generated theResultSetobject being used for positioning. Also, cursor names must be unique within a connection.HSQLDB-Specific Information:
Including 2.0, HSQLDB does not support named cursors; calls to this method are ignored.- Specified by:
setCursorNamein interfacejava.sql.Statement- Parameters:
name- the new cursor name, which must be unique within a connection- Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method
-
getResultSet
public java.sql.ResultSet getResultSet() throws java.sql.SQLExceptionRetrieves the current result as aResultSetobject. This method should be called only once per result.HSQLDB-Specific Information:
Without an interceding call to executeXXX, each invocation of this method will produce a new, initialized ResultSet instance referring to the current result, if any.- Specified by:
getResultSetin interfacejava.sql.Statement- Returns:
- the current result as a
ResultSetobject ornullif the result is an update count or there are no more results - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatement- See Also:
execute()
-
getUpdateCount
public int getUpdateCount() throws java.sql.SQLExceptionRetrieves the current result as an update count; if the result is aResultSetobject or there are no more results, -1 is returned. This method should be called only once per result.- Specified by:
getUpdateCountin interfacejava.sql.Statement- Returns:
- the current result as an update count; -1 if the current result is a
ResultSetobject or there are no more results - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatement- See Also:
execute()
-
getMoreResults
public boolean getMoreResults() throws java.sql.SQLExceptionMoves to thisStatementobject's next result, returnstrueif it is aResultSetobject, and implicitly closes any currentResultSetobject(s) obtained with the methodgetResultSet.There are no more results when the following is true:
// stmt is a Statement object ((stmt.getMoreResults() == false) && (stmt.getUpdateCount() == -1))- Specified by:
getMoreResultsin interfacejava.sql.Statement- Returns:
trueif the next result is aResultSetobject;falseif it is an update count or there are no more results- Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatement- See Also:
execute()
-
setFetchDirection
public void setFetchDirection(int direction) throws java.sql.SQLExceptionGives the driver a hint as to the direction in which rows will be processed inResultSetobjects created using thisStatementobject. The default value isResultSet.FETCH_FORWARD.Note that this method sets the default fetch direction for result sets generated by this
Statementobject. Each result set has its own methods for getting and setting its own fetch direction.HSQLDB-Specific Information:
Up to 1.8.0.x, HSQLDB supports onlyFETCH_FORWARD; Setting any other value would throw anSQLExceptionstating that the operation is not supported.Starting with 2.0, HSQLDB accepts any valid value.
- Specified by:
setFetchDirectionin interfacejava.sql.Statement- Parameters:
direction- the initial direction for processing rows- Throws:
java.sql.SQLException- if a database access error occurs, this method is called on a closedStatementor the given direction is not one ofResultSet.FETCH_FORWARD,ResultSet.FETCH_REVERSE, orResultSet.FETCH_UNKNOWN- Since:
- JDK 1.2
- See Also:
getFetchDirection()
-
getFetchDirection
public int getFetchDirection() throws java.sql.SQLExceptionRetrieves the direction for fetching rows from database tables that is the default for result sets generated from thisStatementobject. If thisStatementobject has not set a fetch direction by calling the methodsetFetchDirection, the return value is implementation-specific.HSQLDB-Specific Information:
Up to 1.8.0.x, HSQLDB always returned FETCH_FORWARD. Starting with 2.0, HSQLDB returns FETCH_FORWARD by default, or whatever value has been explicitly assigned by invokingsetFetchDirection. .- Specified by:
getFetchDirectionin interfacejava.sql.Statement- Returns:
- the default fetch direction for result sets generated
from this
Statementobject - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatement- Since:
- JDK 1.2
- See Also:
setFetchDirection(int)
-
setFetchSize
public void setFetchSize(int rows) throws java.sql.SQLExceptionGives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed forResultSetobjects generated by thisStatement. If the value specified is zero, then the hint is ignored. The default value is zero.HSQLDB-Specific Information:
HSQLDB uses the specified value as a hint, but may process more or fewer rows than specified.- Specified by:
setFetchSizein interfacejava.sql.Statement- Parameters:
rows- the number of rows to fetch- Throws:
java.sql.SQLException- if a database access error occurs, this method is called on a closedStatementor the condition{@code rows >= 0}is not satisfied.- Since:
- JDK 1.2
- See Also:
getFetchSize()
-
getFetchSize
public int getFetchSize() throws java.sql.SQLExceptionRetrieves the number of result set rows that is the default fetch size forResultSetobjects generated from thisStatementobject. If thisStatementobject has not set a fetch size by calling the methodsetFetchSize, the return value is implementation-specific.HSQLDB-Specific InformationHSQLDB returns 0 by default, or the fetch size specified by setFetchSize
- Specified by:
getFetchSizein interfacejava.sql.Statement- Returns:
- the default fetch size for result sets generated
from this
Statementobject - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatement- Since:
- JDK 1.2
- See Also:
setFetchSize(int)
-
getResultSetConcurrency
public int getResultSetConcurrency() throws java.sql.SQLExceptionRetrieves the result set concurrency forResultSetobjects generated by thisStatementobject.HSQLDB-Specific Information:
HSQLDB supportsCONCUR_READ_ONLYandCONCUR_READ_UPDATEBLEconcurrency.- Specified by:
getResultSetConcurrencyin interfacejava.sql.Statement- Returns:
- either
ResultSet.CONCUR_READ_ONLYorResultSet.CONCUR_UPDATABLE - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatement- Since:
- JDK 1.2
-
getResultSetType
public int getResultSetType() throws java.sql.SQLExceptionRetrieves the result set type forResultSetobjects generated by thisStatementobject.HSQLDB-Specific Information:
HSQLDB 1.7.0 and later versions supportTYPE_FORWARD_ONLYandTYPE_SCROLL_INSENSITIVE.- Specified by:
getResultSetTypein interfacejava.sql.Statement- Returns:
- one of
ResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVE - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatement- Since:
- JDK 1.2
-
clearBatch
public void clearBatch() throws java.sql.SQLExceptionEmpties thisStatementobject's current list of SQL commands.NOTE: Support of an ability to batch updates is optional.
HSQLDB-Specific Information:
Starting with HSQLDB 1.7.2, this feature is supported.- Specified by:
clearBatchin interfacejava.sql.Statement- Throws:
java.sql.SQLException- if a database access error occurs, this method is called on a closedStatementor the driver does not support batch updates- Since:
- JDK 1.2
- See Also:
addBatch()
-
getConnection
public java.sql.Connection getConnection() throws java.sql.SQLExceptionRetrieves theConnectionobject that produced thisStatementobject.- Specified by:
getConnectionin interfacejava.sql.Statement- Returns:
- the connection that produced this statement
- Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatement- Since:
- JDK 1.2
-
setPoolable
public void setPoolable(boolean poolable) throws java.sql.SQLExceptionRequests that aStatementbe pooled or not pooled. The value specified is a hint to the statement pool implementation indicating whether the application wants the statement to be pooled. It is up to the statement pool manager as to whether the hint is used.The poolable value of a statement is applicable to both internal statement caches implemented by the driver and external statement caches implemented by application servers and other applications.
By default, a
Statementis not poolable when created, and aPreparedStatementandCallableStatementare poolable when created.- Specified by:
setPoolablein interfacejava.sql.Statement- Parameters:
poolable- requests that the statement be pooled if true and that the statement not be pooled if false- Throws:
java.sql.SQLException- if this method is called on a closedStatement- Since:
- JDK 1.6, HSQLDB 2.0
-
isPoolable
public boolean isPoolable() throws java.sql.SQLExceptionReturns a value indicating whether theStatementis poolable or not.- Specified by:
isPoolablein interfacejava.sql.Statement- Returns:
trueif theStatementis poolable;falseotherwise- Throws:
java.sql.SQLException- if this method is called on a closedStatement- Since:
- JDK 1.6, HSQLDB 2.0
- See Also:
setPoolable(boolean)
-
unwrap
public <T> T unwrap(java.lang.Class<T> iface) throws java.sql.SQLExceptionReturns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy. If the receiver implements the interface then the result is the receiver or a proxy for the receiver. If the receiver is a wrapper and the wrapped object implements the interface then the result is the wrapped object or a proxy for the wrapped object. Otherwise return the result of callingunwraprecursively on the wrapped object or a proxy for that result. If the receiver is not a wrapper and does not implement the interface, then anSQLExceptionis thrown.- Specified by:
unwrapin interfacejava.sql.Wrapper- Parameters:
iface- A Class defining an interface that the result must implement.- Returns:
- an object that implements the interface. May be a proxy for the actual implementing object.
- Throws:
java.sql.SQLException- If no object found that implements the interface- Since:
- JDK 1.6, HSQLDB 2.0
-
isWrapperFor
public boolean isWrapperFor(java.lang.Class<?> iface) throws java.sql.SQLExceptionReturns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does. Returns false otherwise. If this implements the interface then return true, else if this is a wrapper then return the result of recursively callingisWrapperForon the wrapped object. If this does not implement the interface and is not a wrapper, return false. This method should be implemented as a low-cost operation compared tounwrapso that callers can use this method to avoid expensiveunwrapcalls that may fail. If this method returns true then callingunwrapwith the same argument should succeed.- Specified by:
isWrapperForin interfacejava.sql.Wrapper- Parameters:
iface- a Class defining an interface.- Returns:
- true if this implements the interface or directly or indirectly wraps an object that does.
- Throws:
java.sql.SQLException- if an error occurs while determining whether this is a wrapper for an object with the given interface.- Since:
- JDK 1.6, HSQLDB 2.0
-
getLargeUpdateCount
public long getLargeUpdateCount() throws java.sql.SQLExceptionRetrieves the current result as an update count; if the result is aResultSetobject or there are no more results, -1 is returned. This method should be called only once per result.This method should be used when the returned row count may exceed
Integer.MAX_VALUE.The public implementation will throw
UnsupportedOperationException- Specified by:
getLargeUpdateCountin interfacejava.sql.Statement- Returns:
- the current result as an update count; -1 if the current result
is a
ResultSetobject or there are no more results - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatement- Since:
- 1.8
- See Also:
execute()
-
setLargeMaxRows
public void setLargeMaxRows(long max) throws java.sql.SQLExceptionSets the limit for the maximum number of rows that anyResultSetobject generated by thisStatementobject can contain to the given number. 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- Specified by:
setLargeMaxRowsin interfacejava.sql.Statement- Parameters:
max- the new max rows limit; zero means there is no limit- Throws:
java.sql.SQLException- if a database access error occurs, this method is called on a closedStatementor the conditionmax >= 0is not satisfied- Since:
- 1.8
- See Also:
getMaxRows()
-
getLargeMaxRows
public long getLargeMaxRows() throws java.sql.SQLExceptionRetrieves the maximum number of rows that aResultSetobject produced by thisStatementobject 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- Specified by:
getLargeMaxRowsin interfacejava.sql.Statement- Returns:
- the current maximum number of rows for a
ResultSetobject produced by thisStatementobject; zero means there is no limit - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatement- Since:
- 1.8
- See Also:
setMaxRows(int)
-
executeLargeBatch
public long[] executeLargeBatch() throws java.sql.SQLExceptionSubmits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts. Thelongelements 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 methodexecuteLargeBatchmay be one of the following:- 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
- A value of
SUCCESS_NO_INFO-- indicates that the command was processed successfully but that the number of rows affected is unknownIf 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 behavior 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 methodBatchUpdateException.getLargeUpdateCountswill contain as many elements as there are commands in the batch, and at least one of the elements will be the following: - A value of
EXECUTE_FAILED-- indicates that the command failed to execute successfully and occurs only if a driver continues to process commands after a command fails
This method should be used when the returned row count may exceed
Integer.MAX_VALUE.The default implementation will throw
UnsupportedOperationException- Specified by:
executeLargeBatchin interfacejava.sql.Statement- 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:
java.sql.SQLException- if a database access error occurs, this method is called on a closedStatementor the driver does not support batch statements. ThrowsBatchUpdateException(a subclass ofSQLException) if one of the commands sent to the database fails to execute properly or attempts to return a result set.java.sql.SQLTimeoutException- when the driver has determined that the timeout value that was specified by thesetQueryTimeoutmethod has been exceeded and has at least attempted to cancel the currently runningStatement- Since:
- 1.8
- See Also:
addBatch(),DatabaseMetaData.supportsBatchUpdates()
-
setObject
public void setObject(int parameterIndex, java.lang.Object x, java.sql.SQLType targetSqlType, int scaleOrLength) throws java.sql.SQLExceptionSets the value of the designated parameter with the given object. If the second argument is an
InputStreamthen the stream must contain the number of bytes specified by scaleOrLength. If the second argument is aReaderthen the reader must contain the number of characters specified by scaleOrLength. If these conditions are not true the driver will generate aSQLExceptionwhen 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 methodSQLData.writeSQLto write it to the SQL data stream. If, on the other hand, the object is of a class implementingRef,Blob,Clob,NClob,Struct,java.net.URL, orArray, 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.
The default implementation will throw
SQLFeatureNotSupportedException- Specified by:
setObjectin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the object containing the input parameter valuetargetSqlType- the SQL type to be sent to the database. The scale argument may further qualify this type.scaleOrLength- forjava.sql.JDBCType.DECIMALorjava.sql.JDBCType.NUMERIC types, this is the number of digits after the decimal point. For Java Object typesInputStreamandReader, this is the length of the data in the stream or reader. For all other types, this value will be ignored.- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatementor if the Java Object specified by x is an InputStream or Reader object and the value of the scale parameter is less than zerojava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support the specified targetSqlType- Since:
- 1.8
- See Also:
JDBCType,SQLType
-
setObject
public void setObject(int parameterIndex, java.lang.Object x, java.sql.SQLType targetSqlType) throws java.sql.SQLExceptionSets the value of the designated parameter with the given object. This method is similar tosetObject(int parameterIndex, Object x, SQLType targetSqlType, int scaleOrLength), except that it assumes a scale of zero.The default implementation will throw
SQLFeatureNotSupportedException- Specified by:
setObjectin interfacejava.sql.PreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the object containing the input parameter valuetargetSqlType- the SQL type to be sent to the database- Throws:
java.sql.SQLException- if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closedPreparedStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support the specified targetSqlType- Since:
- 1.8
- See Also:
JDBCType,SQLType
-
executeLargeUpdate
public long executeLargeUpdate() throws java.sql.SQLExceptionExecutes the SQL statement in thisPreparedStatementobject, which must be an SQL Data Manipulation Language (DML) statement, such asINSERT,UPDATEorDELETE; 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- Specified by:
executeLargeUpdatein interfacejava.sql.PreparedStatement- Returns:
- either (1) the row count for SQL Data Manipulation Language (DML) statements or (2) 0 for SQL statements that return nothing
- Throws:
java.sql.SQLException- if a database access error occurs; this method is called on a closedPreparedStatementor the SQL statement returns aResultSetobjectjava.sql.SQLTimeoutException- when the driver has determined that the timeout value that was specified by thesetQueryTimeoutmethod has been exceeded and has at least attempted to cancel the currently runningStatement- Since:
- 1.8
-
getSQL
public java.lang.String getSQL()
-
getStatementID
public long getStatementID()
-
isRowCount
public boolean isRowCount()
-
getResultSetMetaData
public JDBCResultSetMetaData getResultSetMetaData()
-
getParameterMetaDataDirect
public org.hsqldb.result.ResultMetaData getParameterMetaDataDirect()
-
closeOnCompletion
public void closeOnCompletion() throws java.sql.SQLExceptionSpecifies that thisStatementwill be closed when all its dependent result sets are closed. If execution of theStatementdoes not produce any result sets, this method has no effect.Note: Multiple calls to
closeOnCompletiondo not toggle the effect on thisStatement. However, a call tocloseOnCompletiondoes effect both the subsequent execution of statements, and statements that currently have open, dependent, result sets.- Throws:
java.sql.SQLException- if this method is called on a closedStatement- Since:
- JDK 1.7, HSQLDB 2.0.1
-
isCloseOnCompletion
public boolean isCloseOnCompletion() throws java.sql.SQLExceptionReturns a value indicating whether thisStatementwill be closed when all its dependent result sets are closed.- Returns:
trueif theStatementwill be closed when all of its dependent result sets are closed;falseotherwise- Throws:
java.sql.SQLException- if this method is called on a closedStatement- Since:
- JDK 1.7, HSQLDB 2.0.1
-
-