Class ProfilingPreparedStatement
- java.lang.Object
-
- com.avoka.core.cayenne.ProfilingPreparedStatement
-
- All Implemented Interfaces:
AutoCloseable,PreparedStatement,Statement,Wrapper
public class ProfilingPreparedStatement extends Object implements PreparedStatement
Provides a profiling prepared statement class wrapper.- Since:
- 4.2.0
-
-
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
Constructors Constructor Description ProfilingPreparedStatement(PreparedStatement preparedStatement, String sql)Create a profiling prepared statement with the given statement and SQL.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidaddBatch()Adds a set of parameters to thisPreparedStatementobject's batch of commands.voidaddBatch(String sql)Adds the given SQL command to the current list of commmands for thisStatementobject.voidcancel()Cancels thisStatementobject if both the DBMS and driver support aborting an SQL statement.voidclearBatch()Empties thisStatementobject's current list of SQL commands.voidclearParameters()Clears the current parameter values immediately.voidclearWarnings()Clears all the warnings reported on thisStatementobject.voidclose()Releases thisStatementobject's database and JDBC resources immediately instead of waiting for this to happen when it is automatically closed.voidcloseOnCompletion()booleanexecute()Executes the SQL statement in thisPreparedStatementobject, which may be any kind of SQL statement.booleanexecute(String sql)Executes the given SQL statement, which may return multiple results.booleanexecute(String sql, int autoGeneratedKeys)Executes the given SQL statement, which may return multiple results, and signals the driver that any auto-generated keys should be made available for retrieval.booleanexecute(String sql, int[] columnIndexes)Executes the given SQL statement, which may return multiple results, and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval.booleanexecute(String sql, String[] columnNames)Executes the given SQL statement, which may return multiple results, and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval.int[]executeBatch()Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts.ResultSetexecuteQuery()Executes the SQL query in thisPreparedStatementobject and returns theResultSetobject generated by the query.ResultSetexecuteQuery(String sql)Executes the given SQL statement, which returns a singleResultSetobject.intexecuteUpdate()Executes the SQL statement in thisPreparedStatementobject, which must be an SQLINSERT,UPDATEorDELETEstatement; or an SQL statement that returns nothing, such as a DDL statement.intexecuteUpdate(String sql)Executes the given SQL statement, which may be anINSERT,UPDATE, orDELETEstatement or an SQL statement that returns nothing, such as an SQL DDL statement.intexecuteUpdate(String sql, int autoGeneratedKeys)Executes the given SQL statement and signals the driver with the given flag about whether the auto-generated keys produced by thisStatementobject should be made available for retrieval.intexecuteUpdate(String sql, int[] columnIndexes)Executes the given SQL statement and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval.intexecuteUpdate(String sql, String[] columnNames)Executes the given SQL statement and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval.ConnectiongetConnection()Retrieves theConnectionobject that produced thisStatementobject.intgetFetchDirection()Retrieves the direction for fetching rows from database tables that is the default for result sets generated from thisStatementobject.intgetFetchSize()Retrieves the number of result set rows that is the default fetch size forResultSetobjects generated from thisStatementobject.ResultSetgetGeneratedKeys()Retrieves any auto-generated keys created as a result of executing thisStatementobject.intgetMaxFieldSize()Retrieves the maximum number of bytes that can be returned for character and binary column values in aResultSetobject produced by thisStatementobject.intgetMaxRows()Retrieves the maximum number of rows that aResultSetobject produced by thisStatementobject can contain.ResultSetMetaDatagetMetaData()Retrieves aResultSetMetaDataobject that contains information about the columns of theResultSetobject that will be returned when thisPreparedStatementobject is executed.booleangetMoreResults()Moves to thisStatementobject's next result, returnstrueif it is aResultSetobject, and implicitly closes any currentResultSetobject(s) obtained with the methodgetResultSet.booleangetMoreResults(int current)Moves to thisStatementobject's next result, deals with any currentResultSetobject(s) according to the instructions specified by the given flag, and returnstrueif the next result is aResultSetobject.ParameterMetaDatagetParameterMetaData()Retrieves the number, types and properties of thisPreparedStatementobject's parameters.intgetQueryTimeout()Retrieves the number of seconds the driver will wait for aStatementobject to execute.ResultSetgetResultSet()Retrieves the current result as aResultSetobject.intgetResultSetConcurrency()Retrieves the result set concurrency forResultSetobjects generated by thisStatementobject.intgetResultSetHoldability()Retrieves the result set holdability forResultSetobjects generated by thisStatementobject.intgetResultSetType()Retrieves the result set type forResultSetobjects generated by thisStatementobject.intgetUpdateCount()Retrieves the current result as an update count; if the result is aResultSetobject or there are no more results, -1 is returned.SQLWarninggetWarnings()Retrieves the first warning reported by calls on thisStatementobject.booleanisClosed()booleanisCloseOnCompletion()booleanisPoolable()booleanisWrapperFor(Class<?> iface)voidsetArray(int i, Array x)Sets the designated parameter to the givenArrayobject.voidsetAsciiStream(int parameterIndex, InputStream x)voidsetAsciiStream(int parameterIndex, InputStream x, int length)Sets the designated parameter to the given input stream, which will have the specified number of bytes.voidsetAsciiStream(int parameterIndex, InputStream x, long length)voidsetBigDecimal(int parameterIndex, BigDecimal x)Sets the designated parameter to the givenjava.math.BigDecimalvalue.voidsetBinaryStream(int parameterIndex, InputStream x)voidsetBinaryStream(int parameterIndex, InputStream x, int length)Sets the designated parameter to the given input stream, which will have the specified number of bytes.voidsetBinaryStream(int parameterIndex, InputStream x, long length)voidsetBlob(int parameterIndex, InputStream inputStream)voidsetBlob(int parameterIndex, InputStream inputStream, long length)voidsetBlob(int i, Blob x)Sets the designated parameter to the givenBlobobject.voidsetBoolean(int parameterIndex, boolean x)Sets the designated parameter to the given Javabooleanvalue.voidsetByte(int parameterIndex, byte x)Sets the designated parameter to the given Javabytevalue.voidsetBytes(int parameterIndex, byte[] x)Sets the designated parameter to the given Java array of bytes.voidsetCharacterStream(int parameterIndex, Reader reader)voidsetCharacterStream(int parameterIndex, Reader reader, int length)Sets the designated parameter to the givenReaderobject, which is the given number of characters long.voidsetCharacterStream(int parameterIndex, Reader reader, long length)voidsetClob(int parameterIndex, Reader reader)voidsetClob(int parameterIndex, Reader reader, long length)voidsetClob(int i, Clob x)Sets the designated parameter to the givenClobobject.voidsetCursorName(String name)Sets the SQL cursor name to the givenString, which will be used by subsequentStatementobjectexecutemethods.voidsetDate(int parameterIndex, Date x)Sets the designated parameter to the givenjava.sql.Datevalue.voidsetDate(int parameterIndex, Date x, Calendar cal)Sets the designated parameter to the givenjava.sql.Datevalue, using the givenCalendarobject.voidsetDouble(int parameterIndex, double x)Sets the designated parameter to the given Javadoublevalue.voidsetEscapeProcessing(boolean enable)Sets escape processing on or off.voidsetFetchDirection(int direction)Gives the driver a hint as to the direction in which rows will be processed inResultSetobjects created using thisStatementobject.voidsetFetchSize(int rows)Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed.voidsetFloat(int parameterIndex, float x)Sets the designated parameter to the given Javafloatvalue.voidsetInt(int parameterIndex, int x)Sets the designated parameter to the given Javaintvalue.voidsetLong(int parameterIndex, long x)Sets the designated parameter to the given Javalongvalue.voidsetMaxFieldSize(int max)Sets the limit for the maximum number of bytes in aResultSetcolumn storing character or binary values to the given number of bytes.voidsetMaxRows(int max)Sets the limit for the maximum number of rows that anyResultSetobject can contain to the given number.voidsetNCharacterStream(int parameterIndex, Reader value)voidsetNCharacterStream(int parameterIndex, Reader value, long length)voidsetNClob(int parameterIndex, Reader reader)voidsetNClob(int parameterIndex, Reader reader, long length)voidsetNClob(int parameterIndex, NClob value)voidsetNString(int parameterIndex, String value)voidsetNull(int parameterIndex, int sqlType)Sets the designated parameter to SQLNULL.voidsetNull(int paramIndex, int sqlType, String typeName)Sets the designated parameter to SQLNULL.voidsetObject(int parameterIndex, Object x)Sets the value of the designated parameter using the given object.voidsetObject(int parameterIndex, Object x, int targetSqlType)Sets the value of the designated parameter with the given object.voidsetObject(int parameterIndex, Object x, int targetSqlType, int scale)Sets the value of the designated parameter with the given object.voidsetPoolable(boolean poolable)voidsetQueryTimeout(int seconds)Sets the number of seconds the driver will wait for aStatementobject to execute to the given number of seconds.voidsetRef(int i, Ref x)Sets the designated parameter to the givenREF(<structured-type>)value.voidsetRowId(int parameterIndex, RowId x)voidsetShort(int parameterIndex, short x)Sets the designated parameter to the given Javashortvalue.voidsetSQLXML(int parameterIndex, SQLXML xmlObject)voidsetString(int parameterIndex, String x)Sets the designated parameter to the given JavaStringvalue.voidsetTime(int parameterIndex, Time x)Sets the designated parameter to the givenjava.sql.Timevalue.voidsetTime(int parameterIndex, Time x, Calendar cal)Sets the designated parameter to the givenjava.sql.Timevalue, using the givenCalendarobject.voidsetTimestamp(int parameterIndex, Timestamp x)Sets the designated parameter to the givenjava.sql.Timestampvalue.voidsetTimestamp(int parameterIndex, Timestamp x, Calendar cal)Sets the designated parameter to the givenjava.sql.Timestampvalue, using the givenCalendarobject.voidsetUnicodeStream(int parameterIndex, InputStream x, int length)Deprecated.voidsetURL(int parameterIndex, URL x)Sets the designated parameter to the givenjava.net.URLvalue.<T> Tunwrap(Class<T> iface)-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.sql.PreparedStatement
executeLargeUpdate, setObject, setObject
-
Methods inherited from interface java.sql.Statement
enquoteIdentifier, enquoteLiteral, enquoteNCharLiteral, executeLargeBatch, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, getLargeMaxRows, getLargeUpdateCount, isSimpleIdentifier, setLargeMaxRows
-
-
-
-
Constructor Detail
-
ProfilingPreparedStatement
public ProfilingPreparedStatement(PreparedStatement preparedStatement, String sql)
Create a profiling prepared statement with the given statement and SQL.- Parameters:
preparedStatement- the prepared statement to profilesql-
-
-
Method Detail
-
close
public void close() throws SQLExceptionReleases thisStatementobject's database and JDBC resources immediately instead of waiting for this to happen when it is automatically closed. It is generally good practice to release resources as soon as you are finished with them to avoid tying up database resources.Calling the method
closeon aStatementobject that is already closed has no effect.Note: A
Statementobject is automatically closed when it is garbage collected. When aStatementobject is closed, its currentResultSetobject, if one exists, is also closed.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceStatement- Throws:
SQLException- if a database access error occurs
-
addBatch
public void addBatch() throws SQLExceptionAdds a set of parameters to thisPreparedStatementobject's batch of commands.- Specified by:
addBatchin interfacePreparedStatement- Throws:
SQLException- if a database access error occurs- Since:
- 1.2
- See Also:
Statement.addBatch(java.lang.String)
-
clearParameters
public void clearParameters() throws SQLExceptionClears the current parameter values immediately.In general, parameter values remain in force for repeated use of a statement. Setting a parameter value automatically clears its previous value. However, in some cases it is useful to immediately release the resources used by the current parameter values; this can be done by calling the method
clearParameters.- Specified by:
clearParametersin interfacePreparedStatement- Throws:
SQLException- if a database access error occurs
-
execute
public boolean execute() throws SQLExceptionExecutes the SQL statement in thisPreparedStatementobject, which may be any kind of SQL statement. Some prepared statements return multiple results; theexecutemethod handles these complex statements as well as the simpler form of statements handled by the methodsexecuteQueryandexecuteUpdate.The
executemethod returns abooleanto indicate the form of the first result. You must call either the methodgetResultSetorgetUpdateCountto retrieve the result; you must callgetMoreResultsto move to any subsequent result(s).- Specified by:
executein interfacePreparedStatement- Returns:
trueif the first result is aResultSetobject;falseif the first result is an update count or there is no result- Throws:
SQLException- if a database access error occurs or an argument is supplied to this method- See Also:
Statement.execute(java.lang.String),Statement.getResultSet(),Statement.getUpdateCount(),Statement.getMoreResults()
-
executeQuery
public ResultSet executeQuery() throws SQLException
Executes the SQL query in thisPreparedStatementobject and returns theResultSetobject generated by the query.- Specified by:
executeQueryin interfacePreparedStatement- Returns:
- a
ResultSetobject that contains the data produced by the query; nevernull - Throws:
SQLException- if a database access error occurs or the SQL statement does not return aResultSetobject
-
executeUpdate
public int executeUpdate() throws SQLExceptionExecutes the SQL statement in thisPreparedStatementobject, which must be an SQLINSERT,UPDATEorDELETEstatement; or an SQL statement that returns nothing, such as a DDL statement.- Specified by:
executeUpdatein interfacePreparedStatement- Returns:
- either (1) the row count for
INSERT,UPDATE, orDELETEstatements or (2) 0 for SQL statements that return nothing - Throws:
SQLException- if a database access error occurs or the SQL statement returns aResultSetobject
-
getMetaData
public ResultSetMetaData getMetaData() throws SQLException
Retrieves aResultSetMetaDataobject that contains information about the columns of theResultSetobject that will be returned when thisPreparedStatementobject is executed.Because a
PreparedStatementobject is precompiled, it is possible to know about theResultSetobject that it will return without having to execute it. Consequently, it is possible to invoke the methodgetMetaDataon aPreparedStatementobject rather than waiting to execute it and then invoking theResultSet.getMetaDatamethod on theResultSetobject that is returned.NOTE: Using this method may be expensive for some drivers due to the lack of underlying DBMS support.
- Specified by:
getMetaDatain interfacePreparedStatement- Returns:
- the description of a
ResultSetobject's columns ornullif the driver cannot return aResultSetMetaDataobject - Throws:
SQLException- if a database access error occurs- Since:
- 1.2
-
getParameterMetaData
public ParameterMetaData getParameterMetaData() throws SQLException
Retrieves the number, types and properties of thisPreparedStatementobject's parameters.- Specified by:
getParameterMetaDatain interfacePreparedStatement- Returns:
- a
ParameterMetaDataobject that contains information about the number, types and properties of thisPreparedStatementobject's parameters - Throws:
SQLException- if a database access error occurs- Since:
- 1.4
- See Also:
ParameterMetaData
-
setArray
public void setArray(int i, Array x) throws SQLExceptionSets the designated parameter to the givenArrayobject. The driver converts this to an SQLARRAYvalue when it sends it to the database.- Specified by:
setArrayin interfacePreparedStatement- Parameters:
i- the first parameter is 1, the second is 2, ...x- anArrayobject that maps an SQLARRAYvalue- Throws:
SQLException- if a database access error occurs- Since:
- 1.2
-
setAsciiStream
public void setAsciiStream(int parameterIndex, InputStream x, int length) throws SQLExceptionSets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large ASCII value is input to aLONGVARCHARparameter, it may be more practical to send it via ajava.io.InputStream. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
- Specified by:
setAsciiStreamin interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the Java input stream that contains the ASCII parameter valuelength- the number of bytes in the stream- Throws:
SQLException- if a database access error occurs
-
setBigDecimal
public void setBigDecimal(int parameterIndex, BigDecimal x) throws SQLExceptionSets the designated parameter to the givenjava.math.BigDecimalvalue. The driver converts this to an SQLNUMERICvalue when it sends it to the database.- Specified by:
setBigDecimalin interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setBinaryStream
public void setBinaryStream(int parameterIndex, InputStream x, int length) throws SQLExceptionSets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large binary value is input to aLONGVARBINARYparameter, it may be more practical to send it via ajava.io.InputStreamobject. The data will be read from the stream as needed until end-of-file is reached.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
- Specified by:
setBinaryStreamin interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the java input stream which contains the binary parameter valuelength- the number of bytes in the stream- Throws:
SQLException- if a database access error occurs
-
setBlob
public void setBlob(int i, Blob x) throws SQLExceptionSets the designated parameter to the givenBlobobject. The driver converts this to an SQLBLOBvalue when it sends it to the database.- Specified by:
setBlobin interfacePreparedStatement- Parameters:
i- the first parameter is 1, the second is 2, ...x- aBlobobject that maps an SQLBLOBvalue- Throws:
SQLException- if a database access error occurs- Since:
- 1.2
-
setBoolean
public void setBoolean(int parameterIndex, boolean x) throws SQLExceptionSets the designated parameter to the given Javabooleanvalue. The driver converts this to an SQLBITvalue when it sends it to the database.- Specified by:
setBooleanin interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setByte
public void setByte(int parameterIndex, byte x) throws SQLExceptionSets the designated parameter to the given Javabytevalue. The driver converts this to an SQLTINYINTvalue when it sends it to the database.- Specified by:
setBytein interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setBytes
public void setBytes(int parameterIndex, byte[] x) throws SQLExceptionSets the designated parameter to the given Java array of bytes. The driver converts this to an SQLVARBINARYorLONGVARBINARY(depending on the argument's size relative to the driver's limits onVARBINARYvalues) when it sends it to the database.- Specified by:
setBytesin interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setCharacterStream
public void setCharacterStream(int parameterIndex, Reader reader, int length) throws SQLExceptionSets the designated parameter to the givenReaderobject, which is the given number of characters long. When a very large UNICODE value is input to aLONGVARCHARparameter, it may be more practical to send it via ajava.io.Readerobject. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
- Specified by:
setCharacterStreamin interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...reader- thejava.io.Readerobject that contains the Unicode datalength- the number of characters in the stream- Throws:
SQLException- if a database access error occurs- Since:
- 1.2
-
setClob
public void setClob(int i, Clob x) throws SQLExceptionSets the designated parameter to the givenClobobject. The driver converts this to an SQLCLOBvalue when it sends it to the database.- Specified by:
setClobin interfacePreparedStatement- Parameters:
i- the first parameter is 1, the second is 2, ...x- aClobobject that maps an SQLCLOBvalue- Throws:
SQLException- if a database access error occurs- Since:
- 1.2
-
setDate
public void setDate(int parameterIndex, Date x) throws SQLExceptionSets the designated parameter to the givenjava.sql.Datevalue. The driver converts this to an SQLDATEvalue when it sends it to the database.- Specified by:
setDatein interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setDate
public void setDate(int parameterIndex, Date x, Calendar cal) throws SQLExceptionSets the designated parameter to the givenjava.sql.Datevalue, using the givenCalendarobject. The driver uses theCalendarobject to construct an SQLDATEvalue, which the driver then sends to the database. With aCalendarobject, the driver can calculate the date taking into account a custom timezone. If noCalendarobject is specified, the driver uses the default timezone, which is that of the virtual machine running the application.- Specified by:
setDatein interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter valuecal- theCalendarobject the driver will use to construct the date- Throws:
SQLException- if a database access error occurs- Since:
- 1.2
-
setDouble
public void setDouble(int parameterIndex, double x) throws SQLExceptionSets the designated parameter to the given Javadoublevalue. The driver converts this to an SQLDOUBLEvalue when it sends it to the database.- Specified by:
setDoublein interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setFloat
public void setFloat(int parameterIndex, float x) throws SQLExceptionSets the designated parameter to the given Javafloatvalue. The driver converts this to an SQLFLOATvalue when it sends it to the database.- Specified by:
setFloatin interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setInt
public void setInt(int parameterIndex, int x) throws SQLExceptionSets the designated parameter to the given Javaintvalue. The driver converts this to an SQLINTEGERvalue when it sends it to the database.- Specified by:
setIntin interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setLong
public void setLong(int parameterIndex, long x) throws SQLExceptionSets the designated parameter to the given Javalongvalue. The driver converts this to an SQLBIGINTvalue when it sends it to the database.- Specified by:
setLongin interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setNull
public void setNull(int parameterIndex, int sqlType) throws SQLExceptionSets the designated parameter to SQLNULL.Note: You must specify the parameter's SQL type.
- Specified by:
setNullin interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...sqlType- the SQL type code defined injava.sql.Types- Throws:
SQLException- if a database access error occurs
-
setNull
public void setNull(int paramIndex, int sqlType, String typeName) throws SQLExceptionSets the designated parameter to SQLNULL. This version of the methodsetNullshould be used for user-defined types and REF type parameters. Examples of user-defined types include: STRUCT, DISTINCT, JAVA_OBJECT, and named array types.Note: To be portable, applications must give the SQL type code and the fully-qualified SQL type name when specifying a NULL user-defined or REF parameter. In the case of a user-defined type the name is the type name of the parameter itself. For a REF parameter, the name is the type name of the referenced type. If a JDBC driver does not need the type code or type name information, it may ignore it. Although it is intended for user-defined and Ref parameters, this method may be used to set a null parameter of any JDBC type. If the parameter does not have a user-defined or REF type, the given typeName is ignored.
- Specified by:
setNullin interfacePreparedStatement- Parameters:
paramIndex- the first parameter is 1, the second is 2, ...sqlType- a value fromjava.sql.TypestypeName- the fully-qualified name of an SQL user-defined type; ignored if the parameter is not a user-defined type or REF- Throws:
SQLException- if a database access error occurs- Since:
- 1.2
-
setObject
public void setObject(int parameterIndex, Object x) throws SQLExceptionSets the value of the designated parameter using the given object. The second parameter must be of type
Object; therefore, thejava.langequivalent objects should be used for built-in types.The JDBC specification specifies a standard mapping from Java
Objecttypes to SQL types. The given argument will be converted to the corresponding SQL type before being sent to the database.Note that this method may be used to pass datatabase- specific abstract data types, by using a driver-specific Java type. If the object is of a class implementing the interface
SQLData, the JDBC driver should call the methodSQLData.writeSQLto write it to the SQL data stream. If, on the other hand, the object is of a class implementingRef,Blob,Clob,Struct, orArray, the driver should pass it to the database as a value of the corresponding SQL type.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.
- Specified by:
setObjectin interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the object containing the input parameter value- Throws:
SQLException- if a database access error occurs or the type of the given object is ambiguous
-
setObject
public void setObject(int parameterIndex, Object x, int targetSqlType) throws SQLExceptionSets the value of the designated parameter with the given object. This method is like the methodsetObjectabove, except that it assumes a scale of zero.- Specified by:
setObjectin interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the object containing the input parameter valuetargetSqlType- the SQL type (as defined in java.sql.Types) to be sent to the database- Throws:
SQLException- if a database access error occurs
-
setObject
public void setObject(int parameterIndex, Object x, int targetSqlType, int scale) throws SQLExceptionSets the value of the designated parameter with the given object. The second argument must be an object type; for integral values, the
java.langequivalent objects should be used.The given Java object will be converted to the given targetSqlType before being sent to the database. If the object has a custom mapping (is of a class implementing the interface
SQLData), the JDBC driver should call the methodSQLData.writeSQLto write it to the SQL data stream. If, on the other hand, the object is of a class implementingRef,Blob,Clob,Struct, orArray, the driver should pass it to the database as a value of the corresponding SQL type.Note that this method may be used to pass database-specific abstract data types.
- Specified by:
setObjectin interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the object containing the input parameter valuetargetSqlType- the SQL type (as defined in java.sql.Types) to be sent to the database. The scale argument may further qualify this type.scale- for java.sql.Types.DECIMAL or java.sql.Types.NUMERIC types, this is the number of digits after the decimal point. For all other types, this value will be ignored.- Throws:
SQLException- if a database access error occurs- See Also:
Types
-
setRef
public void setRef(int i, Ref x) throws SQLExceptionSets the designated parameter to the givenREF(<structured-type>)value. The driver converts this to an SQLREFvalue when it sends it to the database.- Specified by:
setRefin interfacePreparedStatement- Parameters:
i- the first parameter is 1, the second is 2, ...x- an SQLREFvalue- Throws:
SQLException- if a database access error occurs- Since:
- 1.2
-
setShort
public void setShort(int parameterIndex, short x) throws SQLExceptionSets the designated parameter to the given Javashortvalue. The driver converts this to an SQLSMALLINTvalue when it sends it to the database.- Specified by:
setShortin interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setString
public void setString(int parameterIndex, String x) throws SQLExceptionSets the designated parameter to the given JavaStringvalue. The driver converts this to an SQLVARCHARorLONGVARCHARvalue (depending on the argument's size relative to the driver's limits onVARCHARvalues) when it sends it to the database.- Specified by:
setStringin interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setTime
public void setTime(int parameterIndex, Time x) throws SQLExceptionSets the designated parameter to the givenjava.sql.Timevalue. The driver converts this to an SQLTIMEvalue when it sends it to the database.- Specified by:
setTimein interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setTime
public void setTime(int parameterIndex, Time x, Calendar cal) throws SQLExceptionSets the designated parameter to the givenjava.sql.Timevalue, using the givenCalendarobject. The driver uses theCalendarobject to construct an SQLTIMEvalue, which the driver then sends to the database. With aCalendarobject, the driver can calculate the time taking into account a custom timezone. If noCalendarobject is specified, the driver uses the default timezone, which is that of the virtual machine running the application.- Specified by:
setTimein interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter valuecal- theCalendarobject the driver will use to construct the time- Throws:
SQLException- if a database access error occurs- Since:
- 1.2
-
setTimestamp
public void setTimestamp(int parameterIndex, Timestamp x) throws SQLExceptionSets the designated parameter to the givenjava.sql.Timestampvalue. The driver converts this to an SQLTIMESTAMPvalue when it sends it to the database.- Specified by:
setTimestampin interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setTimestamp
public void setTimestamp(int parameterIndex, Timestamp x, Calendar cal) throws SQLExceptionSets the designated parameter to the givenjava.sql.Timestampvalue, using the givenCalendarobject. The driver uses theCalendarobject to construct an SQLTIMESTAMPvalue, which the driver then sends to the database. With aCalendarobject, the driver can calculate the timestamp taking into account a custom timezone. If noCalendarobject is specified, the driver uses the default timezone, which is that of the virtual machine running the application.- Specified by:
setTimestampin interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter valuecal- theCalendarobject the driver will use to construct the timestamp- Throws:
SQLException- if a database access error occurs- Since:
- 1.2
-
setURL
public void setURL(int parameterIndex, URL x) throws SQLExceptionSets the designated parameter to the givenjava.net.URLvalue. The driver converts this to an SQLDATALINKvalue when it sends it to the database.- Specified by:
setURLin interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- thejava.net.URLobject to be set- Throws:
SQLException- if a database access error occurs- Since:
- 1.4
-
setUnicodeStream
public void setUnicodeStream(int parameterIndex, InputStream x, int length) throws SQLExceptionDeprecated.Sets the designated parameter to the given input stream, which will have the specified number of bytes. A Unicode character has two bytes, with the first byte being the high byte, and the second being the low byte. When a very large Unicode value is input to aLONGVARCHARparameter, it may be more practical to send it via ajava.io.InputStreamobject. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from Unicode to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
- Specified by:
setUnicodeStreamin interfacePreparedStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- ajava.io.InputStreamobject that contains the Unicode parameter value as two-byte Unicode characterslength- the number of bytes in the stream- Throws:
SQLException- if a database access error occurs
-
addBatch
public void addBatch(String sql) throws SQLException
Adds the given SQL command to the current list of commmands for thisStatementobject. The commands in this list can be executed as a batch by calling the methodexecuteBatch.NOTE: This method is optional.
- Specified by:
addBatchin interfaceStatement- Parameters:
sql- typically this is a static SQLINSERTorUPDATEstatement- Throws:
SQLException- if a database access error occurs, or the driver does not support batch updates- Since:
- 1.2
- See Also:
executeBatch()
-
cancel
public void cancel() throws SQLExceptionCancels thisStatementobject if both the DBMS and driver support aborting an SQL statement. This method can be used by one thread to cancel a statement that is being executed by another thread.- Specified by:
cancelin interfaceStatement- Throws:
SQLException- if a database access error occurs
-
clearBatch
public void clearBatch() throws SQLExceptionEmpties thisStatementobject's current list of SQL commands.NOTE: This method is optional.
- Specified by:
clearBatchin interfaceStatement- Throws:
SQLException- if a database access error occurs or the driver does not support batch updates- Since:
- 1.2
- See Also:
addBatch()
-
clearWarnings
public void clearWarnings() throws SQLExceptionClears all the warnings reported on thisStatementobject. After a call to this method, the methodgetWarningswill returnnulluntil a new warning is reported for thisStatementobject.- Specified by:
clearWarningsin interfaceStatement- Throws:
SQLException- if a database access error occurs
-
execute
public boolean execute(String sql) throws SQLException
Executes the given SQL statement, which may return multiple results. In some (uncommon) situations, a single SQL statement may return multiple result sets and/or update counts. Normally you can ignore this unless you are (1) executing a stored procedure that you know may return multiple results or (2) you are dynamically executing an unknown SQL string.The
executemethod executes an SQL statement and indicates the form of the first result. You must then use the methodsgetResultSetorgetUpdateCountto retrieve the result, andgetMoreResultsto move to any subsequent result(s).- Specified by:
executein interfaceStatement- Parameters:
sql- any SQL statement- Returns:
trueif the first result is aResultSetobject;falseif it is an update count or there are no results- Throws:
SQLException- if a database access error occurs- See Also:
getResultSet(),getUpdateCount(),getMoreResults()
-
execute
public boolean execute(String sql, int autoGeneratedKeys) throws SQLException
Executes the given SQL statement, which may return multiple results, and signals the driver that any auto-generated keys should be made available for retrieval. The driver will ignore this signal if the SQL statement is not anINSERTstatement.In some (uncommon) situations, a single SQL statement may return multiple result sets and/or update counts. Normally you can ignore this unless you are (1) executing a stored procedure that you know may return multiple results or (2) you are dynamically executing an unknown SQL string.
The
executemethod executes an SQL statement and indicates the form of the first result. You must then use the methodsgetResultSetorgetUpdateCountto retrieve the result, andgetMoreResultsto move to any subsequent result(s).- Specified by:
executein interfaceStatement- Parameters:
sql- any SQL statementautoGeneratedKeys- a constant indicating whether auto-generated keys should be made available for retrieval using the methodgetGeneratedKeys; one of the following constants:Statement.RETURN_GENERATED_KEYSorStatement.NO_GENERATED_KEYS- Returns:
trueif the first result is aResultSetobject;falseif it is an update count or there are no results- Throws:
SQLException- if a database access error occurs or the second parameter supplied to this method is notStatement.RETURN_GENERATED_KEYSorStatement.NO_GENERATED_KEYS.- Since:
- 1.4
- See Also:
getResultSet(),getUpdateCount(),getMoreResults(),getGeneratedKeys()
-
execute
public boolean execute(String sql, int[] columnIndexes) throws SQLException
Executes the given SQL statement, which may return multiple results, and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval. This array contains the indexes of the columns in the target table that contain the auto-generated keys that should be made available. The driver will ignore the array if the given SQL statement is not anINSERTstatement.Under some (uncommon) situations, a single SQL statement may return multiple result sets and/or update counts. Normally you can ignore this unless you are (1) executing a stored procedure that you know may return multiple results or (2) you are dynamically executing an unknown SQL string.
The
executemethod executes an SQL statement and indicates the form of the first result. You must then use the methodsgetResultSetorgetUpdateCountto retrieve the result, andgetMoreResultsto move to any subsequent result(s).- Specified by:
executein interfaceStatement- Parameters:
sql- any SQL statementcolumnIndexes- an array of the indexes of the columns in the inserted row that should be made available for retrieval by a call to the methodgetGeneratedKeys- Returns:
trueif the first result is aResultSetobject;falseif it is an update count or there are no results- Throws:
SQLException- if a database access error occurs or the elements in theintarray passed to this method are not valid column indexes- Since:
- 1.4
- See Also:
getResultSet(),getUpdateCount(),getMoreResults()
-
execute
public boolean execute(String sql, String[] columnNames) throws SQLException
Executes the given SQL statement, which may return multiple results, and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval. This array contains the names of the columns in the target table that contain the auto-generated keys that should be made available. The driver will ignore the array if the given SQL statement is not anINSERTstatement.In some (uncommon) situations, a single SQL statement may return multiple result sets and/or update counts. Normally you can ignore this unless you are (1) executing a stored procedure that you know may return multiple results or (2) you are dynamically executing an unknown SQL string.
The
executemethod executes an SQL statement and indicates the form of the first result. You must then use the methodsgetResultSetorgetUpdateCountto retrieve the result, andgetMoreResultsto move to any subsequent result(s).- Specified by:
executein interfaceStatement- Parameters:
sql- any SQL statementcolumnNames- an array of the names of the columns in the inserted row that should be made available for retrieval by a call to the methodgetGeneratedKeys- Returns:
trueif the next result is aResultSetobject;falseif it is an update count or there are no more results- Throws:
SQLException- if a database access error occurs or the elements of theStringarray passed to this method are not valid column names- Since:
- 1.4
- See Also:
getResultSet(),getUpdateCount(),getMoreResults(),getGeneratedKeys()
-
executeBatch
public int[] executeBatch() throws SQLExceptionSubmits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts. Theintelements of the array that is returned are ordered to correspond to the commands in the batch, which are ordered according to the order in which they were added to the batch. The elements in the array returned by the methodexecuteBatchmay be one of the following:- A number greater than or equal to zero -- indicates that the command was processed successfully and is an update count giving the number of rows in the database that were affected by the command's execution
- A value of
SUCCESS_NO_INFO-- indicates that the command was processed successfully but that the number of rows affected is unknownIf one of the commands in a batch update fails to execute properly, this method throws a
BatchUpdateException, and a JDBC driver may or may not continue to process the remaining commands in the batch. However, the driver's behavior must be consistent with a particular DBMS, either always continuing to process commands or never continuing to process commands. If the driver continues processing after a failure, the array returned by the methodBatchUpdateException.getUpdateCountswill contain as many elements as there are commands in the batch, and at least one of the elements will be the following: - A value of
EXECUTE_FAILED-- indicates that the command failed to execute successfully and occurs only if a driver continues to process commands after a command fails
A driver is not required to implement this method. The possible implementations and return values have been modified in the Java 2 SDK, Standard Edition, version 1.3 to accommodate the option of continuing to proccess commands in a batch update after a
BatchUpdateExceptionobejct has been thrown.- Specified by:
executeBatchin interfaceStatement- Returns:
- an array of update counts containing one element for each command in the batch. The elements of the array are ordered according to the order in which commands were added to the batch.
- Throws:
SQLException- if a database access error occurs or the driver does not support batch statements. ThrowsBatchUpdateException(a subclass ofSQLException) if one of the commands sent to the database fails to execute properly or attempts to return a result set.- Since:
- 1.3
-
executeQuery
public ResultSet executeQuery(String sql) throws SQLException
Executes the given SQL statement, which returns a singleResultSetobject.- Specified by:
executeQueryin interfaceStatement- Parameters:
sql- an SQL statement to be sent to the database, typically a static SQLSELECTstatement- Returns:
- a
ResultSetobject that contains the data produced by the given query; nevernull - Throws:
SQLException- if a database access error occurs or the given SQL statement produces anything other than a singleResultSetobject
-
executeUpdate
public int executeUpdate(String sql) throws SQLException
Executes the given SQL statement, which may be anINSERT,UPDATE, orDELETEstatement or an SQL statement that returns nothing, such as an SQL DDL statement.- Specified by:
executeUpdatein interfaceStatement- Parameters:
sql- an SQLINSERT,UPDATEorDELETEstatement or an SQL statement that returns nothing- Returns:
- either the row count for
INSERT,UPDATEorDELETEstatements, or0for SQL statements that return nothing - Throws:
SQLException- if a database access error occurs or the given SQL statement produces aResultSetobject
-
executeUpdate
public int executeUpdate(String sql, int autoGeneratedKeys) throws SQLException
Executes the given SQL statement and signals the driver with the given flag about whether the auto-generated keys produced by thisStatementobject should be made available for retrieval.- Specified by:
executeUpdatein interfaceStatement- Parameters:
sql- must be an SQLINSERT,UPDATEorDELETEstatement or an SQL statement that returns nothingautoGeneratedKeys- a flag indicating whether auto-generated keys should be made available for retrieval; one of the following constants:Statement.RETURN_GENERATED_KEYSStatement.NO_GENERATED_KEYS- Returns:
- either the row count for
INSERT,UPDATEorDELETEstatements, or0for SQL statements that return nothing - Throws:
SQLException- if a database access error occurs, the given SQL statement returns aResultSetobject, or the given constant is not one of those allowed- Since:
- 1.4
-
executeUpdate
public int executeUpdate(String sql, int[] columnIndexes) throws SQLException
Executes the given SQL statement and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval. The driver will ignore the array if the SQL statement is not anINSERTstatement.- Specified by:
executeUpdatein interfaceStatement- Parameters:
sql- an SQLINSERT,UPDATEorDELETEstatement or an SQL statement that returns nothing, such as an SQL DDL statementcolumnIndexes- an array of column indexes indicating the columns that should be returned from the inserted row- Returns:
- either the row count for
INSERT,UPDATE, orDELETEstatements, or 0 for SQL statements that return nothing - Throws:
SQLException- if a database access error occurs, the SQL statement returns aResultSetobject, or the second argument supplied to this method is not anintarray whose elements are valid column indexes- Since:
- 1.4
-
executeUpdate
public int executeUpdate(String sql, String[] columnNames) throws SQLException
Executes the given SQL statement and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval. The driver will ignore the array if the SQL statement is not anINSERTstatement.- Specified by:
executeUpdatein interfaceStatement- Parameters:
sql- an SQLINSERT,UPDATEorDELETEstatement or an SQL statement that returns nothingcolumnNames- an array of the names of the columns that should be returned from the inserted row- Returns:
- either the row count for
INSERT,UPDATE, orDELETEstatements, or 0 for SQL statements that return nothing - Throws:
SQLException- if a database access error occurs, the SQL statement returns aResultSetobject, or the second argument supplied to this method is not aStringarray whose elements are valid column names- Since:
- 1.4
-
getConnection
public Connection getConnection() throws SQLException
Retrieves theConnectionobject that produced thisStatementobject.- Specified by:
getConnectionin interfaceStatement- Returns:
- the connection that produced this statement
- Throws:
SQLException- if a database access error occurs- Since:
- 1.2
-
getFetchDirection
public int getFetchDirection() throws SQLExceptionRetrieves the direction for fetching rows from database tables that is the default for result sets generated from thisStatementobject. If thisStatementobject has not set a fetch direction by calling the methodsetFetchDirection, the return value is implementation-specific.- Specified by:
getFetchDirectionin interfaceStatement- Returns:
- the default fetch direction for result sets generated
from this
Statementobject - Throws:
SQLException- if a database access error occurs- Since:
- 1.2
- See Also:
setFetchDirection(int)
-
getFetchSize
public int getFetchSize() throws SQLExceptionRetrieves the number of result set rows that is the default fetch size forResultSetobjects generated from thisStatementobject. If thisStatementobject has not set a fetch size by calling the methodsetFetchSize, the return value is implementation-specific.- Specified by:
getFetchSizein interfaceStatement- Returns:
- the default fetch size for result sets generated
from this
Statementobject - Throws:
SQLException- if a database access error occurs- Since:
- 1.2
- See Also:
setFetchSize(int)
-
getGeneratedKeys
public ResultSet getGeneratedKeys() throws SQLException
Retrieves any auto-generated keys created as a result of executing thisStatementobject. If thisStatementobject did not generate any keys, an emptyResultSetobject is returned.- Specified by:
getGeneratedKeysin interfaceStatement- Returns:
- a
ResultSetobject containing the auto-generated key(s) generated by the execution of thisStatementobject - Throws:
SQLException- if a database access error occurs- Since:
- 1.4
-
getMaxFieldSize
public int getMaxFieldSize() throws SQLExceptionRetrieves the maximum number of bytes that can be returned for character and binary column values in aResultSetobject produced by thisStatementobject. This limit applies only toBINARY,VARBINARY,LONGVARBINARY,CHAR,VARCHAR, andLONGVARCHARcolumns. If the limit is exceeded, the excess data is silently discarded.- Specified by:
getMaxFieldSizein interfaceStatement- Returns:
- the current column size limit for columns storing character and binary values; zero means there is no limit
- Throws:
SQLException- if a database access error occurs- See Also:
setMaxFieldSize(int)
-
getMaxRows
public int getMaxRows() throws SQLExceptionRetrieves the maximum number of rows that aResultSetobject produced by thisStatementobject can contain. If this limit is exceeded, the excess rows are silently dropped.- Specified by:
getMaxRowsin interfaceStatement- Returns:
- the current maximum number of rows for a
ResultSetobject produced by thisStatementobject; zero means there is no limit - Throws:
SQLException- if a database access error occurs- See Also:
setMaxRows(int)
-
getMoreResults
public boolean getMoreResults() throws SQLExceptionMoves to thisStatementobject's next result, returnstrueif it is aResultSetobject, and implicitly closes any currentResultSetobject(s) obtained with the methodgetResultSet.- Specified by:
getMoreResultsin interfaceStatement- Returns:
trueif the next result is aResultSetobject;falseif it is an update count or there are no more results- Throws:
SQLException- if a database access error occurs- See Also:
execute()
-
getMoreResults
public boolean getMoreResults(int current) throws SQLExceptionMoves to thisStatementobject's next result, deals with any currentResultSetobject(s) according to the instructions specified by the given flag, and returnstrueif the next result is aResultSetobject.- Specified by:
getMoreResultsin interfaceStatement- Parameters:
current- one of the followingStatementconstants indicating what should happen to currentResultSetobjects obtained using the methodgetResultSet:Statement.CLOSE_CURRENT_RESULT,Statement.KEEP_CURRENT_RESULT, orStatement.CLOSE_ALL_RESULTS- Returns:
trueif the next result is aResultSetobject;falseif it is an update count or there are no more results- Throws:
SQLException- if a database access error occurs or the argument supplied is not one of the following:Statement.CLOSE_CURRENT_RESULT,Statement.KEEP_CURRENT_RESULT, orStatement.CLOSE_ALL_RESULTS- Since:
- 1.4
- See Also:
execute()
-
getQueryTimeout
public int getQueryTimeout() throws SQLExceptionRetrieves the number of seconds the driver will wait for aStatementobject to execute. If the limit is exceeded, aSQLExceptionis thrown.- Specified by:
getQueryTimeoutin interfaceStatement- Returns:
- the current query timeout limit in seconds; zero means there is no limit
- Throws:
SQLException- if a database access error occurs- See Also:
setQueryTimeout(int)
-
getResultSet
public ResultSet getResultSet() throws SQLException
Retrieves the current result as aResultSetobject. This method should be called only once per result.- Specified by:
getResultSetin interfaceStatement- Returns:
- the current result as a
ResultSetobject ornullif the result is an update count or there are no more results - Throws:
SQLException- if a database access error occurs- See Also:
execute()
-
getResultSetConcurrency
public int getResultSetConcurrency() throws SQLExceptionRetrieves the result set concurrency forResultSetobjects generated by thisStatementobject.- Specified by:
getResultSetConcurrencyin interfaceStatement- Returns:
- either
ResultSet.CONCUR_READ_ONLYorResultSet.CONCUR_UPDATABLE - Throws:
SQLException- if a database access error occurs- Since:
- 1.2
-
getResultSetHoldability
public int getResultSetHoldability() throws SQLExceptionRetrieves the result set holdability forResultSetobjects generated by thisStatementobject.- Specified by:
getResultSetHoldabilityin interfaceStatement- Returns:
- either
ResultSet.HOLD_CURSORS_OVER_COMMITorResultSet.CLOSE_CURSORS_AT_COMMIT - Throws:
SQLException- if a database access error occurs- Since:
- 1.4
-
getResultSetType
public int getResultSetType() throws SQLExceptionRetrieves the result set type forResultSetobjects generated by thisStatementobject.- Specified by:
getResultSetTypein interfaceStatement- Returns:
- one of
ResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVE - Throws:
SQLException- if a database access error occurs- Since:
- 1.2
-
getUpdateCount
public int getUpdateCount() throws SQLExceptionRetrieves the current result as an update count; if the result is aResultSetobject or there are no more results, -1 is returned. This method should be called only once per result.- Specified by:
getUpdateCountin interfaceStatement- Returns:
- the current result as an update count; -1 if the current result is a
ResultSetobject or there are no more results - Throws:
SQLException- if a database access error occurs- See Also:
execute()
-
getWarnings
public SQLWarning getWarnings() throws SQLException
Retrieves the first warning reported by calls on thisStatementobject. SubsequentStatementobject warnings will be chained to thisSQLWarningobject.The warning chain is automatically cleared each time a statement is (re)executed. This method may not be called on a closed
Statementobject; doing so will cause anSQLExceptionto be thrown.Note: If you are processing a
ResultSetobject, any warnings associated with reads on thatResultSetobject will be chained on it rather than on theStatementobject that produced it.- Specified by:
getWarningsin interfaceStatement- Returns:
- the first
SQLWarningobject ornullif there are no warnings - Throws:
SQLException- if a database access error occurs or this method is called on a closed statement
-
setCursorName
public void setCursorName(String name) throws SQLException
Sets the SQL cursor name to the givenString, which will be used by subsequentStatementobjectexecutemethods. This name can then be used in SQL positioned update or delete statements to identify the current row in theResultSetobject generated by this statement. If the database does not support positioned update/delete, this method is a noop. To insure that a cursor has the proper isolation level to support updates, the cursor'sSELECTstatement should have the formSELECT FOR UPDATE. IfFOR UPDATEis not present, positioned updates may fail.Note: By definition, the execution of positioned updates and deletes must be done by a different
Statementobject than the one that generated theResultSetobject being used for positioning. Also, cursor names must be unique within a connection.- Specified by:
setCursorNamein interfaceStatement- Parameters:
name- the new cursor name, which must be unique within a connection- Throws:
SQLException- if a database access error occurs
-
setEscapeProcessing
public void setEscapeProcessing(boolean enable) throws SQLExceptionSets escape processing on or off. If escape scanning is on (the default), the driver will do escape substitution before sending the SQL statement to the database. Note: Since prepared statements have usually been parsed prior to making this call, disabling escape processing forPreparedStatementsobjects will have no effect.- Specified by:
setEscapeProcessingin interfaceStatement- Parameters:
enable-trueto enable escape processing;falseto disable it- Throws:
SQLException- if a database access error occurs
-
setFetchDirection
public void setFetchDirection(int direction) throws SQLExceptionGives the driver a hint as to the direction in which rows will be processed inResultSetobjects created using thisStatementobject. The default value isResultSet.FETCH_FORWARD.Note that this method sets the default fetch direction for result sets generated by this
Statementobject. Each result set has its own methods for getting and setting its own fetch direction.- Specified by:
setFetchDirectionin interfaceStatement- Parameters:
direction- the initial direction for processing rows- Throws:
SQLException- if a database access error occurs or the given direction is not one ofResultSet.FETCH_FORWARD,ResultSet.FETCH_REVERSE, orResultSet.FETCH_UNKNOWN- Since:
- 1.2
- See Also:
getFetchDirection()
-
setFetchSize
public void setFetchSize(int rows) throws SQLExceptionGives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed. The number of rows specified affects only result sets created using this statement. If the value specified is zero, then the hint is ignored. The default value is zero.- Specified by:
setFetchSizein interfaceStatement- Parameters:
rows- the number of rows to fetch- Throws:
SQLException- if a database access error occurs, or the condition 0 <=rows<=this.getMaxRows()is not satisfied.- Since:
- 1.2
- See Also:
getFetchSize()
-
setMaxFieldSize
public void setMaxFieldSize(int max) throws SQLExceptionSets the limit for the maximum number of bytes in aResultSetcolumn storing character or binary values to the given number of bytes. This limit applies only toBINARY,VARBINARY,LONGVARBINARY,CHAR,VARCHAR, andLONGVARCHARfields. If the limit is exceeded, the excess data is silently discarded. For maximum portability, use values greater than 256.- Specified by:
setMaxFieldSizein interfaceStatement- Parameters:
max- the new column size limit in bytes; zero means there is no limit- Throws:
SQLException- if a database access error occurs or the condition max >= 0 is not satisfied- See Also:
getMaxFieldSize()
-
setMaxRows
public void setMaxRows(int max) throws SQLExceptionSets the limit for the maximum number of rows that anyResultSetobject can contain to the given number. If the limit is exceeded, the excess rows are silently dropped.- Specified by:
setMaxRowsin interfaceStatement- Parameters:
max- the new max rows limit; zero means there is no limit- Throws:
SQLException- if a database access error occurs or the condition max >= 0 is not satisfied- See Also:
getMaxRows()
-
setQueryTimeout
public void setQueryTimeout(int seconds) throws SQLExceptionSets the number of seconds the driver will wait for aStatementobject to execute to the given number of seconds. If the limit is exceeded, anSQLExceptionis thrown.- Specified by:
setQueryTimeoutin interfaceStatement- Parameters:
seconds- the new query timeout limit in seconds; zero means there is no limit- Throws:
SQLException- if a database access error occurs or the condition seconds >= 0 is not satisfied- See Also:
getQueryTimeout()
-
isClosed
public boolean isClosed() throws SQLException- Specified by:
isClosedin interfaceStatement- Throws:
SQLException- See Also:
Statement.isClosed()
-
setPoolable
public void setPoolable(boolean poolable) throws SQLException- Specified by:
setPoolablein interfaceStatement- Throws:
SQLException- See Also:
Statement.setPoolable(boolean)
-
isPoolable
public boolean isPoolable() throws SQLException- Specified by:
isPoolablein interfaceStatement- Throws:
SQLException- See Also:
Statement.isPoolable()
-
closeOnCompletion
public void closeOnCompletion() throws SQLException- Specified by:
closeOnCompletionin interfaceStatement- Throws:
SQLException- See Also:
Statement.closeOnCompletion()
-
isCloseOnCompletion
public boolean isCloseOnCompletion() throws SQLException- Specified by:
isCloseOnCompletionin interfaceStatement- Throws:
SQLException- See Also:
Statement.isCloseOnCompletion()
-
unwrap
public <T> T unwrap(Class<T> iface) throws SQLException
- Specified by:
unwrapin interfaceWrapper- Throws:
SQLException
-
isWrapperFor
public boolean isWrapperFor(Class<?> iface) throws SQLException
- Specified by:
isWrapperForin interfaceWrapper- Throws:
SQLException- See Also:
Wrapper.isWrapperFor(Class)
-
setRowId
public void setRowId(int parameterIndex, RowId x) throws SQLException- Specified by:
setRowIdin interfacePreparedStatement- Throws:
SQLException- See Also:
PreparedStatement.setRowId(int, RowId)
-
setNString
public void setNString(int parameterIndex, String value) throws SQLException- Specified by:
setNStringin interfacePreparedStatement- Throws:
SQLException- See Also:
PreparedStatement.setNString(int, String)
-
setNCharacterStream
public void setNCharacterStream(int parameterIndex, Reader value, long length) throws SQLException- Specified by:
setNCharacterStreamin interfacePreparedStatement- Throws:
SQLException- See Also:
PreparedStatement.setNCharacterStream(int, Reader, long)
-
setNClob
public void setNClob(int parameterIndex, NClob value) throws SQLException- Specified by:
setNClobin interfacePreparedStatement- Throws:
SQLException- See Also:
PreparedStatement.setNClob(int, Reader)
-
setClob
public void setClob(int parameterIndex, Reader reader, long length) throws SQLException- Specified by:
setClobin interfacePreparedStatement- Throws:
SQLException- See Also:
PreparedStatement.setClob(int, Reader, long)
-
setBlob
public void setBlob(int parameterIndex, InputStream inputStream, long length) throws SQLException- Specified by:
setBlobin interfacePreparedStatement- Throws:
SQLException- See Also:
PreparedStatement.setBlob(int, InputStream, long)
-
setNClob
public void setNClob(int parameterIndex, Reader reader, long length) throws SQLException- Specified by:
setNClobin interfacePreparedStatement- Throws:
SQLException- See Also:
PreparedStatement.setNClob(int, Reader, long)
-
setSQLXML
public void setSQLXML(int parameterIndex, SQLXML xmlObject) throws SQLException- Specified by:
setSQLXMLin interfacePreparedStatement- Throws:
SQLException- See Also:
PreparedStatement.setSQLXML(int, SQLXML)
-
setAsciiStream
public void setAsciiStream(int parameterIndex, InputStream x, long length) throws SQLException- Specified by:
setAsciiStreamin interfacePreparedStatement- Throws:
SQLException- See Also:
PreparedStatement.setAsciiStream(int, InputStream, long)
-
setBinaryStream
public void setBinaryStream(int parameterIndex, InputStream x, long length) throws SQLException- Specified by:
setBinaryStreamin interfacePreparedStatement- Throws:
SQLException- See Also:
PreparedStatement.setBinaryStream(int, InputStream, long)
-
setCharacterStream
public void setCharacterStream(int parameterIndex, Reader reader, long length) throws SQLException- Specified by:
setCharacterStreamin interfacePreparedStatement- Throws:
SQLException- See Also:
PreparedStatement.setCharacterStream(int, Reader, long)
-
setAsciiStream
public void setAsciiStream(int parameterIndex, InputStream x) throws SQLException- Specified by:
setAsciiStreamin interfacePreparedStatement- Throws:
SQLException- See Also:
PreparedStatement.setAsciiStream(int, InputStream)
-
setBinaryStream
public void setBinaryStream(int parameterIndex, InputStream x) throws SQLException- Specified by:
setBinaryStreamin interfacePreparedStatement- Throws:
SQLException- See Also:
PreparedStatement.setBinaryStream(int, InputStream)
-
setCharacterStream
public void setCharacterStream(int parameterIndex, Reader reader) throws SQLException- Specified by:
setCharacterStreamin interfacePreparedStatement- Throws:
SQLException- See Also:
PreparedStatement.setCharacterStream(int, Reader)
-
setNCharacterStream
public void setNCharacterStream(int parameterIndex, Reader value) throws SQLException- Specified by:
setNCharacterStreamin interfacePreparedStatement- Throws:
SQLException- See Also:
PreparedStatement.setNCharacterStream(int, Reader)
-
setClob
public void setClob(int parameterIndex, Reader reader) throws SQLException- Specified by:
setClobin interfacePreparedStatement- Throws:
SQLException- See Also:
PreparedStatement.setClob(int, Clob)
-
setBlob
public void setBlob(int parameterIndex, InputStream inputStream) throws SQLException- Specified by:
setBlobin interfacePreparedStatement- Throws:
SQLException- See Also:
PreparedStatement.setBlob(int, InputStream)
-
setNClob
public void setNClob(int parameterIndex, Reader reader) throws SQLException- Specified by:
setNClobin interfacePreparedStatement- Throws:
SQLException- See Also:
PreparedStatement.setNClob(int, Reader)
-
-