Java Doc for PreparedStatement.java in  » Apache-Harmony-Java-SE » java-package » java » sql » Java Source Code / Java DocumentationJava Source Code and Java Documentation

An SQL Statement is put into a PreparedStatement and is precompiled so that it can be executed multiple times efficiently.

Setter methods are supplied in the PreparedStatement interface for the setting of IN parameters for the Statement. The setter method used for each IN parameter must match the type of the IN parameter being set.

Typically, parameter values are retained for multiple executions of the Statement.

A PreparedStatement may return multiple results.

It is possible to know the Metadata for the ResultSet without executing the PreparedStatement, because the PreparedStatement is precompiled.

This is a good method for setting an SQL LONVARCHAR parameter where the length of the data is large.

There is a standard mapping from Java types to SQL types, defined in the JDBC specification.

The Object is converted to the target SQL type before it is added to the database.

The Object is converted to the target SQL type before it is added to the database.

Typically, parameter values are retained for multiple executions of the Statement. Setting a parameter value replaces the previous value. This method clears the values for all parameters, releasing all resources used by those parameters.
throws:
  SQLException - if a database error happens

A PreparedStatement may return multiple results. The execute method returns a flag indicating the kind of result produced by PreparedStatement. The methods getResultSet or getUpdateCount are used to retrieve the first result, while getMoreResults must be used to retrieve the second and subsequent results. true if the result of the execution is a ResultSet, false ifthere is no result or if the result is an update count.
throws:
  SQLException - if a database error happens

It is possible to know the Metadata for the ResultSet without executing the PreparedStatement, because the PreparedStatement is precompiled. As a result the Metadata can be queried ahead of time without actually executing the statement. a ResultSetMetaData object with the information about the columnsof the ResultSet, if the driver can return a ResultSetMetaData.null otherwise.
throws:
  SQLException - if there is a database error

This is a good method for setting an SQL LONVARCHAR parameter where the length of the data is large. Data is read from the InputStream until end-of-file is reached or the specified number of bytes is copied.
Parameters:
  parameterIndex - the parameter number index, where the first parameter hasindex 1
Parameters:
  theInputStream - the ASCII InputStream carrying the data to update theparameter
Parameters:
  length - the number of bytes in the InputStream to copy to theparameter
throws:
  SQLException - if a database error happens

Use this method when a large amount of data needs to be set into a LONGVARBINARY parameter.
Parameters:
  parameterIndex - the parameter number index, where the first parameter hasindex 1
Parameters:
  theInputStream - the binary InputStream carrying the data to update theparameter
Parameters:
  length - the number of bytes in the InputStream to copy to theparameter
throws:
  SQLException - if a database error happens

Applications must provide the SQL Type code and also a fully qualified SQL Type name when supplying a NULL UDT or REF. For a UDT, the type name is the type name of the parameter itself, but for a REF parameter the type name is the type name of the referenced type.
Parameters:
  paramIndex - the parameter number index, where the first parameter hasindex 1
Parameters:
  sqlType - the SQL Type of the parameter, as defined in java.sql.Types
Parameters:
  typeName - the fully qualified name of a UDT or REF type - ignored if theparameter is not a UDT.
throws:
  SQLException - if a database error happens

There is a standard mapping from Java types to SQL types, defined in the JDBC specification. The passed object is then transformed into the appropriate SQL type, and then transferred to the database. setObject can be used to pass abstract data types unique to the database, by using a JDBC driver specific Java type. If the object's class implements the interface SQLData, the JDBC driver calls SQLData.writeSQL to write it to the SQL data stream. If the object's class implements Ref, Blob, Clob, Struct, or Array, the driver passes it to the database as a value of the corresponding SQL type.
Parameters:
  parameterIndex - the parameter number index, where the first parameter hasindex 1
Parameters:
  theObject - the Object containing the value to update the parameter
throws:
  SQLException - if a database error happens

The Object is converted to the target SQL type before it is added to the database. If the Object is an instance of SQLData then SQLData.writeSQL is called to write out its data.

The Object is converted to the target SQL type before it is added to the database. If the Object is an instance of SQLData then SQLData.writeSQL is called to write out its data.

The driver uses the supplied Calendar to create the SQL TIME value, which allows it to use a custom timezone - otherwise the driver uses the default timezone of the Java virtual machine.
Parameters:
  parameterIndex - the parameter number index, where the first parameter hasindex 1
Parameters:
  theTime - a java.sql.Time value to update the parameter
Parameters:
  cal - a Calendar to use to construct the SQL TIME value
throws:
  SQLException - if a database error happens

The driver uses the supplied Calendar to create the SQL TIMESTAMP value, which allows it to use a custom timezone - otherwise the driver uses the default timezone of the Java virtual machine.
Parameters:
  parameterIndex - the parameter number index, where the first parameter hasindex 1
Parameters:
  theTimestamp - the java.sql.Timestamp value to update the parameter
Parameters:
  cal - a Calendar to use to construct the SQL TIMESTAMP value
throws:
  SQLException - if a database error happens