Module java.sql
Package java.sql

Interface PreparedStatement

All Superinterfaces:
AutoCloseable,Statement,Wrapper
All Known Subinterfaces:
CallableStatement
public interfacePreparedStatementextendsStatement
An object that represents a precompiled SQL statement.

A SQL statement is precompiled and stored in aPreparedStatement 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 typeINTEGER, then the methodsetInt should be used.

If arbitrary parameter type conversions are required, the methodsetObject 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:

  • Method Details

    • executeQuery

      ResultSet executeQuery() throwsSQLException
      Executes the SQL query in thisPreparedStatement object and returns theResultSet object generated by the query.
      Returns:
      aResultSet object that contains the data produced by the query; nevernull
      Throws:
      SQLException - if a database access error occurs; this method is called on a closedPreparedStatement or the SQL statement does not return aResultSet object
      SQLTimeoutException - when the driver has determined that the timeout value that was specified by thesetQueryTimeout method has been exceeded and has at least attempted to cancel the currently runningStatement

    • executeUpdate

      int executeUpdate() throwsSQLException
      Executes the SQL statement in thisPreparedStatement object, which must be an SQL Data Manipulation Language (DML) statement, such asINSERT,UPDATE orDELETE; 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 closedPreparedStatement or the SQL statement returns aResultSet object
      SQLTimeoutException - when the driver has determined that the timeout value that was specified by thesetQueryTimeout method has been exceeded and has at least attempted to cancel the currently runningStatement

    • setNull

      void setNull(int parameterIndex, int sqlType) throwsSQLException
      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 closedPreparedStatement
      SQLFeatureNotSupportedException - ifsqlType is aARRAY,BLOB,CLOB,DATALINK,JAVA_OBJECT,NCHAR,NCLOB,NVARCHAR,LONGNVARCHAR,REF,ROWID,SQLXML orSTRUCT data type and the JDBC driver does not support this data type

    • setBoolean

      void setBoolean(int parameterIndex, boolean x) throwsSQLException
      Sets the designated parameter to the given Javaboolean value. The driver converts this to an SQLBIT orBOOLEAN value 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

      void setByte(int parameterIndex, byte x) throwsSQLException
      Sets the designated parameter to the given Javabyte value. The driver converts this to an SQLTINYINT value 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

      void setShort(int parameterIndex, short x) throwsSQLException
      Sets the designated parameter to the given Javashort value. The driver converts this to an SQLSMALLINT value 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

      void setInt(int parameterIndex, int x) throwsSQLException
      Sets the designated parameter to the given Javaint value. The driver converts this to an SQLINTEGER value 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

      void setLong(int parameterIndex, long x) throwsSQLException
      Sets the designated parameter to the given Javalong value. The driver converts this to an SQLBIGINT value 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

      void setFloat(int parameterIndex, float x) throwsSQLException
      Sets the designated parameter to the given Javafloat value. The driver converts this to an SQLREAL value 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

      void setDouble(int parameterIndex, double x) throwsSQLException
      Sets the designated parameter to the given Javadouble value. The driver converts this to an SQLDOUBLE value 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

      void setBigDecimal(int parameterIndex,BigDecimal x) throwsSQLException
      Sets the designated parameter to the givenjava.math.BigDecimal value. The driver converts this to an SQLNUMERIC value 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

      void setString(int parameterIndex,String x) throwsSQLException
      Sets the designated parameter to the given JavaString value. The driver converts this to an SQLVARCHAR orLONGVARCHAR value (depending on the argument's size relative to the driver's limits onVARCHAR values) 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

      void setBytes(int parameterIndex, byte[] x) throwsSQLException
      Sets the designated parameter to the given Java array of bytes. The driver converts this to an SQLVARBINARY orLONGVARBINARY (depending on the argument's size relative to the driver's limits onVARBINARY values) 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

      void setDate(int parameterIndex,Date x) throwsSQLException
      Sets the designated parameter to the givenjava.sql.Date value using the default time zone of the virtual machine that is running the application. The driver converts this to an SQLDATE value 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

      void setTime(int parameterIndex,Time x) throwsSQLException
      Sets the designated parameter to the givenjava.sql.Time value. The driver converts this to an SQLTIME value 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

      void setTimestamp(int parameterIndex,Timestamp x) throwsSQLException
      Sets the designated parameter to the givenjava.sql.Timestamp value. The driver converts this to an SQLTIMESTAMP value 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

      void setAsciiStream(int parameterIndex,InputStream x, int length) throwsSQLException
      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 aLONGVARCHAR parameter, 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 value
      length - 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) throwsSQLException
      Deprecated.
      UsesetCharacterStream
      Sets 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 aLONGVARCHAR parameter, it may be more practical to send it via ajava.io.InputStream object. 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 theJava 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.InputStream object that contains the Unicode parameter value
      length - 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
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method

    • setBinaryStream

      void setBinaryStream(int parameterIndex,InputStream x, int length) throwsSQLException
      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 aLONGVARBINARY parameter, it may be more practical to send it via ajava.io.InputStream object. 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 value
      length - 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

      void clearParameters() throwsSQLException
      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 methodclearParameters.

      Throws:
      SQLException - if a database access error occurs or this method is called on a closedPreparedStatement

    • setObject

      void setObject(int parameterIndex,Object x, int targetSqlType) throwsSQLException
      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 value
      targetSqlType - 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 PreparedStatement
      SQLFeatureNotSupportedException - if the JDBC driver does not support the specified targetSqlType
      See Also:

    • setObject

      void setObject(int parameterIndex,Object x) throwsSQLException

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

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

      Note that this method may be used to pass database- specific abstract data types, by using a driver-specific Java type. If the object is of a class implementing the interfaceSQLData, the JDBC driver should call the methodSQLData.writeSQL to 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,SQLXML orArray, 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, thesetNull or 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 closedPreparedStatement or the type of the given object is ambiguous

    • execute

      boolean execute() throwsSQLException
      Executes the SQL statement in thisPreparedStatement object, which may be any kind of SQL statement. Some prepared statements return multiple results; theexecute method handles these complex statements as well as the simpler form of statements handled by the methodsexecuteQuery andexecuteUpdate.

      Theexecute method returns aboolean to indicate the form of the first result. You must call either the methodgetResultSet orgetUpdateCount to retrieve the result; you must callgetMoreResults to move to any subsequent result(s).

      Returns:
      true if the first result is aResultSet object;false if 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 closedPreparedStatement or an argument is supplied to this method
      SQLTimeoutException - when the driver has determined that the timeout value that was specified by thesetQueryTimeout method has been exceeded and has at least attempted to cancel the currently runningStatement
      See Also:

    • addBatch

      void addBatch() throwsSQLException
      Adds a set of parameters to thisPreparedStatement object'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

      void setCharacterStream(int parameterIndex,Reader reader, int length) throwsSQLException
      Sets the designated parameter to the givenReader object, which is the given number of characters long. When a very large UNICODE value is input to aLONGVARCHAR parameter, it may be more practical to send it via ajava.io.Reader object. 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.Reader object that contains the Unicode data
      length - 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

      void setRef(int parameterIndex,Ref x) throwsSQLException
      Sets the designated parameter to the givenREF(<structured-type>) value. The driver converts this to an SQLREF value when it sends it to the database.
      Parameters:
      parameterIndex - the first parameter is 1, the second is 2, ...
      x - an SQLREF 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
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.2

    • setBlob

      void setBlob(int parameterIndex,Blob x) throwsSQLException
      Sets the designated parameter to the givenjava.sql.Blob object. The driver converts this to an SQLBLOB value when it sends it to the database.
      Parameters:
      parameterIndex - the first parameter is 1, the second is 2, ...
      x - aBlob object that maps an SQLBLOB 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
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.2

    • setClob

      void setClob(int parameterIndex,Clob x) throwsSQLException
      Sets the designated parameter to the givenjava.sql.Clob object. The driver converts this to an SQLCLOB value when it sends it to the database.
      Parameters:
      parameterIndex - the first parameter is 1, the second is 2, ...
      x - aClob object that maps an SQLCLOB 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
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.2

    • setArray

      void setArray(int parameterIndex,Array x) throwsSQLException
      Sets the designated parameter to the givenjava.sql.Array object. The driver converts this to an SQLARRAY value when it sends it to the database.
      Parameters:
      parameterIndex - the first parameter is 1, the second is 2, ...
      x - anArray object that maps an SQLARRAY 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
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.2

    • getMetaData

      ResultSetMetaData getMetaData() throwsSQLException
      Retrieves aResultSetMetaData object that contains information about the columns of theResultSet object that will be returned when thisPreparedStatement object is executed.

      Because aPreparedStatement object is precompiled, it is possible to know about theResultSet object that it will return without having to execute it. Consequently, it is possible to invoke the methodgetMetaData on aPreparedStatement object rather than waiting to execute it and then invoking theResultSet.getMetaData method on theResultSet object 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 aResultSet object's columns ornull if the driver cannot return aResultSetMetaData object
      Throws:
      SQLException - if a database access error occurs or this method is called on a closedPreparedStatement
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.2

    • setDate

      void setDate(int parameterIndex,Date x,Calendar cal) throwsSQLException
      Sets the designated parameter to the givenjava.sql.Date value, using the givenCalendar object. The driver uses theCalendar object to construct an SQLDATE value, which the driver then sends to the database. With aCalendar object, the driver can calculate the date taking into account a custom timezone. If noCalendar object 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 value
      cal - theCalendar object 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

      void setTime(int parameterIndex,Time x,Calendar cal) throwsSQLException
      Sets the designated parameter to the givenjava.sql.Time value, using the givenCalendar object. The driver uses theCalendar object to construct an SQLTIME value, which the driver then sends to the database. With aCalendar object, the driver can calculate the time taking into account a custom timezone. If noCalendar object 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 value
      cal - theCalendar object 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

      void setTimestamp(int parameterIndex,Timestamp x,Calendar cal) throwsSQLException
      Sets the designated parameter to the givenjava.sql.Timestamp value, using the givenCalendar object. The driver uses theCalendar object to construct an SQLTIMESTAMP value, which the driver then sends to the database. With aCalendar object, the driver can calculate the timestamp taking into account a custom timezone. If noCalendar object 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 value
      cal - theCalendar object 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

      void setNull(int parameterIndex, int sqlType,String typeName) throwsSQLException
      Sets the designated parameter to SQLNULL. This version of the methodsetNull should be used for user-defined types and REF type parameters. Examples of user-defined types include: STRUCT, DISTINCT, JAVA_OBJECT, and named array types.

      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.Types
      typeName - the fully-qualified name of an SQL user-defined type; ignored if the parameter is not a user-defined type or REF
      Throws:
      SQLException - 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
      SQLFeatureNotSupportedException - ifsqlType is aARRAY,BLOB,CLOB,DATALINK,JAVA_OBJECT,NCHAR,NCLOB,NVARCHAR,LONGNVARCHAR,REF,ROWID,SQLXML orSTRUCT data 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

      void setURL(int parameterIndex,URL x) throwsSQLException
      Sets the designated parameter to the givenjava.net.URL value. The driver converts this to an SQLDATALINK value when it sends it to the database.
      Parameters:
      parameterIndex - the first parameter is 1, the second is 2, ...
      x - thejava.net.URL object 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 closedPreparedStatement
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.4

    • getParameterMetaData

      ParameterMetaData getParameterMetaData() throwsSQLException
      Retrieves the number, types and properties of thisPreparedStatement object's parameters.
      Returns:
      aParameterMetaData object that contains information about the number, types and properties for each parameter marker of thisPreparedStatement object
      Throws:
      SQLException - if a database access error occurs or this method is called on a closedPreparedStatement
      Since:
      1.4
      See Also:

    • setRowId

      void setRowId(int parameterIndex,RowId x) throwsSQLException
      Sets the designated parameter to the givenjava.sql.RowId object. The driver converts this to a SQLROWID value 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
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.6

    • setNString

      void setNString(int parameterIndex,String value) throwsSQLException
      Sets the designated parameter to the givenString object. The driver converts this to a SQLNCHAR orNVARCHAR orLONGNVARCHAR value (depending on the argument's size relative to the driver's limits onNVARCHAR values) 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 closedPreparedStatement
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.6

    • setNCharacterStream

      void setNCharacterStream(int parameterIndex,Reader value, long length) throwsSQLException
      Sets the designated parameter to aReader object. TheReader reads the data till end-of-file is reached. The driver does the necessary conversion from Java character format to the national character set in the database.
      Parameters:
      parameterIndex - of the first parameter is 1, the second is 2, ...
      value - the parameter value
      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 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 closedPreparedStatement
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.6

    • setNClob

      void setNClob(int parameterIndex,NClob value) throwsSQLException
      Sets the designated parameter to ajava.sql.NClob object. The driver converts this to a SQLNCLOB value 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 closedPreparedStatement
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.6

    • setClob

      void setClob(int parameterIndex,Reader reader, long length) throwsSQLException
      Sets the designated parameter to aReader object. The reader must contain the number of characters specified by length otherwise aSQLException will be generated when thePreparedStatement is 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 thesetCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGVARCHAR or 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 closedPreparedStatement or if the length specified is less than zero.
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.6

    • setBlob

      void setBlob(int parameterIndex,InputStream inputStream, long length) throwsSQLException
      Sets the designated parameter to aInputStream object. TheInputstream must contain the number of characters specified by length otherwise aSQLException will be generated when thePreparedStatement is 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 thesetBinaryStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGVARBINARY or 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 theInputStream does not match the specified length.
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.6

    • setNClob

      void setNClob(int parameterIndex,Reader reader, long length) throwsSQLException
      Sets the designated parameter to aReader object. The reader must contain the number of characters specified by length otherwise aSQLException will be generated when thePreparedStatement is 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 thesetCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGNVARCHAR or 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 closedPreparedStatement
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.6

    • setSQLXML

      void setSQLXML(int parameterIndex,SQLXML xmlObject) throwsSQLException
      Sets the designated parameter to the givenjava.sql.SQLXML object. The driver converts this to an SQLXML value when it sends it to the database.
      Parameters:
      parameterIndex - index of the first parameter is 1, the second is 2, ...
      xmlObject - aSQLXML object that maps an SQLXML 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 closedPreparedStatement or thejava.xml.transform.Result,Writer orOutputStream has not been closed for theSQLXML object
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.6

    • setObject

      void setObject(int parameterIndex,Object x, int targetSqlType, int scaleOrLength) throwsSQLException

      Sets the value of the designated parameter with the given object. If the second argument is anInputStream then the stream must contain the number of bytes specified by scaleOrLength. If the second argument is aReader then the reader must contain the number of characters specified by scaleOrLength. If these conditions are not true the driver will generate aSQLException when the prepared statement is executed.

      The given Java object will be converted to the given targetSqlType before being sent to the database. If the object has a custom mapping (is of a class implementing the interfaceSQLData), the JDBC driver should call the methodSQLData.writeSQL to 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 value
      targetSqlType - 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.DECIMAL orjava.sql.Types.NUMERIC types, this is the number of digits after the decimal point. For Java Object typesInputStream andReader, 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 closedPreparedStatement or if the Java Object specified by x is an InputStream or Reader object and the value of the scale parameter is less than zero
      SQLFeatureNotSupportedException - if the JDBC driver does not support the specified targetSqlType
      See Also:

    • setAsciiStream

      void setAsciiStream(int parameterIndex,InputStream x, long length) throwsSQLException
      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 aLONGVARCHAR parameter, 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 value
      length - 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

      void setBinaryStream(int parameterIndex,InputStream x, long length) throwsSQLException
      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 aLONGVARBINARY parameter, it may be more practical to send it via ajava.io.InputStream object. 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 value
      length - 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

      void setCharacterStream(int parameterIndex,Reader reader, long length) throwsSQLException
      Sets the designated parameter to the givenReader object, which is the given number of characters long. When a very large UNICODE value is input to aLONGVARCHAR parameter, it may be more practical to send it via ajava.io.Reader object. 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.Reader object that contains the Unicode data
      length - 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

      void setAsciiStream(int parameterIndex,InputStream x) throwsSQLException
      Sets the designated parameter to the given input stream. When a very large ASCII value is input to aLONGVARCHAR parameter, 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 ofsetAsciiStream which 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 closedPreparedStatement
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.6

    • setBinaryStream

      void setBinaryStream(int parameterIndex,InputStream x) throwsSQLException
      Sets the designated parameter to the given input stream. When a very large binary value is input to aLONGVARBINARY parameter, it may be more practical to send it via ajava.io.InputStream object. 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 ofsetBinaryStream which 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 closedPreparedStatement
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.6

    • setCharacterStream

      void setCharacterStream(int parameterIndex,Reader reader) throwsSQLException
      Sets the designated parameter to the givenReader object. When a very large UNICODE value is input to aLONGVARCHAR parameter, it may be more practical to send it via ajava.io.Reader object. 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 ofsetCharacterStream which takes a length parameter.

      Parameters:
      parameterIndex - the first parameter is 1, the second is 2, ...
      reader - thejava.io.Reader object 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 closedPreparedStatement
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.6

    • setNCharacterStream

      void setNCharacterStream(int parameterIndex,Reader value) throwsSQLException
      Sets the designated parameter to aReader object. TheReader reads the data till end-of-file is reached. The driver does the necessary conversion from Java character format to the national character set in the database.

      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 ofsetNCharacterStream which 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 closedPreparedStatement
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.6

    • setClob

      void setClob(int parameterIndex,Reader reader) throwsSQLException
      Sets the designated parameter to aReader object. 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 thesetCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGVARCHAR or aCLOB

      Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version ofsetClob which 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 statement
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.6

    • setBlob

      void setBlob(int parameterIndex,InputStream inputStream) throwsSQLException
      Sets the designated parameter to aInputStream object. 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 thesetBinaryStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGVARBINARY or aBLOB

      Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version ofsetBlob which 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 closedPreparedStatement or 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

      void setNClob(int parameterIndex,Reader reader) throwsSQLException
      Sets the designated parameter to aReader object. 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 thesetCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGNVARCHAR or aNCLOB

      Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version ofsetNClob which 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 closedPreparedStatement
      SQLFeatureNotSupportedException - if the JDBC driver does not support this method
      Since:
      1.6

    • setObject

      default void setObject(int parameterIndex,Object x,SQLType targetSqlType, int scaleOrLength) throwsSQLException

      Sets the value of the designated parameter with the given object. If the second argument is anInputStream then the stream must contain the number of bytes specified by scaleOrLength. If the second argument is aReader then the reader must contain the number of characters specified by scaleOrLength. If these conditions are not true the driver will generate aSQLException when the prepared statement is executed.

      The given Java object will be converted to the given targetSqlType before being sent to the database. If the object has a custom mapping (is of a class implementing the interfaceSQLData), the JDBC driver should call the methodSQLData.writeSQL to 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 throwSQLFeatureNotSupportedException

      Parameters:
      parameterIndex - the first parameter is 1, the second is 2, ...
      x - the object containing the input parameter value
      targetSqlType - the SQL type to be sent to the database. The scale argument may further qualify this type.
      scaleOrLength - forjava.sql.JDBCType.DECIMAL orjava.sql.JDBCType.NUMERIC types, this is the number of digits after the decimal point. For Java Object typesInputStream andReader, 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 closedPreparedStatement or if the Java Object specified by x is an InputStream or Reader object and the value of the scale parameter is less than zero
      SQLFeatureNotSupportedException - if the JDBC driver does not support the specified targetSqlType
      Since:
      1.8
      See Also:

    • setObject

      default void setObject(int parameterIndex,Object x,SQLType targetSqlType) throwsSQLException
      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 throwSQLFeatureNotSupportedException

      Parameters:
      parameterIndex - the first parameter is 1, the second is 2, ...
      x - the object containing the input parameter value
      targetSqlType - 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 closedPreparedStatement
      SQLFeatureNotSupportedException - if the JDBC driver does not support the specified targetSqlType
      Since:
      1.8
      See Also:

    • executeLargeUpdate

      default long executeLargeUpdate() throwsSQLException
      Executes the SQL statement in thisPreparedStatement object, which must be an SQL Data Manipulation Language (DML) statement, such asINSERT,UPDATE orDELETE; or an SQL statement that returns nothing, such as a DDL statement.

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

      The default implementation will throwUnsupportedOperationException

      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 closedPreparedStatement or the SQL statement returns aResultSet object
      SQLTimeoutException - when the driver has determined that the timeout value that was specified by thesetQueryTimeout method has been exceeded and has at least attempted to cancel the currently runningStatement
      Since:
      1.8