Interface PreparedStatement
- All Superinterfaces:
AutoCloseable,Statement,Wrapper
- All Known Subinterfaces:
CallableStatement
A SQL statement is precompiled and stored in a
PreparedStatement object. 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 type
INTEGER, then the method setInt should be used.
If arbitrary parameter type conversions are required, the method
setObject should be used with a target SQL type.
In the following example of setting a parameter, con represents
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);
- Since:
- 1.1
- See Also:
-
Field Summary
Fields declared in interface java.sql.Statement
CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO -
Method Summary
Modifier and TypeMethodDescriptionvoidaddBatch()Adds a set of parameters to thisPreparedStatementobject's batch of commands.voidClears the current parameter values immediately.booleanexecute()Executes the SQL statement in thisPreparedStatementobject, which may be any kind of SQL statement.default longExecutes 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.Executes the SQL query in thisPreparedStatementobject and returns theResultSetobject generated by the query.intExecutes 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.Retrieves aResultSetMetaDataobject that contains information about the columns of theResultSetobject that will be returned when thisPreparedStatementobject is executed.Retrieves the number, types and properties of thisPreparedStatementobject's parameters.voidSets the designated parameter to the givenjava.sql.Arrayobject.voidsetAsciiStream(int parameterIndex, InputStream x) Sets the designated parameter to the given input stream.voidsetAsciiStream(int parameterIndex, InputStream x, int length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.voidsetAsciiStream(int parameterIndex, InputStream x, long length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.voidsetBigDecimal(int parameterIndex, BigDecimal x) Sets the designated parameter to the givenjava.math.BigDecimalvalue.voidsetBinaryStream(int parameterIndex, InputStream x) Sets the designated parameter to the given input stream.voidsetBinaryStream(int parameterIndex, InputStream x, int length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.voidsetBinaryStream(int parameterIndex, InputStream x, long length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.voidsetBlob(int parameterIndex, InputStream inputStream) Sets the designated parameter to aInputStreamobject.voidsetBlob(int parameterIndex, InputStream inputStream, long length) Sets the designated parameter to aInputStreamobject.voidSets 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, Reader reader) Sets the designated parameter to the givenReaderobject.voidsetCharacterStream(int parameterIndex, Reader reader, int length) Sets the designated parameter to the givenReaderobject, which is the given number of characters long.voidsetCharacterStream(int parameterIndex, Reader reader, long length) Sets the designated parameter to the givenReaderobject, which is the given number of characters long.voidSets the designated parameter to aReaderobject.voidSets the designated parameter to aReaderobject.voidSets the designated parameter to the givenjava.sql.Clobobject.voidSets the designated parameter to the givenjava.sql.Datevalue using the default time zone of the virtual machine that is running the application.voidSets the designated parameter to the givenjava.sql.Datevalue, using the givenCalendarobject.voidsetDouble(int parameterIndex, double x) Sets the designated parameter to the given Javadoublevalue.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.voidsetLong(int parameterIndex, long x) Sets the designated parameter to the given Javalongvalue.voidsetNCharacterStream(int parameterIndex, Reader value) Sets the designated parameter to aReaderobject.voidsetNCharacterStream(int parameterIndex, Reader value, long length) Sets the designated parameter to aReaderobject.voidSets the designated parameter to aReaderobject.voidSets the designated parameter to aReaderobject.voidSets the designated parameter to ajava.sql.NClobobject.voidsetNString(int parameterIndex, String value) Sets the designated parameter to the givenStringobject.voidsetNull(int parameterIndex, int sqlType) Sets the designated parameter to SQLNULL.voidSets the designated parameter to SQLNULL.voidSets the value of the designated parameter using the given object.voidSets the value of the designated parameter with the given object.voidSets the value of the designated parameter with the given object.default voidSets the value of the designated parameter with the given object.default voidSets the value of the designated parameter with the given object.voidSets the designated parameter to the givenREF(<structured-type>)value.voidSets the designated parameter to the givenjava.sql.RowIdobject.voidsetShort(int parameterIndex, short x) Sets the designated parameter to the given Javashortvalue.voidSets the designated parameter to the givenjava.sql.SQLXMLobject.voidSets the designated parameter to the given JavaStringvalue.voidSets the designated parameter to the givenjava.sql.Timevalue.voidSets the designated parameter to the givenjava.sql.Timevalue, using the givenCalendarobject.voidsetTimestamp(int parameterIndex, Timestamp x) Sets the designated parameter to the givenjava.sql.Timestampvalue.voidsetTimestamp(int parameterIndex, Timestamp x, Calendar cal) Sets the designated parameter to the givenjava.sql.Timestampvalue, using the givenCalendarobject.voidsetUnicodeStream(int parameterIndex, InputStream x, int length) Deprecated.voidSets the designated parameter to the givenjava.net.URLvalue.Methods declared in interface java.sql.Statement
addBatch, cancel, clearBatch, clearWarnings, close, closeOnCompletion, enquoteIdentifier, enquoteLiteral, enquoteNCharLiteral, execute, execute, execute, execute, executeBatch, executeLargeBatch, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getLargeMaxRows, getLargeUpdateCount, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isClosed, isCloseOnCompletion, isPoolable, isSimpleIdentifier, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setLargeMaxRows, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeoutMethods declared in interface java.sql.Wrapper
isWrapperFor, unwrap
-
Method Details
-
executeQuery
Executes the SQL query in thisPreparedStatementobject and returns theResultSetobject generated by the query.- Returns:
- a
ResultSetobject that contains the data produced by the query; nevernull - Throws:
SQLException- if a database access error occurs; this method is called on a closedPreparedStatementor the SQL statement does not return aResultSetobjectSQLTimeoutException- 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
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.- Returns:
- either (1) the row count for SQL Data Manipulation Language (DML) statements or (2) 0 for SQL statements that return nothing
- Throws:
SQLException- if a database access error occurs; this method is called on a closedPreparedStatementor the SQL statement returns aResultSetobjectSQLTimeoutException- 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
Sets the designated parameter to SQLNULL.Note: You must specify the parameter's SQL type.
- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...sqlType- the SQL type code defined injava.sql.Types- Throws:
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 closedPreparedStatementSQLFeatureNotSupportedException- 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
Sets the designated parameter to the given Javabooleanvalue. The driver converts this to an SQLBITorBOOLEANvalue when it sends it to the database.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
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
Sets the designated parameter to the given Javabytevalue. The driver converts this to an SQLTINYINTvalue when it sends it to the database.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
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
Sets the designated parameter to the given Javashortvalue. The driver converts this to an SQLSMALLINTvalue when it sends it to the database.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
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
Sets the designated parameter to the given Javaintvalue. The driver converts this to an SQLINTEGERvalue when it sends it to the database.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
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
Sets the designated parameter to the given Javalongvalue. The driver converts this to an SQLBIGINTvalue when it sends it to the database.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
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
Sets the designated parameter to the given Javafloatvalue. The driver converts this to an SQLREALvalue when it sends it to the database.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
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
Sets the designated parameter to the given Javadoublevalue. The driver converts this to an SQLDOUBLEvalue when it sends it to the database.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
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
Sets the designated parameter to the givenjava.math.BigDecimalvalue. The driver converts this to an SQLNUMERICvalue when it sends it to the database.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
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
Sets 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.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
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
Sets 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.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
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
Sets 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.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
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
Sets the designated parameter to the givenjava.sql.Timevalue. The driver converts this to an SQLTIMEvalue when it sends it to the database.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
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
Sets the designated parameter to the givenjava.sql.Timestampvalue. The driver converts this to an SQLTIMESTAMPvalue when it sends it to the database.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
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
Sets 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.
- 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:
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(since="1.2") void setUnicodeStream(int parameterIndex, InputStream x, int length) throws SQLException Deprecated.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.
- 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:
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 closedPreparedStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method
-
setBinaryStream
Sets 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.
- 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:
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
Clears the current parameter values immediately.In general, parameter values remain in force for repeated use of a statement. Setting a parameter value automatically clears its previous value. However, in some cases it is useful to immediately release the resources used by the current parameter values; this can be done by calling the method
clearParameters.- Throws:
SQLException- if a database access error occurs or this method is called on a closedPreparedStatement
-
setObject
Sets 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.- 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:
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 PreparedStatementSQLFeatureNotSupportedException- if the JDBC driver does not support the specified targetSqlType- See Also:
-
setObject
Sets 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.
- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the object containing the input parameter value- Throws:
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
Executes 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).- Returns:
trueif the first result is aResultSetobject;falseif the first result is an update count or there is no result- Throws:
SQLException- if a database access error occurs; this method is called on a closedPreparedStatementor an argument is supplied to this methodSQLTimeoutException- 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:
-
addBatch
Adds a set of parameters to thisPreparedStatementobject's batch of commands.- Throws:
SQLException- if a database access error occurs or this method is called on a closedPreparedStatement- Since:
- 1.2
- See Also:
-
setCharacterStream
Sets 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.
- 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:
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:
- 1.2
-
setRef
Sets the designated parameter to the givenREF(<structured-type>)value. The driver converts this to an SQLREFvalue when it sends it to the database.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- an SQLREFvalue- Throws:
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 closedPreparedStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.2
-
setBlob
Sets the designated parameter to the givenjava.sql.Blobobject. The driver converts this to an SQLBLOBvalue when it sends it to the database.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- aBlobobject that maps an SQLBLOBvalue- Throws:
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 closedPreparedStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.2
-
setClob
Sets the designated parameter to the givenjava.sql.Clobobject. The driver converts this to an SQLCLOBvalue when it sends it to the database.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- aClobobject that maps an SQLCLOBvalue- Throws:
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 closedPreparedStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.2
-
setArray
Sets the designated parameter to the givenjava.sql.Arrayobject. The driver converts this to an SQLARRAYvalue when it sends it to the database.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- anArrayobject that maps an SQLARRAYvalue- Throws:
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 closedPreparedStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.2
-
getMetaData
Retrieves 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.
- Returns:
- the description of a
ResultSetobject's columns ornullif the driver cannot return aResultSetMetaDataobject - Throws:
SQLException- if a database access error occurs or this method is called on a closedPreparedStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.2
-
setDate
Sets 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.- 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:
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:
- 1.2
-
setTime
Sets 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.- 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:
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:
- 1.2
-
setTimestamp
Sets 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.- 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:
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:
- 1.2
-
setNull
Sets 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.
- 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:
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 closedPreparedStatementSQLFeatureNotSupportedException- 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:
- 1.2
-
setURL
Sets the designated parameter to the givenjava.net.URLvalue. The driver converts this to an SQLDATALINKvalue when it sends it to the database.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- thejava.net.URLobject to be set- Throws:
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 closedPreparedStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
-
getParameterMetaData
Retrieves the number, types and properties of thisPreparedStatementobject's parameters.- Returns:
- a
ParameterMetaDataobject that contains information about the number, types and properties for each parameter marker of thisPreparedStatementobject - Throws:
SQLException- if a database access error occurs or this method is called on a closedPreparedStatement- Since:
- 1.4
- See Also:
-
setRowId
Sets the designated parameter to the givenjava.sql.RowIdobject. The driver converts this to a SQLROWIDvalue when it sends it to the database- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
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 closedPreparedStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setNString
Sets 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.- Parameters:
parameterIndex- of the first parameter is 1, the second is 2, ...value- the parameter value- Throws:
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 closedPreparedStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setNCharacterStream
Sets 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.- 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:
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 closedPreparedStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setNClob
Sets the designated parameter to ajava.sql.NClobobject. The driver converts this to a SQLNCLOBvalue when it sends it to the database.- Parameters:
parameterIndex- of the first parameter is 1, the second is 2, ...value- the parameter value- Throws:
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 closedPreparedStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setClob
Sets 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- 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:
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.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setBlob
Sets 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 aBLOB- 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:
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.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setNClob
Sets 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- 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:
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 closedPreparedStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setSQLXML
Sets the designated parameter to the givenjava.sql.SQLXMLobject. The driver converts this to an SQLXMLvalue when it sends it to the database.- Parameters:
parameterIndex- index of the first parameter is 1, the second is 2, ...xmlObject- aSQLXMLobject that maps an SQLXMLvalue- Throws:
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 thejava.xml.transform.Result,WriterorOutputStreamhas not been closed for theSQLXMLobjectSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setObject
void setObject(int parameterIndex, Object x, int targetSqlType, int scaleOrLength) throws SQLException Sets 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.
- 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:
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 zeroSQLFeatureNotSupportedException- if the JDBC driver does not support the specified targetSqlType- See Also:
-
setAsciiStream
Sets 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.
- 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:
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:
- 1.6
-
setBinaryStream
Sets 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.
- 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:
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:
- 1.6
-
setCharacterStream
Sets 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.
- 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:
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:
- 1.6
-
setAsciiStream
Sets 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.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the Java input stream that contains the ASCII parameter value- Throws:
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 closedPreparedStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setBinaryStream
Sets 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.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the java input stream which contains the binary parameter value- Throws:
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 closedPreparedStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setCharacterStream
Sets 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.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...reader- thejava.io.Readerobject that contains the Unicode data- Throws:
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 closedPreparedStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setNCharacterStream
Sets 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.- Parameters:
parameterIndex- of the first parameter is 1, the second is 2, ...value- the parameter value- Throws:
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 closedPreparedStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setClob
Sets 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.- 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:
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 statementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setBlob
Sets 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.- 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:
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,SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setNClob
Sets 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.- 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:
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 closedPreparedStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setObject
default void setObject(int parameterIndex, Object x, SQLType targetSqlType, int scaleOrLength) throws SQLException Sets 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- 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:
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 zeroSQLFeatureNotSupportedException- if the JDBC driver does not support the specified targetSqlType- Since:
- 1.8
- See Also:
-
setObject
Sets 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- 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:
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 closedPreparedStatementSQLFeatureNotSupportedException- if the JDBC driver does not support the specified targetSqlType- Since:
- 1.8
- See Also:
-
executeLargeUpdate
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.This method should be used when the returned row count may exceed
Integer.MAX_VALUE.The default implementation will throw
UnsupportedOperationException- Returns:
- either (1) the row count for SQL Data Manipulation Language (DML) statements or (2) 0 for SQL statements that return nothing
- Throws:
SQLException- if a database access error occurs; this method is called on a closedPreparedStatementor the SQL statement returns aResultSetobjectSQLTimeoutException- 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
-
setCharacterStream