public abstract class AbstractCallableStatement extends FBPreparedStatement implements java.sql.CallableStatement, FirebirdCallableStatement
{?= call <procedure-name>[<arg1>,<arg2>, ...]} {call <procedure-name>[<arg1>,<arg2>, ...]}
IN parameter values are set using the set methods inherited from
PreparedStatement
. The type of all OUT parameters must be
registered prior to executing the stored procedure; their values
are retrieved after execution via the get
methods provided here.
A CallableStatement
can return one ResultSet
or
multiple ResultSet
objects. Multiple
ResultSet
objects are handled using operations
inherited from Statement
.
For maximum portability, a call's ResultSet
objects and
update counts should be processed prior to getting the values of output
parameters.
Methods that are new in the JDBC 2.0 API are marked "Since 1.2." Note: Escape syntax currently is not supported. Please use native Firebird procedure call syntax:
EXECUTE PROCEDURE(param1, ...);
Connection.prepareCall(java.lang.String)
,
ResultSet
AbstractStatement.StatementResult
Modifier and Type | Field and Description |
---|---|
protected FBProcedureCall |
procedureCall |
protected boolean |
selectableProcedure |
batchList, isParamSet
completed, connection, currentStatementResult, fetchSize, firstWarning, fixedStmt, gdsHelper, maxRows, statementListener
TYPE_COMMIT, TYPE_DDL, TYPE_DELETE, TYPE_EXEC_PROCEDURE, TYPE_GET_SEGMENT, TYPE_INSERT, TYPE_PUT_SEGMENT, TYPE_ROLLBACK, TYPE_SELECT, TYPE_SELECT_FOR_UPDATE, TYPE_SET_GENERATOR, TYPE_START_TRANS, TYPE_UPDATE
Modifier | Constructor and Description |
---|---|
protected |
AbstractCallableStatement(org.firebirdsql.gds.impl.GDSHelper c,
java.lang.String sql,
int rsType,
int rsConcurrency,
int rsHoldability,
StoredProcedureMetaData storedProcMetaData,
FBObjectListener.StatementListener statementListener,
FBObjectListener.BlobListener blobListener) |
Modifier and Type | Method and Description |
---|---|
void |
addBatch()
Adds a set of parameters to this
PreparedStatement
object's batch of commands. |
boolean |
equals(java.lang.Object other) |
boolean |
execute()
Executes an execute stored procedure.
|
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()
Execute query.
|
int |
executeUpdate()
Execute query.
|
protected int |
findOutParameter(java.lang.String paramName)
Helper method to identify the right resultset column for the give OUT
parameter name.
|
protected java.sql.ResultSet |
getAndAssertSingletonResultSet()
Returns the result set for the singleton row of the callable statement and asserts it has data.
|
java.sql.Array |
getArray(int parameterIndex)
Gets the value of a JDBC
ARRAY parameter as an
Array object in the Java programming language. |
java.sql.Array |
getArray(java.lang.String colName) |
java.math.BigDecimal |
getBigDecimal(int parameterIndex)
Gets the value of a JDBC
NUMERIC parameter as a
java.math.BigDecimal object with as many digits to the
right of the decimal point as the value contains. |
java.math.BigDecimal |
getBigDecimal(int parameterIndex,
int scale)
Deprecated.
|
java.math.BigDecimal |
getBigDecimal(java.lang.String colName) |
java.sql.Blob |
getBlob(int parameterIndex)
Gets the value of a JDBC
BLOB parameter as a
Blob object in the Java programming language. |
java.sql.Blob |
getBlob(java.lang.String colName) |
boolean |
getBoolean(int parameterIndex)
Gets the value of a JDBC
BIT parameter as a boolean
in the Java programming language. |
boolean |
getBoolean(java.lang.String colName) |
byte |
getByte(int parameterIndex)
Gets the value of a JDBC
TINYINT parameter as a byte
in the Java programming language. |
byte |
getByte(java.lang.String colName) |
byte[] |
getBytes(int parameterIndex)
Gets the value of a JDBC
BINARY or VARBINARY
parameter as an array of byte values in the Java
programming language. |
byte[] |
getBytes(java.lang.String colName) |
java.io.Reader |
getCharacterStream(int parameterIndex) |
java.io.Reader |
getCharacterStream(java.lang.String parameterName) |
java.sql.Clob |
getClob(int parameterIndex)
Gets the value of a JDBC
CLOB parameter as a
Clob object in the Java programming language. |
java.sql.Clob |
getClob(java.lang.String colName) |
java.sql.ResultSet |
getCurrentResultSet()
Get current result set.
|
java.sql.Date |
getDate(int parameterIndex)
Gets the value of a JDBC
DATE parameter as a
java.sql.Date object. |
java.sql.Date |
getDate(int parameterIndex,
java.util.Calendar cal)
Gets the value of a JDBC
DATE parameter as a
java.sql.Date object, using
the given Calendar object
to construct the date. |
java.sql.Date |
getDate(java.lang.String colName) |
java.sql.Date |
getDate(java.lang.String colName,
java.util.Calendar cal) |
double |
getDouble(int parameterIndex)
Gets the value of a JDBC
DOUBLE parameter as a double
in the Java programming language. |
double |
getDouble(java.lang.String colName) |
float |
getFloat(int parameterIndex)
Gets the value of a JDBC
FLOAT parameter as a float
in the Java programming language. |
float |
getFloat(java.lang.String colName) |
java.sql.ResultSet |
getGeneratedKeys()
Retrieves any auto-generated keys created as a result of executing this
Statement object. |
int |
getInt(int parameterIndex)
Gets the value of a JDBC
INTEGER parameter as an int
in the Java programming language. |
int |
getInt(java.lang.String colName) |
long |
getLong(int parameterIndex)
Gets the value of a JDBC
BIGINT parameter as a long
in the Java programming language. |
long |
getLong(java.lang.String colName) |
java.sql.ResultSetMetaData |
getMetaData()
Since we deferred the statement preparation until all OUT params are
registered, we ensure that the statement is prepared before the meta
data for the callable statement is obtained.
|
java.io.Reader |
getNCharacterStream(int parameterIndex) |
java.io.Reader |
getNCharacterStream(java.lang.String parameterName) |
java.lang.String |
getNString(int parameterIndex) |
java.lang.String |
getNString(java.lang.String parameterName) |
java.lang.Object |
getObject(int parameterIndex)
Gets the value of a parameter as an
Object in the Java
programming language. |
<T> T |
getObject(int parameterIndex,
java.lang.Class<T> type) |
java.lang.Object |
getObject(int parameterIndex,
java.util.Map map)
Returns an object representing the value of OUT parameter
i and uses map for the custom
mapping of the parameter value. |
java.lang.Object |
getObject(java.lang.String colName) |
<T> T |
getObject(java.lang.String parameterName,
java.lang.Class<T> type) |
java.lang.Object |
getObject(java.lang.String colName,
java.util.Map map) |
java.sql.ParameterMetaData |
getParameterMetaData() |
java.sql.Ref |
getRef(int parameterIndex)
Gets the value of a JDBC
REF(<structured-type>)
parameter as a Ref object in the Java programming language. |
java.sql.Ref |
getRef(java.lang.String colName) |
java.sql.ResultSet |
getResultSet()
Returns the current result as a
ResultSet object. |
short |
getShort(int parameterIndex)
Gets the value of a JDBC
SMALLINT parameter as a short
in the Java programming language. |
short |
getShort(java.lang.String colName) |
java.lang.String |
getString(int parameterIndex)
Retrieves the value of a JDBC
CHAR , VARCHAR ,
or LONGVARCHAR parameter as a String in
the Java programming language. |
java.lang.String |
getString(java.lang.String colName) |
java.sql.Time |
getTime(int parameterIndex)
Get the value of a JDBC
TIME parameter as a
java.sql.Time object. |
java.sql.Time |
getTime(int parameterIndex,
java.util.Calendar cal)
Gets the value of a JDBC
TIME parameter as a
java.sql.Time object, using
the given Calendar object
to construct the time. |
java.sql.Time |
getTime(java.lang.String colName) |
java.sql.Time |
getTime(java.lang.String colName,
java.util.Calendar cal) |
java.sql.Timestamp |
getTimestamp(int parameterIndex)
Gets the value of a JDBC
TIMESTAMP parameter as a
java.sql.Timestamp object. |
java.sql.Timestamp |
getTimestamp(int parameterIndex,
java.util.Calendar cal)
Gets the value of a JDBC
TIMESTAMP parameter as a
java.sql.Timestamp object, using
the given Calendar object to construct
the Timestamp object. |
java.sql.Timestamp |
getTimestamp(java.lang.String colName) |
java.sql.Timestamp |
getTimestamp(java.lang.String colName,
java.util.Calendar cal) |
java.net.URL |
getURL(int colIndex) |
java.net.URL |
getURL(java.lang.String colName) |
protected boolean |
internalExecute(boolean sendOutParams)
Execute statement internally.
|
boolean |
isSelectableProcedure()
Retrieve if this callable statement has been marked as selectable.
|
protected void |
prepareFixedStatement(java.lang.String sql,
boolean describeBind)
We allow multiple calls to this method without re-preparing the statement.
|
void |
registerOutParameter(int parameterIndex,
int sqlType)
Registers the OUT parameter in ordinal position
parameterIndex to the JDBC type
sqlType . |
void |
registerOutParameter(int parameterIndex,
int sqlType,
int scale)
Registers the parameter in ordinal position
parameterIndex to be of JDBC type
sqlType . |
void |
registerOutParameter(int parameterIndex,
int sqlType,
java.lang.String typeName) |
void |
registerOutParameter(java.lang.String param1,
int param2) |
void |
registerOutParameter(java.lang.String param1,
int param2,
int param3) |
void |
registerOutParameter(java.lang.String param1,
int param2,
java.lang.String param3) |
void |
setArray(int i,
java.sql.Array x)
Sets the designated parameter to the given
Array object. |
void |
setAsciiStream(java.lang.String parameterName,
java.io.InputStream x) |
void |
setAsciiStream(java.lang.String param1,
java.io.InputStream param2,
int param3) |
void |
setAsciiStream(java.lang.String parameterName,
java.io.InputStream x,
long length) |
void |
setBigDecimal(int parameterIndex,
java.math.BigDecimal x)
Sets the designated parameter to the given BigDecimal
|
void |
setBigDecimal(java.lang.String param1,
java.math.BigDecimal param2) |
void |
setBinaryStream(int parameterIndex,
java.io.InputStream inputStream,
int length)
Sets the designated parameter to the given input stream, which will have
the specified number of bytes.
|
void |
setBinaryStream(java.lang.String parameterName,
java.io.InputStream x) |
void |
setBinaryStream(java.lang.String param1,
java.io.InputStream param2,
int param3) |
void |
setBinaryStream(java.lang.String parameterName,
java.io.InputStream x,
long length) |
void |
setBlob(int parameterIndex,
java.sql.Blob blob)
Sets the designated parameter to the given
Blob object. |
void |
setBlob(java.lang.String parameterName,
java.sql.Blob x) |
void |
setBlob(java.lang.String parameterName,
java.io.InputStream inputStream) |
void |
setBlob(java.lang.String parameterName,
java.io.InputStream inputStream,
long length) |
void |
setBoolean(int parameterIndex,
boolean x)
Sets the designated parameter to the given boolean value.
|
void |
setBoolean(java.lang.String param1,
boolean param2) |
void |
setByte(int parameterIndex,
byte x)
Sets the designated parameter to the given byte value.
|
void |
setByte(java.lang.String param1,
byte param2) |
void |
setBytes(int parameterIndex,
byte[] x)
Set the designated parameter to the given byte array.
|
void |
setBytes(java.lang.String param1,
byte[] param2) |
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(java.lang.String parameterName,
java.io.Reader reader) |
void |
setCharacterStream(java.lang.String param1,
java.io.Reader param2,
int param3) |
void |
setCharacterStream(java.lang.String parameterName,
java.io.Reader reader,
long length) |
void |
setClob(int parameterIndex,
java.sql.Clob x)
Sets the designated parameter to the given
Clob object. |
void |
setClob(java.lang.String parameterName,
java.sql.Clob x) |
void |
setClob(java.lang.String parameterName,
java.io.Reader reader) |
void |
setClob(java.lang.String parameterName,
java.io.Reader reader,
long length) |
void |
setDate(int parameterIndex,
java.sql.Date x)
Sets the designated parameter to the given date value.
|
void |
setDate(int parameterIndex,
java.sql.Date x,
java.util.Calendar cal)
Sets the designated parameter to the given
java.sql.Date
value, using the given Calendar object. |
void |
setDate(java.lang.String param1,
java.sql.Date param2) |
void |
setDate(java.lang.String param1,
java.sql.Date param2,
java.util.Calendar param3) |
void |
setDouble(int parameterIndex,
double x)
Sets the designated parameter to the given double value.
|
void |
setDouble(java.lang.String param1,
double param2) |
void |
setFloat(int parameterIndex,
float x)
Sets the designated parameter to the given floate value.
|
void |
setFloat(java.lang.String param1,
float param2) |
void |
setInt(int parameterIndex,
int x)
Sets the designated parameter to the given int value.
|
void |
setInt(java.lang.String param1,
int param2) |
void |
setLong(int parameterIndex,
long x)
Sets the designated parameter to the given long value.
|
void |
setLong(java.lang.String param1,
long param2) |
void |
setNCharacterStream(java.lang.String parameterName,
java.io.Reader value) |
void |
setNCharacterStream(java.lang.String parameterName,
java.io.Reader value,
long length) |
void |
setNClob(java.lang.String parameterName,
java.io.Reader reader) |
void |
setNClob(java.lang.String parameterName,
java.io.Reader reader,
long length) |
void |
setNString(java.lang.String parameterName,
java.lang.String value) |
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 |
setNull(java.lang.String param1,
int param2) |
void |
setNull(java.lang.String param1,
int param2,
java.lang.String param3) |
void |
setObject(int parameterIndex,
java.lang.Object x)
Sets the value of the designated parameter with 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 scale)
Sets the value of the designated parameter with the given object.
|
void |
setObject(java.lang.String param1,
java.lang.Object param2) |
void |
setObject(java.lang.String param1,
java.lang.Object param2,
int param3) |
void |
setObject(java.lang.String param1,
java.lang.Object param2,
int param3,
int param4) |
void |
setRef(int parameterIndex,
java.sql.Ref x)
Sets the designated parameter to the given
REF(<structured-type>) value. |
protected void |
setRequiredTypes()
Set required types for output parameters.
|
void |
setSelectableProcedure(boolean selectableProcedure)
Mark this callable statement as a call of the selectable procedure.
|
void |
setShort(int parameterIndex,
short x)
Sets the designated parameter to the given short value.
|
void |
setShort(java.lang.String param1,
short param2) |
void |
setString(int parameterIndex,
java.lang.String x)
Sets the designated parameter to the given String value.
|
void |
setString(java.lang.String param1,
java.lang.String param2) |
void |
setTime(int parameterIndex,
java.sql.Time x)
Sets the designated parameter to the given Time value.
|
void |
setTime(int parameterIndex,
java.sql.Time x,
java.util.Calendar cal)
Sets the designated parameter to the given
java.sql.Time
value, using the given Calendar object. |
void |
setTime(java.lang.String param1,
java.sql.Time param2) |
void |
setTime(java.lang.String param1,
java.sql.Time param2,
java.util.Calendar param3) |
void |
setTimestamp(int parameterIndex,
java.sql.Timestamp x)
Sets the designated parameter to the given 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 |
setTimestamp(java.lang.String param1,
java.sql.Timestamp param2) |
void |
setTimestamp(java.lang.String param1,
java.sql.Timestamp param2,
java.util.Calendar param3) |
void |
setUnicodeStream(int parameterIndex,
java.io.InputStream x,
int length)
Deprecated.
|
void |
setURL(int parameterIndex,
java.net.URL x) |
void |
setURL(java.lang.String param1,
java.net.URL param2) |
boolean |
wasNull()
Indicates whether or not the last OUT parameter read had the value of
SQL
NULL . |
executeLargeUpdate, setNClob, setObject, setObject, setRowId, setSQLXML
addBatch, clearBatch, clearParameters, completeStatement, execute, execute, execute, execute, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getExecutionPlan, getField, getFirebirdParameterMetaData, getStatementType, getXsqlvar, notifyStatementCompleted, setAsciiStream, setAsciiStream, setAsciiStream, setBinaryStream, setBinaryStream, setBlob, setBlob, setCharacterStream, setCharacterStream, setClob, setClob, setNCharacterStream, setNCharacterStream, setNClob, setNClob, setNString, setStringForced
addWarning, cancel, checkValidity, clearWarnings, close, closeOnCompletion, completeStatement, finalize, forgetResultSet, getConnection, getDeletedRowsCount, getFetchDirection, getFetchSize, getInsertedRowsCount, getLastExecutionPlan, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getSynchronizationObject, getUpdateCount, getUpdateCountInternal, getUpdatedRowsCount, getWarnings, hashCode, hasOpenResultSet, internalExecute, isClosed, isCloseOnCompletion, isExecuteProcedureStatement, isPoolable, isValid, isWrapperFor, nativeSQL, notifyStatementCompleted, notifyStatementStarted, notifyStatementStarted, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout, toArray, unwrap
clone, getClass, notify, notifyAll, toString, wait, wait, wait
getExecutionPlan, getStatementType
getDeletedRowsCount, getInsertedRowsCount, getLastExecutionPlan, getUpdatedRowsCount, hasOpenResultSet, isClosed, isValid
getNClob, getNClob, getRowId, getRowId, getSQLXML, getSQLXML, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, setNClob, setObject, setObject, setRowId, setSQLXML
clearParameters, executeLargeUpdate, setAsciiStream, setAsciiStream, setAsciiStream, setBinaryStream, setBinaryStream, setBlob, setBlob, setCharacterStream, setCharacterStream, setClob, setClob, setNCharacterStream, setNCharacterStream, setNClob, setNClob, setNClob, setNString, setObject, setObject, setRowId, setSQLXML
addBatch, cancel, clearBatch, clearWarnings, close, closeOnCompletion, execute, execute, execute, execute, executeLargeBatch, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getLargeMaxRows, getLargeUpdateCount, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isCloseOnCompletion, isPoolable, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setLargeMaxRows, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout
protected boolean selectableProcedure
protected FBProcedureCall procedureCall
protected AbstractCallableStatement(org.firebirdsql.gds.impl.GDSHelper c, java.lang.String sql, int rsType, int rsConcurrency, int rsHoldability, StoredProcedureMetaData storedProcMetaData, FBObjectListener.StatementListener statementListener, FBObjectListener.BlobListener blobListener) throws java.sql.SQLException
java.sql.SQLException
public java.sql.ParameterMetaData getParameterMetaData() throws java.sql.SQLException
getParameterMetaData
in interface java.sql.PreparedStatement
getParameterMetaData
in class AbstractPreparedStatement
java.sql.SQLException
public void addBatch() throws java.sql.SQLException
AbstractPreparedStatement
PreparedStatement
object's batch of commands.addBatch
in interface java.sql.PreparedStatement
addBatch
in class AbstractPreparedStatement
java.sql.SQLException
- if a database access error occursStatement.addBatch(java.lang.String)
,
What Is in the JDBC 2.0 API
public int[] executeBatch() throws java.sql.SQLException
AbstractPreparedStatement
int
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:
-2
-- 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:
-3
-- 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
BatchUpdateException
obejct has been thrown.
executeBatch
in interface java.sql.Statement
executeBatch
in class AbstractPreparedStatement
java.sql.SQLException
- if a database access error occurs 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.public void setSelectableProcedure(boolean selectableProcedure)
FirebirdCallableStatement
setSelectableProcedure
in interface FirebirdCallableStatement
selectableProcedure
- true
if the called procedure is selectable.FirebirdCallableStatement.isSelectableProcedure()
public boolean isSelectableProcedure()
FirebirdCallableStatement
isSelectableProcedure
in interface FirebirdCallableStatement
true
if the called procedure is selectable, false otherwiseFirebirdCallableStatement.setSelectableProcedure(boolean)
protected void setRequiredTypes() throws java.sql.SQLException
java.sql.SQLException
- if something went wrong.protected void prepareFixedStatement(java.lang.String sql, boolean describeBind) throws GDSException, java.sql.SQLException
prepareFixedStatement
in class AbstractPreparedStatement
GDSException
java.sql.SQLException
public java.sql.ResultSetMetaData getMetaData() throws java.sql.SQLException
getMetaData
in interface java.sql.PreparedStatement
getMetaData
in class AbstractPreparedStatement
ResultSet
object's columnsjava.sql.SQLException
- if a database access error occurspublic boolean execute() throws java.sql.SQLException
execute
method handles these complex statements as well as the simpler
form of statements handled by the methods executeQuery
and executeUpdate
.execute
in interface java.sql.PreparedStatement
execute
in class AbstractPreparedStatement
java.sql.SQLException
- if a database access error occursStatement.execute(java.lang.String)
public java.sql.ResultSet executeQuery() throws java.sql.SQLException
executeQuery
in interface java.sql.PreparedStatement
executeQuery
in class AbstractPreparedStatement
ResultSet
object that contains the data produced
by the query; never null
java.sql.SQLException
- if a database access error occurspublic int executeUpdate() throws java.sql.SQLException
executeUpdate
in interface java.sql.PreparedStatement
executeUpdate
in class AbstractPreparedStatement
java.sql.SQLException
- if a database access error occursprotected boolean internalExecute(boolean sendOutParams) throws java.sql.SQLException
internalExecute
in class AbstractPreparedStatement
true
if the statement has more result sets.java.sql.SQLException
public void registerOutParameter(int parameterIndex, int sqlType) throws java.sql.SQLException
parameterIndex
to the JDBC type
sqlType
. All OUT parameters must be registered
before a stored procedure is executed.
The JDBC type specified by sqlType
for an OUT
parameter determines the Java type that must be used
in the get
method to read the value of that parameter.
If the JDBC type expected to be returned to this output parameter
is specific to this particular database, sqlType
should be java.sql.Types.OTHER
. The method
getObject(int)
retrieves the value.
registerOutParameter
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onsqlType
- the JDBC type code defined by java.sql.Types
.
If the parameter is of JDBC type NUMERIC
or DECIMAL
, the version of
registerOutParameter
that accepts a scale value
should be used.java.sql.SQLException
- if a database access error occursTypes
public void registerOutParameter(int parameterIndex, int sqlType, int scale) throws java.sql.SQLException
parameterIndex
to be of JDBC type
sqlType
. This method must be called
before a stored procedure is executed.
The JDBC type specified by sqlType
for an OUT
parameter determines the Java type that must be used
in the get
method to read the value of that parameter.
This version of registerOutParameter
should be
used when the parameter is of JDBC type NUMERIC
or DECIMAL
.
registerOutParameter
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onsqlType
- SQL type code defined by java.sql.Types
.scale
- the desired number of digits to the right of the
decimal point. It must be greater than or equal to zero.java.sql.SQLException
- if a database access error occursTypes
public boolean wasNull() throws java.sql.SQLException
NULL
. Note that this method should be called only after
calling a getXXX
method; otherwise, there is no value to use in
determining whether it is null
or not.wasNull
in interface java.sql.CallableStatement
true
if the last parameter read was SQL
NULL
; false
otherwisejava.sql.SQLException
- if a database access error occurspublic java.lang.String getString(int parameterIndex) throws java.sql.SQLException
CHAR
, VARCHAR
,
or LONGVARCHAR
parameter as a String
in
the Java programming language.
For the fixed-length type JDBC CHAR
,
the String
object
returned has exactly the same value the JDBC
CHAR
value had in the
database, including any padding added by the database.
getString
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
, the result
is null
.java.sql.SQLException
- if a database access error occurspublic boolean getBoolean(int parameterIndex) throws java.sql.SQLException
BIT
parameter as a boolean
in the Java programming language.getBoolean
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
, the result
is false
.java.sql.SQLException
- if a database access error occurspublic byte getByte(int parameterIndex) throws java.sql.SQLException
TINYINT
parameter as a byte
in the Java programming language.getByte
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
, the result
is 0.java.sql.SQLException
- if a database access error occurspublic short getShort(int parameterIndex) throws java.sql.SQLException
SMALLINT
parameter as a short
in the Java programming language.getShort
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
, the result
is 0.java.sql.SQLException
- if a database access error occurspublic int getInt(int parameterIndex) throws java.sql.SQLException
INTEGER
parameter as an int
in the Java programming language.getInt
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
, the result
is 0.java.sql.SQLException
- if a database access error occurspublic long getLong(int parameterIndex) throws java.sql.SQLException
BIGINT
parameter as a long
in the Java programming language.getLong
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
, the result
is 0.java.sql.SQLException
- if a database access error occurspublic float getFloat(int parameterIndex) throws java.sql.SQLException
FLOAT
parameter as a float
in the Java programming language.getFloat
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
, the result
is 0.java.sql.SQLException
- if a database access error occurspublic double getDouble(int parameterIndex) throws java.sql.SQLException
DOUBLE
parameter as a double
in the Java programming language.getDouble
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
, the result
is 0.java.sql.SQLException
- if a database access error occurs@Deprecated public java.math.BigDecimal getBigDecimal(int parameterIndex, int scale) throws java.sql.SQLException
NUMERIC
parameter as a
java.math.BigDecimal
object with scale digits to
the right of the decimal point.getBigDecimal
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onscale
- the number of digits to the right of the decimal pointNULL
, the result is
null
.java.sql.SQLException
- if a database access error occurspublic byte[] getBytes(int parameterIndex) throws java.sql.SQLException
BINARY
or VARBINARY
parameter as an array of byte
values in the Java
programming language.getBytes
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
, the result is
null
.java.sql.SQLException
- if a database access error occurspublic java.sql.Date getDate(int parameterIndex) throws java.sql.SQLException
DATE
parameter as a
java.sql.Date
object.getDate
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
, the result
is null
.java.sql.SQLException
- if a database access error occurspublic java.sql.Time getTime(int parameterIndex) throws java.sql.SQLException
TIME
parameter as a
java.sql.Time
object.getTime
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
, the result
is null
.java.sql.SQLException
- if a database access error occurspublic java.sql.Timestamp getTimestamp(int parameterIndex) throws java.sql.SQLException
TIMESTAMP
parameter as a
java.sql.Timestamp
object.getTimestamp
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
, the result
is null
.java.sql.SQLException
- if a database access error occurspublic java.lang.Object getObject(int parameterIndex) throws java.sql.SQLException
Object
in the Java
programming language.
This method returns a Java object whose type corresponds to the JDBC
type that was registered for this parameter using the method
registerOutParameter
. By registering the target JDBC
type as java.sql.Types.OTHER
, this method can be used
to read database-specific abstract data types.
getObject
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onjava.lang.Object
holding the OUT parameter value.java.sql.SQLException
- if a database access error occursTypes
public java.lang.Object getObject(java.lang.String colName) throws java.sql.SQLException
getObject
in interface java.sql.CallableStatement
java.sql.SQLException
public java.lang.Object getObject(int parameterIndex, java.util.Map map) throws java.sql.SQLException
i
and uses map
for the custom
mapping of the parameter value.
This method returns a Java object whose type corresponds to the
JDBC type that was registered for this parameter using the method
registerOutParameter
. By registering the target
JDBC type as java.sql.Types.OTHER
, this method can
be used to read database-specific abstract data types.
getObject
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2, and so onmap
- the mapping from SQL type names to Java classesjava.lang.Object
holding the OUT parameter valuejava.sql.SQLException
- if a database access error occurspublic java.lang.Object getObject(java.lang.String colName, java.util.Map map) throws java.sql.SQLException
getObject
in interface java.sql.CallableStatement
java.sql.SQLException
public <T> T getObject(int parameterIndex, java.lang.Class<T> type) throws java.sql.SQLException
getObject
in interface java.sql.CallableStatement
java.sql.SQLException
public <T> T getObject(java.lang.String parameterName, java.lang.Class<T> type) throws java.sql.SQLException
getObject
in interface java.sql.CallableStatement
java.sql.SQLException
public java.math.BigDecimal getBigDecimal(int parameterIndex) throws java.sql.SQLException
NUMERIC
parameter as a
java.math.BigDecimal
object with as many digits to the
right of the decimal point as the value contains.getBigDecimal
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onNULL
, the result is null
.java.sql.SQLException
- if a database access error occurspublic java.sql.Ref getRef(int parameterIndex) throws java.sql.SQLException
REF(<structured-type>)
parameter as a Ref
object in the Java programming language.getRef
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so onRef
object in the
Java programming language. If the value was SQL NULL
, the value
null
is returned.java.sql.SQLException
- if a database access error occurspublic java.sql.Blob getBlob(int parameterIndex) throws java.sql.SQLException
BLOB
parameter as a
Blob
object in the Java programming language.getBlob
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2, and so onBlob
object in the
Java programming language. If the value was SQL NULL
, the value
null
is returned.java.sql.SQLException
- if a database access error occurspublic java.sql.Clob getClob(int parameterIndex) throws java.sql.SQLException
CLOB
parameter as a
Clob
object in the Java programming language.getClob
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2, and
so onClob
object in the
Java programming language. If the value was SQL NULL
, the
value null
is returned.java.sql.SQLException
- if a database access error occurspublic java.sql.Array getArray(int parameterIndex) throws java.sql.SQLException
ARRAY
parameter as an
Array
object in the Java programming language.getArray
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2, and
so onArray
object in
the Java programming language. If the value was SQL NULL
, the
value null
is returned.java.sql.SQLException
- if a database access error occurspublic java.sql.Date getDate(int parameterIndex, java.util.Calendar cal) throws java.sql.SQLException
DATE
parameter as a
java.sql.Date
object, using
the given Calendar
object
to construct the date.
With a Calendar
object, the driver
can calculate the date taking into account a custom timezone and locale.
If no Calendar
object is specified, the driver uses the
default timezone and locale.getDate
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so oncal
- the Calendar
object the driver will use
to construct the dateNULL
, the result is
null
.java.sql.SQLException
- if a database access error occurspublic java.sql.Time getTime(int parameterIndex, java.util.Calendar cal) throws java.sql.SQLException
TIME
parameter as a
java.sql.Time
object, using
the given Calendar
object
to construct the time.
With a Calendar
object, the driver
can calculate the time taking into account a custom timezone and locale.
If no Calendar
object is specified, the driver uses the
default timezone and locale.getTime
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so oncal
- the Calendar
object the driver will use
to construct the timeNULL
, the result is
null
.java.sql.SQLException
- if a database access error occurspublic java.sql.Timestamp getTimestamp(int parameterIndex, java.util.Calendar cal) throws java.sql.SQLException
TIMESTAMP
parameter as a
java.sql.Timestamp
object, using
the given Calendar
object to construct
the Timestamp
object.
With a Calendar
object, the driver
can calculate the timestamp taking into account a custom timezone and locale.
If no Calendar
object is specified, the driver uses the
default timezone and locale.getTimestamp
in interface java.sql.CallableStatement
parameterIndex
- the first parameter is 1, the second is 2,
and so oncal
- the Calendar
object the driver will use
to construct the timestampNULL
, the result is
null
.java.sql.SQLException
- if a database access error occurspublic java.net.URL getURL(int colIndex) throws java.sql.SQLException
getURL
in interface java.sql.CallableStatement
java.sql.SQLException
public java.lang.String getString(java.lang.String colName) throws java.sql.SQLException
getString
in interface java.sql.CallableStatement
java.sql.SQLException
public boolean getBoolean(java.lang.String colName) throws java.sql.SQLException
getBoolean
in interface java.sql.CallableStatement
java.sql.SQLException
public byte getByte(java.lang.String colName) throws java.sql.SQLException
getByte
in interface java.sql.CallableStatement
java.sql.SQLException
public short getShort(java.lang.String colName) throws java.sql.SQLException
getShort
in interface java.sql.CallableStatement
java.sql.SQLException
public int getInt(java.lang.String colName) throws java.sql.SQLException
getInt
in interface java.sql.CallableStatement
java.sql.SQLException
public long getLong(java.lang.String colName) throws java.sql.SQLException
getLong
in interface java.sql.CallableStatement
java.sql.SQLException
public float getFloat(java.lang.String colName) throws java.sql.SQLException
getFloat
in interface java.sql.CallableStatement
java.sql.SQLException
public double getDouble(java.lang.String colName) throws java.sql.SQLException
getDouble
in interface java.sql.CallableStatement
java.sql.SQLException
public byte[] getBytes(java.lang.String colName) throws java.sql.SQLException
getBytes
in interface java.sql.CallableStatement
java.sql.SQLException
public java.sql.Date getDate(java.lang.String colName) throws java.sql.SQLException
getDate
in interface java.sql.CallableStatement
java.sql.SQLException
public java.sql.Time getTime(java.lang.String colName) throws java.sql.SQLException
getTime
in interface java.sql.CallableStatement
java.sql.SQLException
public java.sql.Timestamp getTimestamp(java.lang.String colName) throws java.sql.SQLException
getTimestamp
in interface java.sql.CallableStatement
java.sql.SQLException
public java.math.BigDecimal getBigDecimal(java.lang.String colName) throws java.sql.SQLException
getBigDecimal
in interface java.sql.CallableStatement
java.sql.SQLException
public java.sql.Ref getRef(java.lang.String colName) throws java.sql.SQLException
getRef
in interface java.sql.CallableStatement
java.sql.SQLException
public java.sql.Blob getBlob(java.lang.String colName) throws java.sql.SQLException
getBlob
in interface java.sql.CallableStatement
java.sql.SQLException
public java.sql.Clob getClob(java.lang.String colName) throws java.sql.SQLException
getClob
in interface java.sql.CallableStatement
java.sql.SQLException
public java.sql.Array getArray(java.lang.String colName) throws java.sql.SQLException
getArray
in interface java.sql.CallableStatement
java.sql.SQLException
public java.sql.Date getDate(java.lang.String colName, java.util.Calendar cal) throws java.sql.SQLException
getDate
in interface java.sql.CallableStatement
java.sql.SQLException
public java.sql.Time getTime(java.lang.String colName, java.util.Calendar cal) throws java.sql.SQLException
getTime
in interface java.sql.CallableStatement
java.sql.SQLException
public java.sql.Timestamp getTimestamp(java.lang.String colName, java.util.Calendar cal) throws java.sql.SQLException
getTimestamp
in interface java.sql.CallableStatement
java.sql.SQLException
public java.net.URL getURL(java.lang.String colName) throws java.sql.SQLException
getURL
in interface java.sql.CallableStatement
java.sql.SQLException
public java.io.Reader getCharacterStream(int parameterIndex) throws java.sql.SQLException
getCharacterStream
in interface java.sql.CallableStatement
java.sql.SQLException
public java.io.Reader getCharacterStream(java.lang.String parameterName) throws java.sql.SQLException
getCharacterStream
in interface java.sql.CallableStatement
java.sql.SQLException
public java.io.Reader getNCharacterStream(int parameterIndex) throws java.sql.SQLException
getNCharacterStream
in interface java.sql.CallableStatement
java.sql.SQLException
public java.io.Reader getNCharacterStream(java.lang.String parameterName) throws java.sql.SQLException
getNCharacterStream
in interface java.sql.CallableStatement
java.sql.SQLException
public java.lang.String getNString(int parameterIndex) throws java.sql.SQLException
getNString
in interface java.sql.CallableStatement
java.sql.SQLException
public java.lang.String getNString(java.lang.String parameterName) throws java.sql.SQLException
getNString
in interface java.sql.CallableStatement
java.sql.SQLException
public void setAsciiStream(java.lang.String parameterName, java.io.InputStream x, long length) throws java.sql.SQLException
setAsciiStream
in interface java.sql.CallableStatement
java.sql.SQLException
public void setAsciiStream(java.lang.String parameterName, java.io.InputStream x) throws java.sql.SQLException
setAsciiStream
in interface java.sql.CallableStatement
java.sql.SQLException
public void setBinaryStream(java.lang.String parameterName, java.io.InputStream x, long length) throws java.sql.SQLException
setBinaryStream
in interface java.sql.CallableStatement
java.sql.SQLException
public void setBinaryStream(java.lang.String parameterName, java.io.InputStream x) throws java.sql.SQLException
setBinaryStream
in interface java.sql.CallableStatement
java.sql.SQLException
public void setBlob(java.lang.String parameterName, java.sql.Blob x) throws java.sql.SQLException
setBlob
in interface java.sql.CallableStatement
java.sql.SQLException
public void setBlob(java.lang.String parameterName, java.io.InputStream inputStream, long length) throws java.sql.SQLException
setBlob
in interface java.sql.CallableStatement
java.sql.SQLException
public void setBlob(java.lang.String parameterName, java.io.InputStream inputStream) throws java.sql.SQLException
setBlob
in interface java.sql.CallableStatement
java.sql.SQLException
public void setCharacterStream(java.lang.String parameterName, java.io.Reader reader, long length) throws java.sql.SQLException
setCharacterStream
in interface java.sql.CallableStatement
java.sql.SQLException
public void setCharacterStream(java.lang.String parameterName, java.io.Reader reader) throws java.sql.SQLException
setCharacterStream
in interface java.sql.CallableStatement
java.sql.SQLException
public void setClob(java.lang.String parameterName, java.sql.Clob x) throws java.sql.SQLException
setClob
in interface java.sql.CallableStatement
java.sql.SQLException
public void setClob(java.lang.String parameterName, java.io.Reader reader, long length) throws java.sql.SQLException
setClob
in interface java.sql.CallableStatement
java.sql.SQLException
public void setClob(java.lang.String parameterName, java.io.Reader reader) throws java.sql.SQLException
setClob
in interface java.sql.CallableStatement
java.sql.SQLException
public void setNCharacterStream(java.lang.String parameterName, java.io.Reader value, long length) throws java.sql.SQLException
setNCharacterStream
in interface java.sql.CallableStatement
java.sql.SQLException
public void setNCharacterStream(java.lang.String parameterName, java.io.Reader value) throws java.sql.SQLException
setNCharacterStream
in interface java.sql.CallableStatement
java.sql.SQLException
public void setNClob(java.lang.String parameterName, java.io.Reader reader, long length) throws java.sql.SQLException
setNClob
in interface java.sql.CallableStatement
java.sql.SQLException
public void setNClob(java.lang.String parameterName, java.io.Reader reader) throws java.sql.SQLException
setNClob
in interface java.sql.CallableStatement
java.sql.SQLException
public void setNString(java.lang.String parameterName, java.lang.String value) throws java.sql.SQLException
setNString
in interface java.sql.CallableStatement
java.sql.SQLException
public void registerOutParameter(java.lang.String param1, int param2) throws java.sql.SQLException
registerOutParameter
in interface java.sql.CallableStatement
java.sql.SQLException
public void registerOutParameter(java.lang.String param1, int param2, int param3) throws java.sql.SQLException
registerOutParameter
in interface java.sql.CallableStatement
java.sql.SQLException
public void registerOutParameter(java.lang.String param1, int param2, java.lang.String param3) throws java.sql.SQLException
registerOutParameter
in interface java.sql.CallableStatement
java.sql.SQLException
public void setURL(java.lang.String param1, java.net.URL param2) throws java.sql.SQLException
setURL
in interface java.sql.CallableStatement
java.sql.SQLException
public void setNull(java.lang.String param1, int param2) throws java.sql.SQLException
setNull
in interface java.sql.CallableStatement
java.sql.SQLException
public void setBoolean(java.lang.String param1, boolean param2) throws java.sql.SQLException
setBoolean
in interface java.sql.CallableStatement
java.sql.SQLException
public void setByte(java.lang.String param1, byte param2) throws java.sql.SQLException
setByte
in interface java.sql.CallableStatement
java.sql.SQLException
public void setShort(java.lang.String param1, short param2) throws java.sql.SQLException
setShort
in interface java.sql.CallableStatement
java.sql.SQLException
public void setInt(java.lang.String param1, int param2) throws java.sql.SQLException
setInt
in interface java.sql.CallableStatement
java.sql.SQLException
public void setLong(java.lang.String param1, long param2) throws java.sql.SQLException
setLong
in interface java.sql.CallableStatement
java.sql.SQLException
public void setFloat(java.lang.String param1, float param2) throws java.sql.SQLException
setFloat
in interface java.sql.CallableStatement
java.sql.SQLException
public void setDouble(java.lang.String param1, double param2) throws java.sql.SQLException
setDouble
in interface java.sql.CallableStatement
java.sql.SQLException
public void setBigDecimal(java.lang.String param1, java.math.BigDecimal param2) throws java.sql.SQLException
setBigDecimal
in interface java.sql.CallableStatement
java.sql.SQLException
public void setString(java.lang.String param1, java.lang.String param2) throws java.sql.SQLException
setString
in interface java.sql.CallableStatement
java.sql.SQLException
public void setBytes(java.lang.String param1, byte[] param2) throws java.sql.SQLException
setBytes
in interface java.sql.CallableStatement
java.sql.SQLException
public void setDate(java.lang.String param1, java.sql.Date param2) throws java.sql.SQLException
setDate
in interface java.sql.CallableStatement
java.sql.SQLException
public void setTime(java.lang.String param1, java.sql.Time param2) throws java.sql.SQLException
setTime
in interface java.sql.CallableStatement
java.sql.SQLException
public void setTimestamp(java.lang.String param1, java.sql.Timestamp param2) throws java.sql.SQLException
setTimestamp
in interface java.sql.CallableStatement
java.sql.SQLException
public void setAsciiStream(java.lang.String param1, java.io.InputStream param2, int param3) throws java.sql.SQLException
setAsciiStream
in interface java.sql.CallableStatement
java.sql.SQLException
public void setBinaryStream(java.lang.String param1, java.io.InputStream param2, int param3) throws java.sql.SQLException
setBinaryStream
in interface java.sql.CallableStatement
java.sql.SQLException
public void setObject(java.lang.String param1, java.lang.Object param2, int param3, int param4) throws java.sql.SQLException
setObject
in interface java.sql.CallableStatement
java.sql.SQLException
public void setObject(java.lang.String param1, java.lang.Object param2, int param3) throws java.sql.SQLException
setObject
in interface java.sql.CallableStatement
java.sql.SQLException
public void setObject(java.lang.String param1, java.lang.Object param2) throws java.sql.SQLException
setObject
in interface java.sql.CallableStatement
java.sql.SQLException
public void setCharacterStream(java.lang.String param1, java.io.Reader param2, int param3) throws java.sql.SQLException
setCharacterStream
in interface java.sql.CallableStatement
java.sql.SQLException
public void setDate(java.lang.String param1, java.sql.Date param2, java.util.Calendar param3) throws java.sql.SQLException
setDate
in interface java.sql.CallableStatement
java.sql.SQLException
public void setTime(java.lang.String param1, java.sql.Time param2, java.util.Calendar param3) throws java.sql.SQLException
setTime
in interface java.sql.CallableStatement
java.sql.SQLException
public void setTimestamp(java.lang.String param1, java.sql.Timestamp param2, java.util.Calendar param3) throws java.sql.SQLException
setTimestamp
in interface java.sql.CallableStatement
java.sql.SQLException
public void setNull(java.lang.String param1, int param2, java.lang.String param3) throws java.sql.SQLException
setNull
in interface java.sql.CallableStatement
java.sql.SQLException
public void setURL(int parameterIndex, java.net.URL x) throws java.sql.SQLException
setURL
in interface java.sql.PreparedStatement
setURL
in class AbstractPreparedStatement
java.sql.SQLException
public void registerOutParameter(int parameterIndex, int sqlType, java.lang.String typeName) throws java.sql.SQLException
registerOutParameter
in interface java.sql.CallableStatement
java.sql.SQLException
public java.sql.ResultSet getGeneratedKeys() throws java.sql.SQLException
AbstractStatement
Statement
object. If this Statement
object did
not generate any keys, an empty ResultSet
object is returned.
Note:If the columns which represent the auto-generated keys were not specified, the JDBC driver implementation will determine the columns which best represent the auto-generated keys.
getGeneratedKeys
in interface java.sql.Statement
getGeneratedKeys
in class AbstractStatement
ResultSet
object containing the auto-generated key(s)
generated by the execution of this Statement
objectjava.sql.SQLException
- if a database access error occurs or
this method is called on a closed Statement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support this methodpublic java.sql.ResultSet getCurrentResultSet() throws java.sql.SQLException
FirebirdStatement
Statement.getResultSet()
, except that this method
can be called as much as you like.getCurrentResultSet
in interface FirebirdStatement
getCurrentResultSet
in class AbstractStatement
ResultSet
representing current result set
or null
if it is not available.java.sql.SQLException
- if database access error happened.protected java.sql.ResultSet getAndAssertSingletonResultSet() throws java.sql.SQLException
This should fix the problem described in JDBC-350 in most circumstances.
java.sql.SQLException
- For database access errorspublic java.sql.ResultSet getResultSet() throws java.sql.SQLException
ResultSet
object.
This method should be called only once per result.
Calling this method twice with autocommit on and used will probably
throw an inappropriate or uninformative exception.getResultSet
in interface java.sql.Statement
getResultSet
in class AbstractStatement
ResultSet
object;
null
if the result is an update count or there are no more resultsjava.sql.SQLException
- if a database access error occursexecute()
public void setArray(int i, java.sql.Array x) throws java.sql.SQLException
AbstractPreparedStatement
Array
object.
Sets an Array parameter.setArray
in interface java.sql.PreparedStatement
setArray
in class AbstractPreparedStatement
i
- the first parameter is 1, the second is 2, ...x
- an Array
object that maps an SQL
ARRAY
valuejava.sql.SQLException
- if a database access error occurspublic void setBigDecimal(int parameterIndex, java.math.BigDecimal x) throws java.sql.SQLException
AbstractPreparedStatement
setBigDecimal
in interface java.sql.PreparedStatement
setBigDecimal
in class AbstractPreparedStatement
parameterIndex
- The first parameter is 1, second is 2, ...x
- The BigDecimal to be set as a parameterjava.sql.SQLException
- if a database access error occurspublic void setBinaryStream(int parameterIndex, java.io.InputStream inputStream, int length) throws java.sql.SQLException
AbstractPreparedStatement
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.PreparedStatement
setBinaryStream
in class AbstractPreparedStatement
parameterIndex
- the first parameter is 1, the second is 2, ...inputStream
- the Java input streamlength
- the number of bytes in the streamjava.sql.SQLException
- if a database access error occurspublic void setBlob(int parameterIndex, java.sql.Blob blob) throws java.sql.SQLException
AbstractPreparedStatement
Blob
object.setBlob
in interface java.sql.PreparedStatement
setBlob
in class AbstractPreparedStatement
parameterIndex
- the first parameter is 1, the second is 2, ...blob
- a Blob
object that maps an SQL
BLOB
valuejava.sql.SQLException
- if a database access error occurspublic void setBoolean(int parameterIndex, boolean x) throws java.sql.SQLException
AbstractPreparedStatement
setBoolean
in interface java.sql.PreparedStatement
setBoolean
in class AbstractPreparedStatement
parameterIndex
- the first parameter is 1, the second is 2, ...x
- The boolean value to be setjava.sql.SQLException
- if a database access occurspublic void setByte(int parameterIndex, byte x) throws java.sql.SQLException
AbstractPreparedStatement
setByte
in interface java.sql.PreparedStatement
setByte
in class AbstractPreparedStatement
parameterIndex
- the first parameter is 1, the second is 2, ...x
- The byte value to be setjava.sql.SQLException
- if a database access occurspublic void setBytes(int parameterIndex, byte[] x) throws java.sql.SQLException
AbstractPreparedStatement
setBytes
in interface java.sql.PreparedStatement
setBytes
in class AbstractPreparedStatement
parameterIndex
- the first parameter is 1, the second is 2, ...x
- The byte array to be setjava.sql.SQLException
- if a database access occurspublic void setCharacterStream(int parameterIndex, java.io.Reader reader, int length) throws java.sql.SQLException
AbstractPreparedStatement
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.PreparedStatement
setCharacterStream
in class AbstractPreparedStatement
parameterIndex
- the first parameter is 1, the second is 2, ...reader
- the java reader which contains the UNICODE datalength
- the number of characters in the streamjava.sql.SQLException
- if a database access error occurspublic void setClob(int parameterIndex, java.sql.Clob x) throws java.sql.SQLException
AbstractPreparedStatement
Clob
object.setClob
in interface java.sql.PreparedStatement
setClob
in class AbstractPreparedStatement
parameterIndex
- the first parameter is 1, the second is 2, ...x
- a Clob
object that maps an SQL
CLOB
valuejava.sql.SQLException
- if a database access error occurspublic void setDate(int parameterIndex, java.sql.Date x, java.util.Calendar cal) throws java.sql.SQLException
AbstractPreparedStatement
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 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.PreparedStatement
setDate
in class AbstractPreparedStatement
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valuecal
- the Calendar
object the driver will use to
construct the datejava.sql.SQLException
- if a database access error occurspublic void setDate(int parameterIndex, java.sql.Date x) throws java.sql.SQLException
AbstractPreparedStatement
setDate
in interface java.sql.PreparedStatement
setDate
in class AbstractPreparedStatement
parameterIndex
- the first parameter is 1, the second is 2, ...x
- The date value to be setjava.sql.SQLException
- if a database access occurspublic void setDouble(int parameterIndex, double x) throws java.sql.SQLException
AbstractPreparedStatement
setDouble
in interface java.sql.PreparedStatement
setDouble
in class AbstractPreparedStatement
parameterIndex
- the first parameter is 1, the second is 2, ...x
- The double value to be setjava.sql.SQLException
- if a database access occurspublic void setFloat(int parameterIndex, float x) throws java.sql.SQLException
AbstractPreparedStatement
setFloat
in interface java.sql.PreparedStatement
setFloat
in class AbstractPreparedStatement
parameterIndex
- the first parameter is 1, the second is 2, ...x
- The float value to be setjava.sql.SQLException
- if a database access occurspublic void setInt(int parameterIndex, int x) throws java.sql.SQLException
AbstractPreparedStatement
setInt
in interface java.sql.PreparedStatement
setInt
in class AbstractPreparedStatement
parameterIndex
- the first parameter is 1, the second is 2, ...x
- The int value to be setjava.sql.SQLException
- if a database access occurspublic void setLong(int parameterIndex, long x) throws java.sql.SQLException
AbstractPreparedStatement
setLong
in interface java.sql.PreparedStatement
setLong
in class AbstractPreparedStatement
parameterIndex
- the first parameter is 1, the second is 2, ...x
- The long value to be setjava.sql.SQLException
- if a database access occurspublic void setNull(int parameterIndex, int sqlType, java.lang.String typeName) throws java.sql.SQLException
AbstractPreparedStatement
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.PreparedStatement
setNull
in class AbstractPreparedStatement
parameterIndex
- the first parameter is 1, the second is 2, ...sqlType
- a value from java.sql.Types
typeName
- the fully-qualified name of an SQL user-defined type; ignored
if the parameter is not a user-defined type or REFjava.sql.SQLException
- if a database access error occurspublic void setNull(int parameterIndex, int sqlType) throws java.sql.SQLException
AbstractPreparedStatement
NULL
.
Note: You must specify the parameter's SQL type.
setNull
in interface java.sql.PreparedStatement
setNull
in class AbstractPreparedStatement
parameterIndex
- the first parameter is 1, the second is 2, ...sqlType
- the SQL type code defined in java.sql.Types
java.sql.SQLException
- if a database access error occurspublic void setObject(int parameterIndex, java.lang.Object x, int targetSqlType, int scale) throws java.sql.SQLException
AbstractPreparedStatement
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.
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
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, Struct, 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 datatabase- specific abstract data types.
setObject
in interface java.sql.PreparedStatement
setObject
in class AbstractPreparedStatement
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.java.sql.SQLException
- if a database access error occursTypes
public void setObject(int parameterIndex, java.lang.Object x, int targetSqlType) throws java.sql.SQLException
AbstractPreparedStatement
setObject
above, except that it
assumes a scale of zero.setObject
in interface java.sql.PreparedStatement
setObject
in class AbstractPreparedStatement
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
databasejava.sql.SQLException
- if a database access error occurspublic void setObject(int parameterIndex, java.lang.Object x) throws java.sql.SQLException
AbstractPreparedStatement
setObject
in interface java.sql.PreparedStatement
setObject
in class AbstractPreparedStatement
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the object containing the parameter valuejava.sql.SQLException
- if a database access error occurspublic void setRef(int parameterIndex, java.sql.Ref x) throws java.sql.SQLException
AbstractPreparedStatement
REF(<structured-type>)
value.setRef
in interface java.sql.PreparedStatement
setRef
in class AbstractPreparedStatement
parameterIndex
- the first parameter is 1, the second is 2, ...x
- an SQL REF
valuejava.sql.SQLException
- if a database access error occurspublic void setShort(int parameterIndex, short x) throws java.sql.SQLException
AbstractPreparedStatement
setShort
in interface java.sql.PreparedStatement
setShort
in class AbstractPreparedStatement
parameterIndex
- the first parameter is 1, the second is 2, ...x
- The short value to be setjava.sql.SQLException
- if a database access occurspublic void setString(int parameterIndex, java.lang.String x) throws java.sql.SQLException
AbstractPreparedStatement
setString
in interface java.sql.PreparedStatement
setString
in class AbstractPreparedStatement
parameterIndex
- the first parameter is 1, the second is 2, ...x
- The String value to be setjava.sql.SQLException
- if a database access occurspublic void setTime(int parameterIndex, java.sql.Time x, java.util.Calendar cal) throws java.sql.SQLException
AbstractPreparedStatement
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 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.PreparedStatement
setTime
in class AbstractPreparedStatement
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valuecal
- the Calendar
object the driver will use to
construct the timejava.sql.SQLException
- if a database access error occurspublic void setTime(int parameterIndex, java.sql.Time x) throws java.sql.SQLException
AbstractPreparedStatement
setTime
in interface java.sql.PreparedStatement
setTime
in class AbstractPreparedStatement
parameterIndex
- the first parameter is 1, the second is 2, ...x
- The Time value to be setjava.sql.SQLException
- if a database access occurspublic void setTimestamp(int parameterIndex, java.sql.Timestamp x, java.util.Calendar cal) throws java.sql.SQLException
AbstractPreparedStatement
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 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.PreparedStatement
setTimestamp
in class AbstractPreparedStatement
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valuecal
- the Calendar
object the driver will use to
construct the timestampjava.sql.SQLException
- if a database access error occurspublic void setTimestamp(int parameterIndex, java.sql.Timestamp x) throws java.sql.SQLException
AbstractPreparedStatement
setTimestamp
in interface java.sql.PreparedStatement
setTimestamp
in class AbstractPreparedStatement
parameterIndex
- the first parameter is 1, the second is 2, ...x
- The Timestamp value to be setjava.sql.SQLException
- if a database access occurs@Deprecated public void setUnicodeStream(int parameterIndex, java.io.InputStream x, int length) throws java.sql.SQLException
AbstractPreparedStatement
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 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.PreparedStatement
setUnicodeStream
in class AbstractPreparedStatement
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the java input stream which contains the UNICODE parameter
valuelength
- the number of bytes in the streamjava.sql.SQLException
- if a database access error occursprotected int findOutParameter(java.lang.String paramName) throws java.sql.SQLException
paramName
- Name of the OUT parameterjava.sql.SQLException
public final boolean equals(java.lang.Object other)
equals
in class AbstractPreparedStatement
Copyright © 2001-2019 Jaybird (Firebird JDBC/JCA) team. All rights reserved.