|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.drizzle.jdbc.DrizzleStatement
org.drizzle.jdbc.DrizzlePreparedStatement
public class DrizzlePreparedStatement
User: marcuse Date: Jan 27, 2009 Time: 10:49:42 PM
| Field Summary |
|---|
| Fields inherited from interface java.sql.Statement |
|---|
CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO |
| Constructor Summary | |
|---|---|
DrizzlePreparedStatement(Protocol protocol,
DrizzleConnection drizzleConnection,
java.lang.String query,
QueryFactory queryFactory,
ParameterizedBatchHandler parameterizedBatchHandler)
|
|
| Method Summary | |
|---|---|
void |
addBatch()
Adds a set of parameters to this PreparedStatement object's batch of commands. |
void |
clearParameters()
Clears the current parameter values immediately. |
boolean |
execute()
|
int[] |
executeBatch()
Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts. |
java.sql.ResultSet |
executeQuery()
|
int |
executeUpdate()
Executes the SQL statement in this PreparedStatement object, which must be an SQL Data Manipulation
Language (DML) statement, such as INSERT, UPDATE or DELETE; or an SQL
statement that returns nothing, such as a DDL statement. |
java.sql.ResultSetMetaData |
getMetaData()
Retrieves a ResultSetMetaData object that contains information about the columns of the
ResultSet object that will be returned when this PreparedStatement object is executed. |
java.sql.ParameterMetaData |
getParameterMetaData()
Retrieves the number, types and properties of this PreparedStatement object's parameters. |
void |
setArray(int parameterIndex,
java.sql.Array x)
Sets the designated parameter to the given java.sql.Array object. |
void |
setAsciiStream(int parameterIndex,
java.io.InputStream x)
This function reads up the entire stream and stores it in memory since we need to know the length when sending it to the server use the corresponding method with a length parameter if memory is an issue Sets the designated parameter to the given input stream. |
void |
setAsciiStream(int parameterIndex,
java.io.InputStream x,
int length)
Sets the designated parameter to the given input stream, which will have the specified number of bytes. |
void |
setAsciiStream(int parameterIndex,
java.io.InputStream x,
long length)
Sets the designated parameter to the given input stream, which will have the specified number of bytes. |
void |
setBigDecimal(int parameterIndex,
java.math.BigDecimal x)
Sets the designated parameter to the given java.math.BigDecimal value. |
void |
setBinaryStream(int parameterIndex,
java.io.InputStream x)
This function reads up the entire stream and stores it in memory since we need to know the length when sending it to the server Sets the designated parameter to the given input stream. |
void |
setBinaryStream(int parameterIndex,
java.io.InputStream x,
int length)
Sets the designated parameter to the given input stream, which will have the specified number of bytes. |
void |
setBinaryStream(int parameterIndex,
java.io.InputStream x,
long length)
Sets the designated parameter to the given input stream, which will have the specified number of bytes. |
void |
setBlob(int parameterIndex,
java.sql.Blob x)
Sets the designated parameter to the given java.sql.Blob object. |
void |
setBlob(int parameterIndex,
java.io.InputStream inputStream)
Sets the designated parameter to a InputStream object. |
void |
setBlob(int parameterIndex,
java.io.InputStream inputStream,
long length)
Sets the designated parameter to a InputStream object. |
void |
setBoolean(int column,
boolean value)
|
void |
setByte(int parameterIndex,
byte x)
Sets the designated parameter to the given Java byte value. |
void |
setBytes(int parameterIndex,
byte[] x)
Sets the designated parameter to the given Java array of bytes. |
void |
setCharacterStream(int parameterIndex,
java.io.Reader reader)
Sets the designated parameter to the given Reader object. |
void |
setCharacterStream(int parameterIndex,
java.io.Reader reader,
int length)
Sets the designated parameter to the given Reader object, which is the given number of characters
long. |
void |
setCharacterStream(int parameterIndex,
java.io.Reader reader,
long length)
Sets the designated parameter to the given Reader object, which is the given number of characters
long. |
void |
setClob(int parameterIndex,
java.sql.Clob x)
Sets the designated parameter to the given java.sql.Clob object. |
void |
setClob(int parameterIndex,
java.io.Reader reader)
Sets the designated parameter to a Reader object. |
void |
setClob(int parameterIndex,
java.io.Reader reader,
long length)
Sets the designated parameter to a Reader object. |
void |
setDate(int parameterIndex,
java.sql.Date date)
Sets the designated parameter to the given java.sql.Date value using the default time zone of the
virtual machine that is running the application. |
void |
setDate(int parameterIndex,
java.sql.Date date,
java.util.Calendar cal)
Sets the designated parameter to the given java.sql.Date value, using the given
Calendar object. |
void |
setDouble(int parameterIndex,
double x)
Sets the designated parameter to the given Java double value. |
void |
setFloat(int parameterIndex,
float x)
Sets the designated parameter to the given Java float value. |
void |
setInt(int column,
int i)
|
void |
setLong(int parameterIndex,
long x)
Sets the designated parameter to the given Java long value. |
void |
setNCharacterStream(int parameterIndex,
java.io.Reader value)
Sets the designated parameter to a Reader object. |
void |
setNCharacterStream(int parameterIndex,
java.io.Reader value,
long length)
Sets the designated parameter to a Reader object. |
void |
setNClob(int parameterIndex,
java.sql.NClob value)
Sets the designated parameter to a java.sql.NClob object. |
void |
setNClob(int parameterIndex,
java.io.Reader reader)
Sets the designated parameter to a Reader object. |
void |
setNClob(int parameterIndex,
java.io.Reader reader,
long length)
Sets the designated parameter to a Reader object. |
void |
setNString(int parameterIndex,
java.lang.String value)
Sets the designated paramter to the given String object. |
void |
setNull(int parameterIndex,
int sqlType)
Sets the designated parameter to SQL NULL. |
void |
setNull(int parameterIndex,
int sqlType,
java.lang.String typeName)
Sets the designated parameter to SQL NULL. |
void |
setObject(int parameterIndex,
java.lang.Object x)
Sets the value of the designated parameter using the given object. |
void |
setObject(int parameterIndex,
java.lang.Object x,
int targetSqlType)
Sets the value of the designated parameter with the given object. |
void |
setObject(int parameterIndex,
java.lang.Object x,
int targetSqlType,
int scaleOrLength)
Sets the value of the designated parameter with the given object. |
void |
setRef(int parameterIndex,
java.sql.Ref x)
Sets the designated parameter to the given REF(<structured-type>) value. |
void |
setRowId(int parameterIndex,
java.sql.RowId x)
Sets the designated parameter to the given java.sql.RowId object. |
void |
setShort(int parameterIndex,
short x)
Sets the designated parameter to the given Java short value. |
void |
setSQLXML(int parameterIndex,
java.sql.SQLXML xmlObject)
Sets the designated parameter to the given java.sql.SQLXML object. |
void |
setString(int column,
java.lang.String s)
|
void |
setTime(int parameterIndex,
java.sql.Time x)
Since Drizzle has no TIME datatype, time in milliseconds is stored in a packed integer |
void |
setTime(int parameterIndex,
java.sql.Time time,
java.util.Calendar cal)
Sets the designated parameter to the given java.sql.Time value, using the given
Calendar object. |
void |
setTimestamp(int parameterIndex,
java.sql.Timestamp x)
Sets the designated parameter to the given java.sql.Timestamp value. |
void |
setTimestamp(int parameterIndex,
java.sql.Timestamp x,
java.util.Calendar cal)
Sets the designated parameter to the given java.sql.Timestamp value, using the given
Calendar object. |
void |
setUnicodeStream(int parameterIndex,
java.io.InputStream x,
int length)
Deprecated. |
void |
setURL(int parameterIndex,
java.net.URL x)
Sets the designated parameter to the given java.net.URL value. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface java.sql.Statement |
|---|
addBatch, cancel, clearBatch, clearWarnings, close, execute, execute, execute, execute, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isClosed, isPoolable, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout |
| Methods inherited from interface java.sql.Wrapper |
|---|
isWrapperFor, unwrap |
| Constructor Detail |
|---|
public DrizzlePreparedStatement(Protocol protocol,
DrizzleConnection drizzleConnection,
java.lang.String query,
QueryFactory queryFactory,
ParameterizedBatchHandler parameterizedBatchHandler)
| Method Detail |
|---|
public java.sql.ResultSet executeQuery()
throws java.sql.SQLException
executeQuery in interface java.sql.PreparedStatementjava.sql.SQLException
public int executeUpdate()
throws java.sql.SQLException
PreparedStatement object, which must be an SQL Data Manipulation
Language (DML) statement, such as INSERT, UPDATE or DELETE; or an SQL
statement that returns nothing, such as a DDL statement.
executeUpdate in interface java.sql.PreparedStatementjava.sql.SQLException - if a database access error occurs; this method is called on a closed
PreparedStatement or the SQL statement returns a
ResultSet object
public void setNull(int parameterIndex,
int sqlType)
throws java.sql.SQLException
NULL.
Note: You must specify the parameter's SQL type.
setNull in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...sqlType - the SQL type code defined in java.sql.Types
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs or this method is called on a closed
PreparedStatement
java.sql.SQLFeatureNotSupportedException - if sqlType is a ARRAY, BLOB,
CLOB, DATALINK, JAVA_OBJECT,
NCHAR, NCLOB, NVARCHAR,
LONGNVARCHAR, REF, ROWID,
SQLXML or STRUCT data type and the JDBC driver does not
support this data type
public boolean execute()
throws java.sql.SQLException
execute in interface java.sql.PreparedStatementjava.sql.SQLException
public void addBatch()
throws java.sql.SQLException
PreparedStatement object's batch of commands.
addBatch in interface java.sql.PreparedStatementjava.sql.SQLException - if a database access error occurs or this method is called on a closed
PreparedStatementStatement.addBatch(java.lang.String)
public int[] executeBatch()
throws java.sql.SQLException
DrizzleStatementint elements of the array that is returned are ordered to correspond to
the commands in the batch, which are ordered according to the order in which they were added to the batch. The
elements in the array returned by the method executeBatch may be one of the following: SUCCESS_NO_INFO -- indicates that the command was processed successfully but that the number of rows
affected is unknown
If one of the commands in a batch update fails to execute properly, this method throws a
BatchUpdateException, and a JDBC driver may or may not continue to process the remaining commands in
the batch. However, the driver's behavior must be consistent with a particular DBMS, either always continuing to
process commands or never continuing to process commands. If the driver continues processing after a failure,
the array returned by the method BatchUpdateException.getUpdateCounts will contain as many elements
as there are commands in the batch, and at least one of the elements will be the following:
EXECUTE_FAILED -- indicates that the command failed to execute successfully and
occurs only if a driver continues to process commands after a command fails BatchUpdateException obejct has been thrown.
executeBatch in interface java.sql.StatementexecuteBatch in class DrizzleStatementjava.sql.SQLException - if a database access error occurs, this method is called on a closed
Statement or the driver does not support batch statements. Throws
BatchUpdateException (a subclass of SQLException) if
one of the commands sent to the database fails to execute properly or attempts to
return a result set.DrizzleStatement.addBatch(java.lang.String),
DatabaseMetaData.supportsBatchUpdates()
public void setCharacterStream(int parameterIndex,
java.io.Reader reader,
int length)
throws java.sql.SQLException
Reader object, which is the given number of characters
long. When a very large UNICODE value is input to a LONGVARCHAR parameter, it may be more practical
to send it via a java.io.Reader 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.
setCharacterStream in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...reader - the java.io.Reader object that contains the Unicode datalength - the number of characters in the stream
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs or this method is called on a closed
PreparedStatement
public void setRef(int parameterIndex,
java.sql.Ref x)
throws java.sql.SQLException
REF(<structured-type>) value. The driver converts
this to an SQL REF value when it sends it to the database.
setRef in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - an SQL REF value
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs or this method is called on a closed
PreparedStatement
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
public void setBlob(int parameterIndex,
java.sql.Blob x)
throws java.sql.SQLException
java.sql.Blob object. The driver converts this to an SQL
BLOB value when it sends it to the database.
setBlob in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - a Blob object that maps an SQL BLOB value
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs or this method is called on a closed
PreparedStatement
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
public void setClob(int parameterIndex,
java.sql.Clob x)
throws java.sql.SQLException
java.sql.Clob object. The driver converts this to an SQL
CLOB value when it sends it to the database.
setClob in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - a Clob object that maps an SQL CLOB value
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs or this method is called on a closed
PreparedStatement
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
public void setArray(int parameterIndex,
java.sql.Array x)
throws java.sql.SQLException
java.sql.Array object. The driver converts this to an SQL
ARRAY value when it sends it to the database.
setArray in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - an Array object that maps an SQL ARRAY value
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs or this method is called on a closed
PreparedStatement
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
public java.sql.ResultSetMetaData getMetaData()
throws java.sql.SQLException
ResultSetMetaData object that contains information about the columns of the
ResultSet object that will be returned when this PreparedStatement object is executed.
Because a PreparedStatement object is precompiled, it is possible to know about the
ResultSet object that it will return without having to execute it. Consequently, it is possible to
invoke the method getMetaData on a PreparedStatement object rather than waiting to
execute it and then invoking the ResultSet.getMetaData method on the ResultSet object
that is returned.
NOTE: Using this method may be expensive for some drivers due to the lack of underlying DBMS support.
getMetaData in interface java.sql.PreparedStatementResultSet object's columns or null if the driver cannot
return a ResultSetMetaData object
java.sql.SQLException - if a database access error occurs or this method is called on a closed
PreparedStatement
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
public void setDate(int parameterIndex,
java.sql.Date date,
java.util.Calendar cal)
throws java.sql.SQLException
java.sql.Date value, using the given
Calendar object. The driver uses the Calendar object to construct an SQL
DATE value, which the driver then sends to the database. With a Calendar object, the
driver can calculate the date taking into account a custom timezone. If no Calendar object is
specified, the driver uses the default timezone, which is that of the virtual machine running the application.
setDate in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...date - the parameter valuecal - the Calendar object the driver will use to construct the date
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs or this method is called on a closed
PreparedStatement
public void setTime(int parameterIndex,
java.sql.Time time,
java.util.Calendar cal)
throws java.sql.SQLException
java.sql.Time value, using the given
Calendar object. The driver uses the Calendar object to construct an SQL
TIME value, which the driver then sends to the database. With a Calendar object, the
driver can calculate the time taking into account a custom timezone. If no Calendar object is
specified, the driver uses the default timezone, which is that of the virtual machine running the application.
setTime in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...time - the parameter valuecal - the Calendar object the driver will use to construct the time
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs or this method is called on a closed
PreparedStatement
public void setTimestamp(int parameterIndex,
java.sql.Timestamp x,
java.util.Calendar cal)
throws java.sql.SQLException
java.sql.Timestamp value, using the given
Calendar object. The driver uses the Calendar object to construct an SQL
TIMESTAMP value, which the driver then sends to the database. With a Calendar object,
the driver can calculate the timestamp taking into account a custom timezone. If no Calendar object
is specified, the driver uses the default timezone, which is that of the virtual machine running the
application.
setTimestamp in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter valuecal - the Calendar object the driver will use to construct the timestamp
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs or this method is called on a closed
PreparedStatement
public void setNull(int parameterIndex,
int sqlType,
java.lang.String typeName)
throws java.sql.SQLException
NULL. This version of the method setNull should be
used for user-defined types and REF type parameters. Examples of user-defined types include: STRUCT, DISTINCT,
JAVA_OBJECT, and named array types.
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.
setNull in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...sqlType - a value from java.sql.TypestypeName - the fully-qualified name of an SQL user-defined type; ignored if the parameter is not a
user-defined type or REF
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs or this method is called on a closed
PreparedStatement
java.sql.SQLFeatureNotSupportedException - if sqlType is a ARRAY, BLOB,
CLOB, DATALINK, JAVA_OBJECT,
NCHAR, NCLOB, NVARCHAR,
LONGNVARCHAR, REF, ROWID,
SQLXML or STRUCT data type and the JDBC driver does not
support this data type or if the JDBC driver does not support this method
public void setURL(int parameterIndex,
java.net.URL x)
throws java.sql.SQLException
java.net.URL value. The driver converts this to an SQL
DATALINK value when it sends it to the database.
setURL in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the java.net.URL object to be set
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs or this method is called on a closed
PreparedStatement
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
public java.sql.ParameterMetaData getParameterMetaData()
throws java.sql.SQLException
PreparedStatement object's parameters.
getParameterMetaData in interface java.sql.PreparedStatementParameterMetaData object that contains information about the number, types and properties
for each parameter marker of this PreparedStatement object
java.sql.SQLException - if a database access error occurs or this method is called on a closed
PreparedStatementParameterMetaData
public void setRowId(int parameterIndex,
java.sql.RowId x)
throws java.sql.SQLException
java.sql.RowId object. The driver converts this to a SQL
ROWID value when it sends it to the database
setRowId in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs or this method is called on a closed
PreparedStatement
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
public void setNString(int parameterIndex,
java.lang.String value)
throws java.sql.SQLException
String object. The driver converts this to a SQL
NCHAR or NVARCHAR or LONGNVARCHAR value (depending on the argument's size
relative to the driver's limits on NVARCHAR values) when it sends it to the database.
setNString in interface java.sql.PreparedStatementparameterIndex - of the first parameter is 1, the second is 2, ...value - the parameter value
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if the driver does not support national character sets; if the driver can detect
that a data conversion error could occur; if a database access error occurs; or
this method is called on a closed PreparedStatement
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
public void setNCharacterStream(int parameterIndex,
java.io.Reader value,
long length)
throws java.sql.SQLException
Reader object. The Reader reads the data till
end-of-file is reached. The driver does the necessary conversion from Java character format to the national
character set in the database.
setNCharacterStream in interface java.sql.PreparedStatementparameterIndex - of the first parameter is 1, the second is 2, ...value - the parameter valuelength - the number of characters in the parameter data.
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if the driver does not support national character sets; if the driver can detect
that a data conversion error could occur; if a database access error occurs; or
this method is called on a closed PreparedStatement
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
public void setNClob(int parameterIndex,
java.sql.NClob value)
throws java.sql.SQLException
java.sql.NClob object. The driver converts this to a SQL
NCLOB value when it sends it to the database.
setNClob in interface java.sql.PreparedStatementparameterIndex - of the first parameter is 1, the second is 2, ...value - the parameter value
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if the driver does not support national character sets; if the driver can detect
that a data conversion error could occur; if a database access error occurs; or
this method is called on a closed PreparedStatement
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
public void setClob(int parameterIndex,
java.io.Reader reader,
long length)
throws java.sql.SQLException
Reader object. The reader must contain the number of characters
specified by length otherwise a SQLException will be generated when the
PreparedStatement is executed. This method differs from the setCharacterStream (int, Reader,
int) method because it informs the driver that the parameter value should be sent to the server as a
CLOB. When the setCharacterStream method is used, the driver may have to do extra work
to determine whether the parameter data should be sent to the server as a LONGVARCHAR or a
CLOB
setClob in interface java.sql.PreparedStatementparameterIndex - 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.
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs; this method is called on a closed
PreparedStatement or if the length specified is less than zero.
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
public void setBlob(int parameterIndex,
java.io.InputStream inputStream,
long length)
throws java.sql.SQLException
InputStream object. The inputstream must contain the number of
characters specified by length otherwise a SQLException will be generated when the
PreparedStatement is executed. This method differs from the setBinaryStream (int, InputStream,
int) method because it informs the driver that the parameter value should be sent to the server as a
BLOB. When the setBinaryStream method is used, the driver may have to do extra work to
determine whether the parameter data should be sent to the server as a LONGVARBINARY or a
BLOB
setBlob in interface java.sql.PreparedStatementparameterIndex - 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.
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs; this method is called on a closed
PreparedStatement; if the length specified is less than zero or if the
number of bytes in the inputstream does not match the specfied length.
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
public void setNClob(int parameterIndex,
java.io.Reader reader,
long length)
throws java.sql.SQLException
Reader object. The reader must contain the number of characters
specified by length otherwise a SQLException will be generated when the
PreparedStatement is executed. This method differs from the setCharacterStream (int, Reader,
int) method because it informs the driver that the parameter value should be sent to the server as a
NCLOB. When the setCharacterStream method is used, the driver may have to do extra
work to determine whether the parameter data should be sent to the server as a LONGNVARCHAR or a
NCLOB
setNClob in interface java.sql.PreparedStatementparameterIndex - 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.
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if the length specified is less than zero; if the driver does not support national
character sets; if the driver can detect that a data conversion error could occur;
if a database access error occurs or this method is called on a closed
PreparedStatement
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
public void setSQLXML(int parameterIndex,
java.sql.SQLXML xmlObject)
throws java.sql.SQLException
java.sql.SQLXML object. The driver converts this to an
SQL XML value when it sends it to the database.
setSQLXML in interface java.sql.PreparedStatementparameterIndex - index of the first parameter is 1, the second is 2, ...xmlObject - a SQLXML object that maps an SQL XML value
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs; this method is called on a closed
PreparedStatement or the java.xml.transform.Result,
Writer or OutputStream has not been closed for the
SQLXML object
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
public void setObject(int parameterIndex,
java.lang.Object x,
int targetSqlType,
int scaleOrLength)
throws java.sql.SQLException
Sets the value of the designated parameter with the given object. The second argument must be an object type;
for integral values, the java.lang equivalent objects should be used.
InputStream then the stream must contain the number of bytes specified
by scaleOrLength. If the second argument is a Reader then the reader must contain the number of
characters specified by scaleOrLength. If these conditions are not true the driver will generate a
SQLException when the prepared statement is executed.
The given Java object will be converted to the given targetSqlType before being sent to the database.
If the object has a custom mapping (is of a class implementing the interfaceSQLData), the JDBC
driver should call the method SQLData.writeSQL to write it to the SQL data stream. If, on the other
hand, the object is of a class implementing Ref, Blob, Clob,
NClob, Struct, java.net.URL, or Array, the driver should pass
it to the database as a value of the corresponding SQL type.
Note that this method may be used to pass database-specific abstract data types.
setObject in interface java.sql.PreparedStatementparameterIndex - 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 - for java.sql.Types.DECIMAL or java.sql.Types.NUMERIC types, this
is the number of digits after the decimal point. For Java Object types
InputStream and Reader, this is the length of the data in the
stream or reader. For all other types, this value will be ignored.
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs; this method is called on a closed
PreparedStatement 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
java.sql.SQLFeatureNotSupportedException - if targetSqlType is a ARRAY, BLOB,
CLOB, DATALINK, JAVA_OBJECT,
NCHAR, NCLOB, NVARCHAR,
LONGNVARCHAR, REF, ROWID,
SQLXML or STRUCT data type and the JDBC driver does not
support this data typeTypes
public void setAsciiStream(int parameterIndex,
java.io.InputStream x,
long length)
throws java.sql.SQLException
LONGVARCHAR parameter, it may be more practical to send it via
a java.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.
setAsciiStream in interface java.sql.PreparedStatementparameterIndex - 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
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs or this method is called on a closed
PreparedStatement
public void setBinaryStream(int parameterIndex,
java.io.InputStream x,
long length)
throws java.sql.SQLException
LONGVARBINARY parameter, it may be more practical to send it
via a java.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.
setBinaryStream in interface java.sql.PreparedStatementparameterIndex - 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
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs or this method is called on a closed
PreparedStatement
public void setCharacterStream(int parameterIndex,
java.io.Reader reader,
long length)
throws java.sql.SQLException
Reader object, which is the given number of characters
long. When a very large UNICODE value is input to a LONGVARCHAR parameter, it may be more practical
to send it via a java.io.Reader 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.
setCharacterStream in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...reader - the java.io.Reader object that contains the Unicode datalength - the number of characters in the stream
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs or this method is called on a closed
PreparedStatement
public void setAsciiStream(int parameterIndex,
java.io.InputStream x)
throws java.sql.SQLException
LONGVARCHAR parameter, it may be more practical to send it via a java.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 setAsciiStream which takes a length parameter.
setAsciiStream in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the Java input stream that contains the ASCII parameter value
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs or this method is called on a closed
PreparedStatement
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
public void setBinaryStream(int parameterIndex,
java.io.InputStream x)
throws java.sql.SQLException
LONGVARBINARY parameter, it may be more practical to send it via a java.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 of setBinaryStream which takes a length parameter.
setBinaryStream in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the java input stream which contains the binary parameter value
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs or this method is called on a closed
PreparedStatement
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
public void setCharacterStream(int parameterIndex,
java.io.Reader reader)
throws java.sql.SQLException
Reader object. When a very large UNICODE value is input
to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.Reader
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 of setCharacterStream which takes a length parameter.
setCharacterStream in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...reader - the java.io.Reader object that contains the Unicode data
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs or this method is called on a closed
PreparedStatement
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
public void setNCharacterStream(int parameterIndex,
java.io.Reader value)
throws java.sql.SQLException
Reader object. The Reader reads the data till
end-of-file is reached. The driver does the necessary conversion from Java character format to the national
character set in the database.
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 setNCharacterStream which takes a length parameter.
setNCharacterStream in interface java.sql.PreparedStatementparameterIndex - of the first parameter is 1, the second is 2, ...value - the parameter value
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if the driver does not support national character sets; if the driver can detect
that a data conversion error could occur; if a database access error occurs; or
this method is called on a closed PreparedStatement
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
public void setClob(int parameterIndex,
java.io.Reader reader)
throws java.sql.SQLException
Reader object. This method differs from the
setCharacterStream (int, Reader) method because it informs the driver that the parameter value
should be sent to the server as a CLOB. When the setCharacterStream method is used,
the driver may have to do extra work to determine whether the parameter data should be sent to the server as a
LONGVARCHAR or a CLOB
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a
version of setClob which takes a length parameter.
setClob in interface java.sql.PreparedStatementparameterIndex - index of the first parameter is 1, the second is 2, ...reader - An object that contains the data to set the parameter value to.
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs; this method is called on a closed
PreparedStatementor if parameterIndex does not correspond to a
parameter marker in the SQL statement
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
public void setBlob(int parameterIndex,
java.io.InputStream inputStream)
throws java.sql.SQLException
InputStream object. This method differs from the
setBinaryStream (int, InputStream) method because it informs the driver that the parameter value
should be sent to the server as a BLOB. When the setBinaryStream method is used, the
driver may have to do extra work to determine whether the parameter data should be sent to the server as a
LONGVARBINARY or a BLOB
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a
version of setBlob which takes a length parameter.
setBlob in interface java.sql.PreparedStatementparameterIndex - index of the first parameter is 1, the second is 2, ...inputStream - An object that contains the data to set the parameter value to.
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs; this method is called on a closed
PreparedStatement or if parameterIndex does not correspond to a
parameter marker in the SQL statement,
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
public void setNClob(int parameterIndex,
java.io.Reader reader)
throws java.sql.SQLException
Reader object. This method differs from the
setCharacterStream (int, Reader) method because it informs the driver that the parameter value
should be sent to the server as a NCLOB. When the setCharacterStream method is used,
the driver may have to do extra work to determine whether the parameter data should be sent to the server as a
LONGNVARCHAR or a NCLOB Note: Consult your JDBC driver documentation to
determine if it might be more efficient to use a version of setNClob which takes a length
parameter.
setNClob in interface java.sql.PreparedStatementparameterIndex - index of the first parameter is 1, the second is 2, ...reader - An object that contains the data to set the parameter value to.
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if the driver does not support national character sets; if the driver can detect
that a data conversion error could occur; if a database access error occurs or
this method is called on a closed PreparedStatement
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
public void setBoolean(int column,
boolean value)
throws java.sql.SQLException
setBoolean in interface java.sql.PreparedStatementjava.sql.SQLException
public void setByte(int parameterIndex,
byte x)
throws java.sql.SQLException
byte value. The driver converts this to an SQL
TINYINT value when it sends it to the database.
setByte in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs or this method is called on a closed
PreparedStatement
public void setShort(int parameterIndex,
short x)
throws java.sql.SQLException
short value. The driver converts this to an SQL
SMALLINT value when it sends it to the database.
setShort in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs or this method is called on a closed
PreparedStatement
public void setString(int column,
java.lang.String s)
throws java.sql.SQLException
setString in interface java.sql.PreparedStatementjava.sql.SQLException
public void setBytes(int parameterIndex,
byte[] x)
throws java.sql.SQLException
VARBINARY or LONGVARBINARY (depending on the argument's size relative to the driver's
limits on VARBINARY values) when it sends it to the database.
setBytes in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs or this method is called on a closed
PreparedStatement
public void setDate(int parameterIndex,
java.sql.Date date)
throws java.sql.SQLException
java.sql.Date value using the default time zone of the
virtual machine that is running the application. The driver converts this to an SQL DATE value when
it sends it to the database.
setDate in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...date - the parameter value
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs or this method is called on a closed
PreparedStatement
public void setTime(int parameterIndex,
java.sql.Time x)
throws java.sql.SQLException
setTime in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs or this method is called on a closed
PreparedStatementUtils.packTime(long),
Sets the designated parameter to the given java.sql.Time value. The driver converts this to an
SQL TIME value when it sends it to the database.
public void setTimestamp(int parameterIndex,
java.sql.Timestamp x)
throws java.sql.SQLException
java.sql.Timestamp value. The driver converts this to an
SQL TIMESTAMP value when it sends it to the database.
setTimestamp in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs or this method is called on a closed
PreparedStatement
public void setAsciiStream(int parameterIndex,
java.io.InputStream x,
int length)
throws java.sql.SQLException
LONGVARCHAR parameter, it may be more practical to send it via
a java.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.
setAsciiStream in interface java.sql.PreparedStatementparameterIndex - 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
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs or this method is called on a closed
PreparedStatement
public void setUnicodeStream(int parameterIndex,
java.io.InputStream x,
int length)
throws java.sql.SQLException
LONGVARCHAR parameter, it may be more practical to
send it via a java.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 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.
setUnicodeStream in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - a java.io.InputStream object that contains the Unicode parameter valuelength - the number of bytes in the stream
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs or this method is called on a closed
PreparedStatement
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
public void setBinaryStream(int parameterIndex,
java.io.InputStream x,
int length)
throws java.sql.SQLException
LONGVARBINARY parameter, it may be more practical to send it
via a java.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.
setBinaryStream in interface java.sql.PreparedStatementparameterIndex - 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
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs or this method is called on a closed
PreparedStatement
public void clearParameters()
throws java.sql.SQLException
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.
clearParameters in interface java.sql.PreparedStatementjava.sql.SQLException - if a database access error occurs or this method is called on a closed
PreparedStatement
public void setObject(int parameterIndex,
java.lang.Object x,
int targetSqlType)
throws java.sql.SQLException
setObject above, except that it assumes a scale of zero.
setObject in interface java.sql.PreparedStatementparameterIndex - 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
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs or this method is called on a closed
PreparedStatement
java.sql.SQLFeatureNotSupportedException - if targetSqlType is a ARRAY, BLOB,
CLOB, DATALINK, JAVA_OBJECT,
NCHAR, NCLOB, NVARCHAR,
LONGNVARCHAR, REF, ROWID,
SQLXML or STRUCT data type and the JDBC driver does not
support this data typeTypes
public void setObject(int parameterIndex,
java.lang.Object x)
throws java.sql.SQLException
Sets the value of the designated parameter using the given object. The second parameter must be of type
Object; therefore, the java.lang equivalent objects should be used for built-in types.
The JDBC specification specifies a standard mapping from Java Object types to SQL types. The
given argument will be converted to the corresponding SQL type before being sent to the database.
Note that this method may be used to pass datatabase- 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
method SQLData.writeSQL to write it to the SQL data stream. If, on the other hand, the object is of
a class implementing Ref, Blob, Clob, NClob,
Struct, java.net.URL, RowId, SQLXML or Array,
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
setNull or the setObject(int parameterIndex, Object x, int sqlType) method should be
used instead of setObject(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.
setObject in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the object containing the input parameter value
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs; this method is called on a closed
PreparedStatement or the type of the given object is ambiguous
public void setInt(int column,
int i)
throws java.sql.SQLException
setInt in interface java.sql.PreparedStatementjava.sql.SQLException
public void setLong(int parameterIndex,
long x)
throws java.sql.SQLException
long value. The driver converts this to an SQL
BIGINT value when it sends it to the database.
setLong in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs or this method is called on a closed
PreparedStatement
public void setFloat(int parameterIndex,
float x)
throws java.sql.SQLException
float value. The driver converts this to an SQL
REAL value when it sends it to the database.
setFloat in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs or this method is called on a closed
PreparedStatement
public void setDouble(int parameterIndex,
double x)
throws java.sql.SQLException
double value. The driver converts this to an SQL
DOUBLE value when it sends it to the database.
setDouble in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs or this method is called on a closed
PreparedStatement
public void setBigDecimal(int parameterIndex,
java.math.BigDecimal x)
throws java.sql.SQLException
java.math.BigDecimal value. The driver converts this to
an SQL NUMERIC value when it sends it to the database.
setBigDecimal in interface java.sql.PreparedStatementparameterIndex - the first parameter is 1, the second is 2, ...x - the parameter value
java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement;
if a database access error occurs or this method is called on a closed
PreparedStatement
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||