Added in API level 1

CallableStatement

interface CallableStatement : PreparedStatement

java.sql.CallableStatement

The interface used to execute SQL stored procedures. The JDBC API provides a stored procedure SQL escape syntax that allows stored procedures to be called in a standard way for all RDBMSs. This escape syntax has one form that includes a result parameter and one that does not. If used, the result parameter must be registered as an OUT parameter. The other parameters can be used for input, output or both. Parameters are referred to sequentially, by number, with the first parameter being 1.

{?= 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 object 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.

Summary

Inherited constants

From class Statement Int CLOSE_ALL_RESULTS The constant indicating that all ResultSet objects that have previously been kept open should be closed when calling getMoreResults. Int CLOSE_CURRENT_RESULT The constant indicating that the current ResultSet object should be closed when calling getMoreResults. Int EXECUTE_FAILED The constant indicating that an error occured while executing a batch statement. Int KEEP_CURRENT_RESULT The constant indicating that the current ResultSet object should not be closed when calling getMoreResults. Int NO_GENERATED_KEYS The constant indicating that generated keys should not be made available for retrieval. Int RETURN_GENERATED_KEYS The constant indicating that generated keys should be made available for retrieval. Int SUCCESS_NO_INFO The constant indicating that a batch statement executed successfully but that no count of the number of rows it affected is available.

Public methods
abstract Array!	getArray(parameterIndex: Int) Retrieves the value of the designated JDBC ARRAY parameter as an java.sql.Array object in the Java programming language.
abstract Array!	getArray(parameterName: String!) Retrieves the value of a JDBC ARRAY parameter as an java.sql.Array object in the Java programming language.
abstract BigDecimal!	getBigDecimal(parameterIndex: Int) Retrieves the value of the designated JDBC NUMERIC parameter as a java.math.BigDecimal object with as many digits to the right of the decimal point as the value contains.
abstract BigDecimal!	getBigDecimal(parameterIndex: Int, scale: Int) Retrieves the value of the designated JDBC NUMERIC parameter as a java.math.BigDecimal object with scale digits to the right of the decimal point.
abstract BigDecimal!	getBigDecimal(parameterName: String!) Retrieves 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.
abstract Blob!	getBlob(parameterIndex: Int) Retrieves the value of the designated JDBC BLOB parameter as a java.sql.Blob object in the Java programming language.
abstract Blob!	getBlob(parameterName: String!) Retrieves the value of a JDBC BLOB parameter as a java.sql.Blob object in the Java programming language.
abstract Boolean	getBoolean(parameterIndex: Int) Retrieves the value of the designated JDBC BIT or BOOLEAN parameter as a boolean in the Java programming language.
abstract Boolean	getBoolean(parameterName: String!) Retrieves the value of a JDBC BIT or BOOLEAN parameter as a boolean in the Java programming language.
abstract Byte	getByte(parameterIndex: Int) Retrieves the value of the designated JDBC TINYINT parameter as a byte in the Java programming language.
abstract Byte	getByte(parameterName: String!) Retrieves the value of a JDBC TINYINT parameter as a byte in the Java programming language.
abstract ByteArray!	getBytes(parameterIndex: Int) Retrieves the value of the designated JDBC BINARY or VARBINARY parameter as an array of byte values in the Java programming language.
abstract ByteArray!	getBytes(parameterName: String!) Retrieves the value of a JDBC BINARY or VARBINARY parameter as an array of byte values in the Java programming language.
abstract Reader!	getCharacterStream(parameterIndex: Int) Retrieves the value of the designated parameter as a java.io.Reader object in the Java programming language.
abstract Reader!	getCharacterStream(parameterName: String!) Retrieves the value of the designated parameter as a java.io.Reader object in the Java programming language.
abstract Clob!	getClob(parameterIndex: Int) Retrieves the value of the designated JDBC CLOB parameter as a java.sql.Clob object in the Java programming language.
abstract Clob!	getClob(parameterName: String!) Retrieves the value of a JDBC CLOB parameter as a java.sql.Clob object in the Java programming language.
abstract Date!	getDate(parameterIndex: Int) Retrieves the value of the designated JDBC DATE parameter as a java.sql.Date object.
abstract Date!	getDate(parameterIndex: Int, cal: Calendar!) Retrieves the value of the designated JDBC DATE parameter as a java.sql.Date object, using the given Calendar object to construct the date.
abstract Date!	getDate(parameterName: String!) Retrieves the value of a JDBC DATE parameter as a java.sql.Date object.
abstract Date!	getDate(parameterName: String!, cal: Calendar!) Retrieves the value of a JDBC DATE parameter as a java.sql.Date object, using the given Calendar object to construct the date.
abstract Double	getDouble(parameterIndex: Int) Retrieves the value of the designated JDBC DOUBLE parameter as a double in the Java programming language.
abstract Double	getDouble(parameterName: String!) Retrieves the value of a JDBC DOUBLE parameter as a double in the Java programming language.
abstract Float	getFloat(parameterIndex: Int) Retrieves the value of the designated JDBC FLOAT parameter as a float in the Java programming language.
abstract Float	getFloat(parameterName: String!) Retrieves the value of a JDBC FLOAT parameter as a float in the Java programming language.
abstract Int	getInt(parameterIndex: Int) Retrieves the value of the designated JDBC INTEGER parameter as an int in the Java programming language.
abstract Int	getInt(parameterName: String!) Retrieves the value of a JDBC INTEGER parameter as an int in the Java programming language.
abstract Long	getLong(parameterIndex: Int) Retrieves the value of the designated JDBC BIGINT parameter as a long in the Java programming language.
abstract Long	getLong(parameterName: String!) Retrieves the value of a JDBC BIGINT parameter as a long in the Java programming language.
abstract Reader!	getNCharacterStream(parameterIndex: Int) Retrieves the value of the designated parameter as a java.io.Reader object in the Java programming language.
abstract Reader!	getNCharacterStream(parameterName: String!) Retrieves the value of the designated parameter as a java.io.Reader object in the Java programming language.
abstract NClob!	getNClob(parameterIndex: Int) Retrieves the value of the designated JDBC NCLOB parameter as a java.sql.NClob object in the Java programming language.
abstract NClob!	getNClob(parameterName: String!) Retrieves the value of a JDBC NCLOB parameter as a java.sql.NClob object in the Java programming language.
abstract String!	getNString(parameterIndex: Int) Retrieves the value of the designated NCHAR, NVARCHAR or LONGNVARCHAR parameter as a String in the Java programming language.
abstract String!	getNString(parameterName: String!) Retrieves the value of the designated NCHAR, NVARCHAR or LONGNVARCHAR parameter as a String in the Java programming language.
abstract Any!	getObject(parameterIndex: Int) Retrieves the value of the designated parameter as an Object in the Java programming language.
abstract Any!	getObject(parameterIndex: Int, map: MutableMap<String!, Class<*>!>!) Returns an object representing the value of OUT parameter parameterIndex and uses map for the custom mapping of the parameter value.
abstract Any!	getObject(parameterName: String!) Retrieves the value of a parameter as an Object in the Java programming language.
abstract Any!	getObject(parameterName: String!, map: MutableMap<String!, Class<*>!>!) Returns an object representing the value of OUT parameter parameterName and uses map for the custom mapping of the parameter value.
abstract Ref!	getRef(parameterIndex: Int) Retrieves the value of the designated JDBC REF(<structured-type>) parameter as a java.sql.Ref object in the Java programming language.
abstract Ref!	getRef(parameterName: String!) Retrieves the value of a JDBC REF(<structured-type>) parameter as a java.sql.Ref object in the Java programming language.
abstract RowId!	getRowId(parameterIndex: Int) Retrieves the value of the designated JDBC ROWID parameter as a java.sql.RowId object.
abstract RowId!	getRowId(parameterName: String!) Retrieves the value of the designated JDBC ROWID parameter as a java.sql.RowId object.
abstract SQLXML!	getSQLXML(parameterIndex: Int) Retrieves the value of the designated SQL XML parameter as a java.sql.SQLXML object in the Java programming language.
abstract SQLXML!	getSQLXML(parameterName: String!) Retrieves the value of the designated SQL XML parameter as a java.sql.SQLXML object in the Java programming language.
abstract Short	getShort(parameterIndex: Int) Retrieves the value of the designated JDBC SMALLINT parameter as a short in the Java programming language.
abstract Short	getShort(parameterName: String!) Retrieves the value of a JDBC SMALLINT parameter as a short in the Java programming language.
abstract String!	getString(parameterIndex: Int) Retrieves the value of the designated JDBC CHAR, VARCHAR, or LONGVARCHAR parameter as a String in the Java programming language.
abstract String!	getString(parameterName: String!) Retrieves the value of a JDBC CHAR, VARCHAR, or LONGVARCHAR parameter as a String in the Java programming language.
abstract Time!	getTime(parameterIndex: Int) Retrieves the value of the designated JDBC TIME parameter as a java.sql.Time object.
abstract Time!	getTime(parameterIndex: Int, cal: Calendar!) Retrieves the value of the designated JDBC TIME parameter as a java.sql.Time object, using the given Calendar object to construct the time.
abstract Time!	getTime(parameterName: String!) Retrieves the value of a JDBC TIME parameter as a java.sql.Time object.
abstract Time!	getTime(parameterName: String!, cal: Calendar!) Retrieves the value of a JDBC TIME parameter as a java.sql.Time object, using the given Calendar object to construct the time.
abstract Timestamp!	getTimestamp(parameterIndex: Int) Retrieves the value of the designated JDBC TIMESTAMP parameter as a java.sql.Timestamp object.
abstract Timestamp!	getTimestamp(parameterIndex: Int, cal: Calendar!) Retrieves the value of the designated JDBC TIMESTAMP parameter as a java.sql.Timestamp object, using the given Calendar object to construct the Timestamp object.
abstract Timestamp!	getTimestamp(parameterName: String!) Retrieves the value of a JDBC TIMESTAMP parameter as a java.sql.Timestamp object.
abstract Timestamp!	getTimestamp(parameterName: String!, cal: Calendar!) Retrieves the value of a JDBC TIMESTAMP parameter as a java.sql.Timestamp object, using the given Calendar object to construct the Timestamp object.
abstract URL!	getURL(parameterIndex: Int) Retrieves the value of the designated JDBC DATALINK parameter as a java.net.URL object.
abstract URL!	getURL(parameterName: String!) Retrieves the value of a JDBC DATALINK parameter as a java.net.URL object.
abstract Unit	registerOutParameter(parameterIndex: Int, sqlType: Int) Registers the OUT parameter in ordinal position parameterIndex to the JDBC type sqlType.
abstract Unit	registerOutParameter(parameterIndex: Int, sqlType: Int, scale: Int) Registers the parameter in ordinal position parameterIndex to be of JDBC type sqlType.
abstract Unit	registerOutParameter(parameterIndex: Int, sqlType: Int, typeName: String!) Registers the designated output parameter.
abstract Unit	registerOutParameter(parameterName: String!, sqlType: Int) Registers the OUT parameter named parameterName to the JDBC type sqlType.
abstract Unit	registerOutParameter(parameterName: String!, sqlType: Int, scale: Int) Registers the parameter named parameterName to be of JDBC type sqlType.
abstract Unit	registerOutParameter(parameterName: String!, sqlType: Int, typeName: String!) Registers the designated output parameter.
abstract Unit	setAsciiStream(parameterName: String!, x: InputStream!) Sets the designated parameter to the given input stream.
abstract Unit	setAsciiStream(parameterName: String!, x: InputStream!, length: Int) Sets the designated parameter to the given input stream, which will have the specified number of bytes.
abstract Unit	setAsciiStream(parameterName: String!, x: InputStream!, length: Long) Sets the designated parameter to the given input stream, which will have the specified number of bytes.
abstract Unit	setBigDecimal(parameterName: String!, x: BigDecimal!) Sets the designated parameter to the given java.math.BigDecimal value.
abstract Unit	setBinaryStream(parameterName: String!, x: InputStream!) Sets the designated parameter to the given input stream.
abstract Unit	setBinaryStream(parameterName: String!, x: InputStream!, length: Int) Sets the designated parameter to the given input stream, which will have the specified number of bytes.
abstract Unit	setBinaryStream(parameterName: String!, x: InputStream!, length: Long) Sets the designated parameter to the given input stream, which will have the specified number of bytes.
abstract Unit	setBlob(parameterName: String!, inputStream: InputStream!) Sets the designated parameter to a InputStream object.
abstract Unit	setBlob(parameterName: String!, inputStream: InputStream!, length: Long) Sets the designated parameter to a InputStream object.
abstract Unit	setBlob(parameterName: String!, x: Blob!) Sets the designated parameter to the given java.sql.Blob object.
abstract Unit	setBoolean(parameterName: String!, x: Boolean) Sets the designated parameter to the given Java boolean value.
abstract Unit	setByte(parameterName: String!, x: Byte) Sets the designated parameter to the given Java byte value.
abstract Unit	setBytes(parameterName: String!, x: ByteArray!) Sets the designated parameter to the given Java array of bytes.
abstract Unit	setCharacterStream(parameterName: String!, reader: Reader!) Sets the designated parameter to the given Reader object.
abstract Unit	setCharacterStream(parameterName: String!, reader: Reader!, length: Int) Sets the designated parameter to the given Reader object, which is the given number of characters long.
abstract Unit	setCharacterStream(parameterName: String!, reader: Reader!, length: Long) Sets the designated parameter to the given Reader object, which is the given number of characters long.
abstract Unit	setClob(parameterName: String!, reader: Reader!) Sets the designated parameter to a Reader object.
abstract Unit	setClob(parameterName: String!, reader: Reader!, length: Long) Sets the designated parameter to a Reader object.
abstract Unit	setClob(parameterName: String!, x: Clob!) Sets the designated parameter to the given java.sql.Clob object.
abstract Unit	setDate(parameterName: String!, x: Date!) Sets the designated parameter to the given java.sql.Date value using the default time zone of the virtual machine that is running the application.
abstract Unit	setDate(parameterName: String!, x: Date!, cal: Calendar!) Sets the designated parameter to the given java.sql.Date value, using the given Calendar object.
abstract Unit	setDouble(parameterName: String!, x: Double) Sets the designated parameter to the given Java double value.
abstract Unit	setFloat(parameterName: String!, x: Float) Sets the designated parameter to the given Java float value.
abstract Unit	setInt(parameterName: String!, x: Int) Sets the designated parameter to the given Java int value.
abstract Unit	setLong(parameterName: String!, x: Long) Sets the designated parameter to the given Java long value.
abstract Unit	setNCharacterStream(parameterName: String!, value: Reader!) Sets the designated parameter to a Reader object.
abstract Unit	setNCharacterStream(parameterName: String!, value: Reader!, length: Long) Sets the designated parameter to a Reader object.
abstract Unit	setNClob(parameterName: String!, reader: Reader!) Sets the designated parameter to a Reader object.
abstract Unit	setNClob(parameterName: String!, reader: Reader!, length: Long) Sets the designated parameter to a Reader object.
abstract Unit	setNClob(parameterName: String!, value: NClob!) Sets the designated parameter to a java.sql.NClob object.
abstract Unit	setNString(parameterName: String!, value: String!) Sets the designated parameter to the given String object.
abstract Unit	setNull(parameterName: String!, sqlType: Int) Sets the designated parameter to SQL NULL.
abstract Unit	setNull(parameterName: String!, sqlType: Int, typeName: String!) Sets the designated parameter to SQL NULL.
abstract Unit	setObject(parameterName: String!, x: Any!) Sets the value of the designated parameter with the given object.
abstract Unit	setObject(parameterName: String!, x: Any!, targetSqlType: Int) Sets the value of the designated parameter with the given object.
abstract Unit	setObject(parameterName: String!, x: Any!, targetSqlType: Int, scale: Int) Sets the value of the designated parameter with the given object.
abstract Unit	setRowId(parameterName: String!, x: RowId!) Sets the designated parameter to the given java.sql.RowId object.
abstract Unit	setSQLXML(parameterName: String!, xmlObject: SQLXML!) Sets the designated parameter to the given java.sql.SQLXML object.
abstract Unit	setShort(parameterName: String!, x: Short) Sets the designated parameter to the given Java short value.
abstract Unit	setString(parameterName: String!, x: String!) Sets the designated parameter to the given Java String value.
abstract Unit	setTime(parameterName: String!, x: Time!) Sets the designated parameter to the given java.sql.Time value.
abstract Unit	setTime(parameterName: String!, x: Time!, cal: Calendar!) Sets the designated parameter to the given java.sql.Time value, using the given Calendar object.
abstract Unit	setTimestamp(parameterName: String!, x: Timestamp!) Sets the designated parameter to the given java.sql.Timestamp value.
abstract Unit	setTimestamp(parameterName: String!, x: Timestamp!, cal: Calendar!) Sets the designated parameter to the given java.sql.Timestamp value, using the given Calendar object.
abstract Unit	setURL(parameterName: String!, val: URL!) Sets the designated parameter to the given java.net.URL object.
abstract Boolean	wasNull() Retrieves whether the last OUT parameter read had the value of SQL NULL.

Inherited functions
From class PreparedStatement Unit addBatch() Adds a set of parameters to this PreparedStatement object's batch of commands. Unit clearParameters() Clears the current parameter values immediately. In general, parameter values remain in force for repeated use of a statement. Setting a parameter value automatically clears its previous value. However, in some cases it is useful to immediately release the resources used by the current parameter values; this can be done by calling the method clearParameters. Boolean execute() Executes the SQL statement in this PreparedStatement object, which may be any kind of SQL statement. Some prepared statements return multiple results; the execute method handles these complex statements as well as the simpler form of statements handled by the methods executeQuery and executeUpdate. The execute method returns a boolean to indicate the form of the first result. You must call either the method getResultSet or getUpdateCount to retrieve the result; you must call getMoreResults to move to any subsequent result(s). ResultSet! executeQuery() Executes the SQL query in this PreparedStatement object and returns the ResultSet object generated by the query. Int executeUpdate() Executes the SQL statement in this PreparedStatement object, which must be an SQL Data Manipulation Language (DML) statement, such as INSERT, UPDATE or DELETE; or an SQL statement that returns nothing, such as a DDL statement. ResultSetMetaData! getMetaData() Retrieves a ResultSetMetaData object that contains information about the columns of the ResultSet object that will be returned when this PreparedStatement object is executed. Because a PreparedStatement object is precompiled, it is possible to know about the ResultSet object that it will return without having to execute it. Consequently, it is possible to invoke the method getMetaData on a PreparedStatement object rather than waiting to execute it and then invoking the ResultSet.getMetaData method on the ResultSet object that is returned. NOTE: Using this method may be expensive for some drivers due to the lack of underlying DBMS support. ParameterMetaData! getParameterMetaData() Retrieves the number, types and properties of this PreparedStatement object's parameters. Unit setArray(parameterIndex: Int, x: Array!) Sets the designated parameter to the given java.sql.Array object. The driver converts this to an SQL ARRAY value when it sends it to the database. Unit setAsciiStream(parameterIndex: Int, x: InputStream!) Sets the designated parameter to the given input stream. When a very large ASCII value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.InputStream. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format. Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface. Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setAsciiStream which takes a length parameter. Unit setAsciiStream(parameterIndex: Int, x: InputStream!, length: Int) Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large ASCII value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.InputStream. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format. Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface. Unit setAsciiStream(parameterIndex: Int, x: InputStream!, length: Long) Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large ASCII value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.InputStream. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format. Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface. Unit setBigDecimal(parameterIndex: Int, x: BigDecimal!) Sets the designated parameter to the given java.math.BigDecimal value. The driver converts this to an SQL NUMERIC value when it sends it to the database. Unit setBinaryStream(parameterIndex: Int, x: InputStream!) Sets the designated parameter to the given input stream. When a very large binary value is input to a LONGVARBINARY parameter, it may be more practical to send it via a java.io.InputStream object. The data will be read from the stream as needed until end-of-file is reached. Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface. Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setBinaryStream which takes a length parameter. Unit setBinaryStream(parameterIndex: Int, x: InputStream!, length: Int) Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large binary value is input to a LONGVARBINARY parameter, it may be more practical to send it via a java.io.InputStream object. The data will be read from the stream as needed until end-of-file is reached. Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface. Unit setBinaryStream(parameterIndex: Int, x: InputStream!, length: Long) Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large binary value is input to a LONGVARBINARY parameter, it may be more practical to send it via a java.io.InputStream object. The data will be read from the stream as needed until end-of-file is reached. Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface. Unit setBlob(parameterIndex: Int, inputStream: InputStream!) Sets the designated parameter to a InputStream object. This method differs from the setBinaryStream (int, InputStream) method because it informs the driver that the parameter value should be sent to the server as a BLOB. When the setBinaryStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGVARBINARY or a BLOB Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setBlob which takes a length parameter. Unit setBlob(parameterIndex: Int, inputStream: InputStream!, length: Long) Sets the designated parameter to a InputStream object. The inputstream must contain the number of characters specified by length otherwise a SQLException will be generated when the PreparedStatement is executed. This method differs from the setBinaryStream (int, InputStream, int) method because it informs the driver that the parameter value should be sent to the server as a BLOB. When the setBinaryStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGVARBINARY or a BLOB Unit setBlob(parameterIndex: Int, x: Blob!) Sets the designated parameter to the given java.sql.Blob object. The driver converts this to an SQL BLOB value when it sends it to the database. Unit setBoolean(parameterIndex: Int, x: Boolean) Sets the designated parameter to the given Java boolean value. The driver converts this to an SQL BIT or BOOLEAN value when it sends it to the database. Unit setByte(parameterIndex: Int, x: Byte) Sets the designated parameter to the given Java byte value. The driver converts this to an SQL TINYINT value when it sends it to the database. Unit setBytes(parameterIndex: Int, x: ByteArray!) Sets the designated parameter to the given Java array of bytes. The driver converts this to an SQL VARBINARY or LONGVARBINARY (depending on the argument's size relative to the driver's limits on VARBINARY values) when it sends it to the database. Unit setCharacterStream(parameterIndex: Int, reader: Reader!) Sets the designated parameter to the given Reader object. When a very large UNICODE value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.Reader object. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format. Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface. Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setCharacterStream which takes a length parameter. Unit setCharacterStream(parameterIndex: Int, reader: Reader!, length: Int) Sets the designated parameter to the given 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. Unit setCharacterStream(parameterIndex: Int, reader: Reader!, length: Long) Sets the designated parameter to the given 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. Unit setClob(parameterIndex: Int, reader: Reader!) Sets the designated parameter to a Reader object. This method differs from the setCharacterStream (int, Reader) method because it informs the driver that the parameter value should be sent to the server as a CLOB. When the setCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGVARCHAR or a CLOB Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setClob which takes a length parameter. Unit setClob(parameterIndex: Int, reader: Reader!, length: Long) Sets the designated parameter to a Reader object. The reader must contain the number of characters specified by length otherwise a SQLException will be generated when the PreparedStatement is executed. This method differs from the setCharacterStream (int, Reader, int) method because it informs the driver that the parameter value should be sent to the server as a CLOB. When the setCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGVARCHAR or a CLOB Unit setClob(parameterIndex: Int, x: Clob!) Sets the designated parameter to the given java.sql.Clob object. The driver converts this to an SQL CLOB value when it sends it to the database. Unit setDate(parameterIndex: Int, x: Date!) Sets the designated parameter to the given java.sql.Date value using the default time zone of the virtual machine that is running the application. The driver converts this to an SQL DATE value when it sends it to the database. Unit setDate(parameterIndex: Int, x: Date!, cal: Calendar!) Sets the designated parameter to the given java.sql.Date value, using the given Calendar object. The driver uses the Calendar object to construct an SQL DATE value, which the driver then sends to the database. With a Calendar object, the driver can calculate the date taking into account a custom timezone. If no Calendar object is specified, the driver uses the default timezone, which is that of the virtual machine running the application. Unit setDouble(parameterIndex: Int, x: Double) Sets the designated parameter to the given Java double value. The driver converts this to an SQL DOUBLE value when it sends it to the database. Unit setFloat(parameterIndex: Int, x: Float) Sets the designated parameter to the given Java float value. The driver converts this to an SQL REAL value when it sends it to the database. Unit setInt(parameterIndex: Int, x: Int) Sets the designated parameter to the given Java int value. The driver converts this to an SQL INTEGER value when it sends it to the database. Unit setLong(parameterIndex: Int, x: Long) Sets the designated parameter to the given Java long value. The driver converts this to an SQL BIGINT value when it sends it to the database. Unit setNCharacterStream(parameterIndex: Int, value: Reader!) Sets the designated parameter to a Reader object. The Reader reads the data till end-of-file is reached. The driver does the necessary conversion from Java character format to the national character set in the database. Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface. Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setNCharacterStream which takes a length parameter. Unit setNCharacterStream(parameterIndex: Int, value: Reader!, length: Long) Sets the designated parameter to a Reader object. The Reader reads the data till end-of-file is reached. The driver does the necessary conversion from Java character format to the national character set in the database. Unit setNClob(parameterIndex: Int, reader: Reader!) Sets the designated parameter to a Reader object. This method differs from the setCharacterStream (int, Reader) method because it informs the driver that the parameter value should be sent to the server as a NCLOB. When the setCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGNVARCHAR or a NCLOB Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setNClob which takes a length parameter. Unit setNClob(parameterIndex: Int, reader: Reader!, length: Long) Sets the designated parameter to a Reader object. The reader must contain the number of characters specified by length otherwise a SQLException will be generated when the PreparedStatement is executed. This method differs from the setCharacterStream (int, Reader, int) method because it informs the driver that the parameter value should be sent to the server as a NCLOB. When the setCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGNVARCHAR or a NCLOB Unit setNClob(parameterIndex: Int, value: NClob!) Sets the designated parameter to a java.sql.NClob object. The driver converts this to a SQL NCLOB value when it sends it to the database. Unit setNString(parameterIndex: Int, value: String!) Sets the designated paramter to the given String object. The driver converts this to a SQL NCHAR or NVARCHAR or LONGNVARCHAR value (depending on the argument's size relative to the driver's limits on NVARCHAR values) when it sends it to the database. Unit setNull(parameterIndex: Int, sqlType: Int) Sets the designated parameter to SQL NULL. Note: You must specify the parameter's SQL type. Unit setNull(parameterIndex: Int, sqlType: Int, typeName: String!) Sets the designated parameter to SQL 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. Unit setObject(parameterIndex: Int, x: Any!) Sets the value of the designated parameter using the given object. The second parameter must be of type Object; therefore, the java.lang equivalent objects should be used for built-in types. The JDBC specification specifies a standard mapping from Java Object types to SQL types. The given argument will be converted to the corresponding SQL type before being sent to the database. Note that this method may be used to pass datatabase- specific abstract data types, by using a driver-specific Java type. If the object is of a class implementing the 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, NClob, Struct, java.net.URL, RowId, SQLXML or Array, the driver should pass it to the database as a value of the corresponding SQL type. Note: Not all databases allow for a non-typed Null to be sent to the backend. For maximum portability, the setNull or the setObject(int parameterIndex, Object x, int sqlType) method should be used instead of setObject(int parameterIndex, Object x). Note: This method throws an exception if there is an ambiguity, for example, if the object is of a class implementing more than one of the interfaces named above. Unit setObject(parameterIndex: Int, x: Any!, targetSqlType: Int) Sets the value of the designated parameter with the given object. This method is like the method setObject above, except that it assumes a scale of zero. Unit setObject(parameterIndex: Int, x: Any!, targetSqlType: Int, scaleOrLength: Int) 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. If the second argument is an InputStream then the stream must contain the number of bytes specified by scaleOrLength. If the second argument is a Reader then the reader must contain the number of characters specified by scaleOrLength. If these conditions are not true the driver will generate a SQLException when the prepared statement is executed. The given Java object will be converted to the given targetSqlType before being sent to the database. If the object has a custom mapping (is of a class implementing the 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, NClob, Struct, java.net.URL, or Array, the driver should pass it to the database as a value of the corresponding SQL type. Note that this method may be used to pass database-specific abstract data types. Unit setRef(parameterIndex: Int, x: Ref!) Sets the designated parameter to the given REF(<structured-type>) value. The driver converts this to an SQL REF value when it sends it to the database. Unit setRowId(parameterIndex: Int, x: RowId!) Sets the designated parameter to the given java.sql.RowId object. The driver converts this to a SQL ROWID value when it sends it to the database Unit setSQLXML(parameterIndex: Int, xmlObject: SQLXML!) Sets the designated parameter to the given java.sql.SQLXML object. The driver converts this to an SQL XML value when it sends it to the database. Unit setShort(parameterIndex: Int, x: Short) Sets the designated parameter to the given Java short value. The driver converts this to an SQL SMALLINT value when it sends it to the database. Unit setString(parameterIndex: Int, x: String!) Sets the designated parameter to the given Java String value. The driver converts this to an SQL VARCHAR or LONGVARCHAR value (depending on the argument's size relative to the driver's limits on VARCHAR values) when it sends it to the database. Unit setTime(parameterIndex: Int, x: Time!) Sets the designated parameter to the given java.sql.Time value. The driver converts this to an SQL TIME value when it sends it to the database. Unit setTime(parameterIndex: Int, x: Time!, cal: Calendar!) Sets the designated parameter to the given java.sql.Time value, using the given Calendar object. The driver uses the Calendar object to construct an SQL TIME value, which the driver then sends to the database. With a Calendar object, the driver can calculate the time taking into account a custom timezone. If no Calendar object is specified, the driver uses the default timezone, which is that of the virtual machine running the application. Unit setTimestamp(parameterIndex: Int, x: Timestamp!) Sets the designated parameter to the given java.sql.Timestamp value. The driver converts this to an SQL TIMESTAMP value when it sends it to the database. Unit setTimestamp(parameterIndex: Int, x: Timestamp!, cal: Calendar!) Sets the designated parameter to the given java.sql.Timestamp value, using the given Calendar object. The driver uses the Calendar object to construct an SQL TIMESTAMP value, which the driver then sends to the database. With a Calendar object, the driver can calculate the timestamp taking into account a custom timezone. If no Calendar object is specified, the driver uses the default timezone, which is that of the virtual machine running the application. Unit setURL(parameterIndex: Int, x: URL!) Sets the designated parameter to the given java.net.URL value. The driver converts this to an SQL DATALINK value when it sends it to the database. Unit setUnicodeStream(parameterIndex: Int, x: InputStream!, length: Int) Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large Unicode value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.InputStream object. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from Unicode to the database char format. The byte format of the Unicode stream must be a Java UTF-8, as defined in the Java Virtual Machine Specification. Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
From class Statement Unit addBatch(sql: String!) Adds the given SQL command to the current list of commmands for this Statement object. The commands in this list can be executed as a batch by calling the method executeBatch. Note:This method cannot be called on a PreparedStatement or CallableStatement. Unit cancel() Cancels this Statement object 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. Unit clearBatch() Empties this Statement object's current list of SQL commands. Unit clearWarnings() Clears all the warnings reported on this Statement object. After a call to this method, the method getWarnings will return null until a new warning is reported for this Statement object. Unit close() Releases this Statement object'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 close on a Statement object that is already closed has no effect. Note:When a Statement object is closed, its current ResultSet object, if one exists, is also closed. Boolean execute(sql: String!) 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 execute method executes an SQL statement and indicates the form of the first result. You must then use the methods getResultSet or getUpdateCount to retrieve the result, and getMoreResults to move to any subsequent result(s). Note:This method cannot be called on a PreparedStatement or CallableStatement. Boolean execute(sql: String!, autoGeneratedKeys: Int) 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 an INSERT statement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific). 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 execute method executes an SQL statement and indicates the form of the first result. You must then use the methods getResultSet or getUpdateCount to retrieve the result, and getMoreResults to move to any subsequent result(s). Note:This method cannot be called on a PreparedStatement or CallableStatement. Boolean execute(sql: String!, columnIndexes: IntArray!) 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 SQL statement is not an INSERT statement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific). 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 execute method executes an SQL statement and indicates the form of the first result. You must then use the methods getResultSet or getUpdateCount to retrieve the result, and getMoreResults to move to any subsequent result(s). Note:This method cannot be called on a PreparedStatement or CallableStatement. Boolean execute(sql: String!, columnNames: Array<String!>!) 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 SQL statement is not an INSERT statement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific). 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 execute method executes an SQL statement and indicates the form of the first result. You must then use the methods getResultSet or getUpdateCount to retrieve the result, and getMoreResults to move to any subsequent result(s). Note:This method cannot be called on a PreparedStatement or CallableStatement. IntArray! executeBatch() Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts. The 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: 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 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: 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 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. ResultSet! executeQuery(sql: String!) Executes the given SQL statement, which returns a single ResultSet object. Note:This method cannot be called on a PreparedStatement or CallableStatement. Int executeUpdate(sql: String!) Executes the given SQL statement, which may be an INSERT, UPDATE, or DELETE statement or an SQL statement that returns nothing, such as an SQL DDL statement. Note:This method cannot be called on a PreparedStatement or CallableStatement. Int executeUpdate(sql: String!, autoGeneratedKeys: Int) Executes the given SQL statement and signals the driver with the given flag about whether the auto-generated keys produced by this Statement object should be made available for retrieval. The driver will ignore the flag if the SQL statement is not an INSERT statement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific). Note:This method cannot be called on a PreparedStatement or CallableStatement. Int executeUpdate(sql: String!, columnIndexes: IntArray!) 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. 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 SQL statement is not an INSERT statement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific). Note:This method cannot be called on a PreparedStatement or CallableStatement. Int executeUpdate(sql: String!, columnNames: Array<String!>!) 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. 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 SQL statement is not an INSERT statement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific). Note:This method cannot be called on a PreparedStatement or CallableStatement. Connection! getConnection() Retrieves the Connection object that produced this Statement object. Int getFetchDirection() Retrieves the direction for fetching rows from database tables that is the default for result sets generated from this Statement object. If this Statement object has not set a fetch direction by calling the method setFetchDirection, the return value is implementation-specific. Int getFetchSize() Retrieves the number of result set rows that is the default fetch size for ResultSet objects generated from this Statement object. If this Statement object has not set a fetch size by calling the method setFetchSize, the return value is implementation-specific. ResultSet! getGeneratedKeys() Retrieves any auto-generated keys created as a result of executing this 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. Int getMaxFieldSize() Retrieves the maximum number of bytes that can be returned for character and binary column values in a ResultSet object produced by this Statement object. This limit applies only to BINARY, VARBINARY, LONGVARBINARY, CHAR, VARCHAR, NCHAR, NVARCHAR, LONGNVARCHAR and LONGVARCHAR columns. If the limit is exceeded, the excess data is silently discarded. Int getMaxRows() Retrieves the maximum number of rows that a ResultSet object produced by this Statement object can contain. If this limit is exceeded, the excess rows are silently dropped. Boolean getMoreResults() Moves to this Statement object's next result, returns true if it is a ResultSet object, and implicitly closes any current ResultSet object(s) obtained with the method getResultSet. There are no more results when the following is true: // stmt is a Statement object ((stmt.getMoreResults() == false) && (stmt.getUpdateCount() == -1)) Boolean getMoreResults(current: Int) Moves to this Statement object's next result, deals with any current ResultSet object(s) according to the instructions specified by the given flag, and returns true if the next result is a ResultSet object. There are no more results when the following is true: // stmt is a Statement object ((stmt.getMoreResults(current) == false) && (stmt.getUpdateCount() == -1)) Int getQueryTimeout() Retrieves the number of seconds the driver will wait for a Statement object to execute. If the limit is exceeded, a SQLException is thrown. ResultSet! getResultSet() Retrieves the current result as a ResultSet object. This method should be called only once per result. Int getResultSetConcurrency() Retrieves the result set concurrency for ResultSet objects generated by this Statement object. Int getResultSetHoldability() Retrieves the result set holdability for ResultSet objects generated by this Statement object. Int getResultSetType() Retrieves the result set type for ResultSet objects generated by this Statement object. Int getUpdateCount() Retrieves the current result as an update count; if the result is a ResultSet object or there are no more results, -1 is returned. This method should be called only once per result. SQLWarning! getWarnings() Retrieves the first warning reported by calls on this Statement object. Subsequent Statement object warnings will be chained to this SQLWarning object. The warning chain is automatically cleared each time a statement is (re)executed. This method may not be called on a closed Statement object; doing so will cause an SQLException to be thrown. Note: If you are processing a ResultSet object, any warnings associated with reads on that ResultSet object will be chained on it rather than on the Statement object that produced it. Boolean isClosed() Retrieves whether this Statement object has been closed. A Statement is closed if the method close has been called on it, or if it is automatically closed. Boolean isPoolable() Returns a value indicating whether the Statement is poolable or not. Unit setCursorName(name: String!) Sets the SQL cursor name to the given String, which will be used by subsequent Statement object execute methods. This name can then be used in SQL positioned update or delete statements to identify the current row in the ResultSet object 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's SELECT statement should have the form SELECT FOR UPDATE. If FOR UPDATE is not present, positioned updates may fail. Note: By definition, the execution of positioned updates and deletes must be done by a different Statement object than the one that generated the ResultSet object being used for positioning. Also, cursor names must be unique within a connection. Unit setEscapeProcessing(enable: Boolean) Sets 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 for PreparedStatements objects will have no effect. Unit setFetchDirection(direction: Int) Gives the driver a hint as to the direction in which rows will be processed in ResultSet objects created using this Statement object. The default value is ResultSet.FETCH_FORWARD. Note that this method sets the default fetch direction for result sets generated by this Statement object. Each result set has its own methods for getting and setting its own fetch direction. Unit setFetchSize(rows: Int) Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed for ResultSet objects genrated by this Statement. If the value specified is zero, then the hint is ignored. The default value is zero. Unit setMaxFieldSize(max: Int) Sets the limit for the maximum number of bytes that can be returned for character and binary column values in a ResultSet object produced by this Statement object. This limit applies only to BINARY, VARBINARY, LONGVARBINARY, CHAR, VARCHAR, NCHAR, NVARCHAR, LONGNVARCHAR and LONGVARCHAR fields. If the limit is exceeded, the excess data is silently discarded. For maximum portability, use values greater than 256. Unit setMaxRows(max: Int) Sets the limit for the maximum number of rows that any ResultSet object generated by this Statement object can contain to the given number. If the limit is exceeded, the excess rows are silently dropped. Unit setPoolable(poolable: Boolean) Requests that a Statement be pooled or not pooled. The value specified is a hint to the statement pool implementation indicating whether the applicaiton wants the statement to be pooled. It is up to the statement pool manager as to whether the hint is used. The poolable value of a statement is applicable to both internal statement caches implemented by the driver and external statement caches implemented by application servers and other applications. By default, a Statement is not poolable when created, and a PreparedStatement and CallableStatement are poolable when created. Unit setQueryTimeout(seconds: Int) Sets the number of seconds the driver will wait for a Statement object to execute to the given number of seconds. By default there is no limit on the amount of time allowed for a running statement to complete. If the limit is exceeded, an SQLTimeoutException is thrown. A JDBC driver must apply this limit to the execute, executeQuery and executeUpdate methods. Note: JDBC driver implementations may also apply this limit to ResultSet methods (consult your driver vendor documentation for details). Note: In the case of Statement batching, it is implementation defined as to whether the time-out is applied to individual SQL commands added via the addBatch method or to the entire batch of SQL commands invoked by the executeBatch method (consult your driver vendor documentation for details).
From class Wrapper Boolean isWrapperFor(iface: Class<*>!) Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does. Returns false otherwise. If this implements the interface then return true, else if this is a wrapper then return the result of recursively calling isWrapperFor on the wrapped object. If this does not implement the interface and is not a wrapper, return false. This method should be implemented as a low-cost operation compared to unwrap so that callers can use this method to avoid expensive unwrap calls that may fail. If this method returns true then calling unwrap with the same argument should succeed. T unwrap(iface: Class<T>!) Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy. If the receiver implements the interface then the result is the receiver or a proxy for the receiver. If the receiver is a wrapper and the wrapped object implements the interface then the result is the wrapped object or a proxy for the wrapped object. Otherwise return the the result of calling unwrap recursively on the wrapped object or a proxy for that result. If the receiver is not a wrapper and does not implement the interface, then an SQLException is thrown.

Public methods

getArray

Added in API level 1

abstract fun getArray(parameterIndex: Int): Array!

Retrieves the value of the designated JDBC ARRAY parameter as an java.sql.Array object in the Java programming language.

Parameters
parameterIndex	Int: the first parameter is 1, the second is 2, and so on

Return
Array!	the parameter value as an Array object in the Java programming language. If the value was SQL NULL, the value null is returned.

Exceptions
java.sql.SQLException	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

getArray

Added in API level 1

abstract fun getArray(parameterName: String!): Array!

Retrieves the value of a JDBC ARRAY parameter as an java.sql.Array object in the Java programming language.

Parameters
parameterName	String!: the name of the parameter

Return
Array!	the parameter value as an Array object in Java programming language. If the value was SQL NULL, the value null is returned.

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

getBigDecimal

Added in API level 1

abstract fun getBigDecimal(parameterIndex: Int): BigDecimal!

Retrieves the value of the designated JDBC NUMERIC parameter as a java.math.BigDecimal object with as many digits to the right of the decimal point as the value contains.

Parameters
parameterIndex	Int: the first parameter is 1, the second is 2, and so on

Return
BigDecimal!	the parameter value in full precision. If the value is SQL NULL, the result is null.

Exceptions
java.sql.SQLException	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement

See Also

getBigDecimal

Added in API level 1
Deprecated in API level 15

abstract fun getBigDecimal(
    parameterIndex: Int, 
    scale: Int
): BigDecimal!

Deprecated: use getBigDecimal(int parameterIndex) or getBigDecimal(String parameterName)

Retrieves the value of the designated JDBC NUMERIC parameter as a java.math.BigDecimal object with scale digits to the right of the decimal point.

Parameters
parameterIndex	Int: the first parameter is 1, the second is 2, and so on
scale	Int: the number of digits to the right of the decimal point

Return
BigDecimal!	the parameter value. If the value is SQL NULL, the result is null.

Exceptions
java.sql.SQLException	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

getBigDecimal

Added in API level 1

abstract fun getBigDecimal(parameterName: String!): BigDecimal!

Retrieves 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.

Parameters
parameterName	String!: the name of the parameter

Return
BigDecimal!	the parameter value in full precision. If the value is SQL NULL, the result is null.

Exceptions
SQLExceptionif	parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

getBlob

Added in API level 1

abstract fun getBlob(parameterIndex: Int): Blob!

Retrieves the value of the designated JDBC BLOB parameter as a java.sql.Blob object in the Java programming language.

Parameters
parameterIndex	Int: the first parameter is 1, the second is 2, and so on

Return
Blob!	the parameter value as a Blob object in the Java programming language. If the value was SQL NULL, the value null is returned.

Exceptions
java.sql.SQLException	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

getBlob

Added in API level 1

abstract fun getBlob(parameterName: String!): Blob!

Retrieves the value of a JDBC BLOB parameter as a java.sql.Blob object in the Java programming language.

Parameters
parameterName	String!: the name of the parameter

Return
Blob!	the parameter value as a Blob object in the Java programming language. If the value was SQL NULL, the value null is returned.

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

getBoolean

Added in API level 1

abstract fun getBoolean(parameterIndex: Int): Boolean

Retrieves the value of the designated JDBC BIT or BOOLEAN parameter as a boolean in the Java programming language.

Parameters
parameterIndex	Int: the first parameter is 1, the second is 2, and so on

Return
Boolean	the parameter value. If the value is SQL NULL, the result is false.

Exceptions
java.sql.SQLException	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement

See Also

getBoolean

Added in API level 1

abstract fun getBoolean(parameterName: String!): Boolean

Retrieves the value of a JDBC BIT or BOOLEAN parameter as a boolean in the Java programming language.

Parameters
parameterName	String!: the name of the parameter

Return
Boolean	the parameter value. If the value is SQL NULL, the result is false.

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

getByte

Added in API level 1

abstract fun getByte(parameterIndex: Int): Byte

Retrieves the value of the designated JDBC TINYINT parameter as a byte in the Java programming language.

Parameters
parameterIndex	Int: the first parameter is 1, the second is 2, and so on

Return
Byte	the parameter value. If the value is SQL NULL, the result is 0.

Exceptions
java.sql.SQLException	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement

See Also

getByte

Added in API level 1

abstract fun getByte(parameterName: String!): Byte

Retrieves the value of a JDBC TINYINT parameter as a byte in the Java programming language.

Parameters
parameterName	String!: the name of the parameter

Return
Byte	the parameter value. If the value is SQL NULL, the result is 0.

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

getBytes

Added in API level 1

abstract fun getBytes(parameterIndex: Int): ByteArray!

Retrieves the value of the designated JDBC BINARY or VARBINARY parameter as an array of byte values in the Java programming language.

Parameters
parameterIndex	Int: the first parameter is 1, the second is 2, and so on

Return
ByteArray!	the parameter value. If the value is SQL NULL, the result is null.

Exceptions
java.sql.SQLException	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement

See Also

getBytes

Added in API level 1

abstract fun getBytes(parameterName: String!): ByteArray!

Retrieves the value of a JDBC BINARY or VARBINARY parameter as an array of byte values in the Java programming language.

Parameters
parameterName	String!: the name of the parameter

Return
ByteArray!	the parameter value. If the value is SQL NULL, the result is null.

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

getCharacterStream

Added in API level 9

abstract fun getCharacterStream(parameterIndex: Int): Reader!

Retrieves the value of the designated parameter as a java.io.Reader object in the Java programming language.

Parameters
parameterIndex	Int: the first parameter is 1, the second is 2, ...

Return
Reader!	a java.io.Reader object that contains the parameter value; if the value is SQL NULL, the value returned is null in the Java programming language.

Exceptions
java.sql.SQLException	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement

getCharacterStream

Added in API level 9

abstract fun getCharacterStream(parameterName: String!): Reader!

Retrieves the value of the designated parameter as a java.io.Reader object in the Java programming language.

Parameters
parameterName	String!: the name of the parameter

Return
Reader!	a java.io.Reader object that contains the parameter value; if the value is SQL NULL, the value returned is null in the Java programming language

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

getClob

Added in API level 1

abstract fun getClob(parameterIndex: Int): Clob!

Retrieves the value of the designated JDBC CLOB parameter as a java.sql.Clob object in the Java programming language.

Parameters
parameterIndex	Int: the first parameter is 1, the second is 2, and so on

Return
Clob!	the parameter value as a Clob object in the Java programming language. If the value was SQL NULL, the value null is returned.

Exceptions
java.sql.SQLException	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

getClob

Added in API level 1

abstract fun getClob(parameterName: String!): Clob!

Retrieves the value of a JDBC CLOB parameter as a java.sql.Clob object in the Java programming language.

Parameters
parameterName	String!: the name of the parameter

Return
Clob!	the parameter value as a Clob object in the Java programming language. If the value was SQL NULL, the value null is returned.

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

getDate

Added in API level 1

abstract fun getDate(parameterIndex: Int): Date!

Retrieves the value of the designated JDBC DATE parameter as a java.sql.Date object.

Parameters
parameterIndex	Int: the first parameter is 1, the second is 2, and so on

Return
Date!	the parameter value. If the value is SQL NULL, the result is null.

Exceptions
java.sql.SQLException	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement

See Also

getDate

Added in API level 1

abstract fun getDate(
    parameterIndex: Int, 
    cal: Calendar!
): Date!

Retrieves the value of the designated JDBC 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.

Parameters
parameterIndex	Int: the first parameter is 1, the second is 2, and so on
cal	Calendar!: the Calendar object the driver will use to construct the date

Return
Date!	the parameter value. If the value is SQL NULL, the result is null.

Exceptions
java.sql.SQLException	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement

See Also

getDate

Added in API level 1

abstract fun getDate(parameterName: String!): Date!

Retrieves the value of a JDBC DATE parameter as a java.sql.Date object.

Parameters
parameterName	String!: the name of the parameter

Return
Date!	the parameter value. If the value is SQL NULL, the result is null.

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

getDate

Added in API level 1

abstract fun getDate(
    parameterName: String!, 
    cal: Calendar!
): Date!

Retrieves the value of a JDBC 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.

Parameters
parameterName	String!: the name of the parameter
cal	Calendar!: the Calendar object the driver will use to construct the date

Return
Date!	the parameter value. If the value is SQL NULL, the result is null.

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

getDouble

Added in API level 1

abstract fun getDouble(parameterIndex: Int): Double

Retrieves the value of the designated JDBC DOUBLE parameter as a double in the Java programming language.

Parameters
parameterIndex	Int: the first parameter is 1, the second is 2, and so on

Return
Double	the parameter value. If the value is SQL NULL, the result is 0.

Exceptions
java.sql.SQLException	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement

See Also

getDouble

Added in API level 1

abstract fun getDouble(parameterName: String!): Double

Retrieves the value of a JDBC DOUBLE parameter as a double in the Java programming language.

Parameters
parameterName	String!: the name of the parameter

Return
Double	the parameter value. If the value is SQL NULL, the result is 0.

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

getFloat

Added in API level 1

abstract fun getFloat(parameterIndex: Int): Float

Retrieves the value of the designated JDBC FLOAT parameter as a float in the Java programming language.

Parameters
parameterIndex	Int: the first parameter is 1, the second is 2, and so on

Return
Float	the parameter value. If the value is SQL NULL, the result is 0.

Exceptions
java.sql.SQLException	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement

See Also

getFloat

Added in API level 1

abstract fun getFloat(parameterName: String!): Float

Retrieves the value of a JDBC FLOAT parameter as a float in the Java programming language.

Parameters
parameterName	String!: the name of the parameter

Return
Float	the parameter value. If the value is SQL NULL, the result is 0.

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

getInt

Added in API level 1

abstract fun getInt(parameterIndex: Int): Int

Retrieves the value of the designated JDBC INTEGER parameter as an int in the Java programming language.

Parameters
parameterIndex	Int: the first parameter is 1, the second is 2, and so on

Return
Int	the parameter value. If the value is SQL NULL, the result is 0.

Exceptions
java.sql.SQLException	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement

See Also

getInt

Added in API level 1

abstract fun getInt(parameterName: String!): Int

Retrieves the value of a JDBC INTEGER parameter as an int in the Java programming language.

Parameters
parameterName	String!: the name of the parameter

Return
Int	the parameter value. If the value is SQL NULL, the result is 0.

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

getLong

Added in API level 1

abstract fun getLong(parameterIndex: Int): Long

Retrieves the value of the designated JDBC BIGINT parameter as a long in the Java programming language.

Parameters
parameterIndex	Int: the first parameter is 1, the second is 2, and so on

Return
Long	the parameter value. If the value is SQL NULL, the result is 0.

Exceptions
java.sql.SQLException	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement

See Also

getLong

Added in API level 1

abstract fun getLong(parameterName: String!): Long

Retrieves the value of a JDBC BIGINT parameter as a long in the Java programming language.

Parameters
parameterName	String!: the name of the parameter

Return
Long	the parameter value. If the value is SQL NULL, the result is 0.

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

getNCharacterStream

Added in API level 9

abstract fun getNCharacterStream(parameterIndex: Int): Reader!

Retrieves the value of the designated parameter as a java.io.Reader object in the Java programming language. It is intended for use when accessing NCHAR,NVARCHAR and LONGNVARCHAR parameters.

Parameters
parameterIndex	Int: the first parameter is 1, the second is 2, ...

Return
Reader!	a java.io.Reader object that contains the parameter value; if the value is SQL NULL, the value returned is null in the Java programming language.

Exceptions
java.sql.SQLException	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

getNCharacterStream

Added in API level 9

abstract fun getNCharacterStream(parameterName: String!): Reader!

Retrieves the value of the designated parameter as a java.io.Reader object in the Java programming language. It is intended for use when accessing NCHAR,NVARCHAR and LONGNVARCHAR parameters.

Parameters
parameterName	String!: the name of the parameter

Return
Reader!	a java.io.Reader object that contains the parameter value; if the value is SQL NULL, the value returned is null in the Java programming language

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

getNClob

Added in API level 9

abstract fun getNClob(parameterIndex: Int): NClob!

Retrieves the value of the designated JDBC NCLOB parameter as a java.sql.NClob object in the Java programming language.

Parameters
parameterIndex	Int: the first parameter is 1, the second is 2, and so on

Return
NClob!	the parameter value as a NClob object in the Java programming language. If the value was SQL NULL, the value null is returned.

Exceptions
java.sql.SQLException	if the parameterIndex is not valid; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

getNClob

Added in API level 9

abstract fun getNClob(parameterName: String!): NClob!

Retrieves the value of a JDBC NCLOB parameter as a java.sql.NClob object in the Java programming language.

Parameters
parameterName	String!: the name of the parameter

Return
NClob!	the parameter value as a NClob object in the Java programming language. If the value was SQL NULL, the value null is returned.

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

getNString

Added in API level 9

abstract fun getNString(parameterIndex: Int): String!

Retrieves the value of the designated NCHAR, NVARCHAR or LONGNVARCHAR parameter as a String in the Java programming language.

For the fixed-length type JDBC NCHAR, the String object returned has exactly the same value the SQL NCHAR value had in the database, including any padding added by the database.

Parameters
parameterIndex	Int: index of the first parameter is 1, the second is 2, ...

Return
String!	a String object that maps an NCHAR, NVARCHAR or LONGNVARCHAR value

Exceptions
java.sql.SQLException	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

getNString

Added in API level 9

abstract fun getNString(parameterName: String!): String!

Retrieves the value of the designated NCHAR, NVARCHAR or LONGNVARCHAR parameter as a String in the Java programming language.

For the fixed-length type JDBC NCHAR, the String object returned has exactly the same value the SQL NCHAR value had in the database, including any padding added by the database.

Parameters
parameterName	String!: the name of the parameter

Return
String!	a String object that maps an NCHAR, NVARCHAR or LONGNVARCHAR value

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

getObject

Added in API level 1

abstract fun getObject(parameterIndex: Int): Any!

Retrieves the value of the designated parameter as an Object in the Java programming language. If the value is an SQL NULL, the driver returns a Java null.

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.

Parameters
parameterIndex	Int: the first parameter is 1, the second is 2, and so on

Return
Any!	A java.lang.Object holding the OUT parameter value

Exceptions
java.sql.SQLException	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement

See Also

• java.sql.Types

getObject

Added in API level 1

abstract fun getObject(
    parameterIndex: Int, 
    map: MutableMap<String!, Class<*>!>!
): Any!

Returns an object representing the value of OUT parameter parameterIndex 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.

Parameters
parameterIndex	Int: the first parameter is 1, the second is 2, and so on
map	MutableMap<String!, Class<*>!>!: the mapping from SQL type names to Java classes

Return
Any!	a java.lang.Object holding the OUT parameter value

Exceptions
java.sql.SQLException	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

getObject

Added in API level 1

abstract fun getObject(parameterName: String!): Any!

Retrieves the value of a parameter as an Object in the Java programming language. If the value is an SQL NULL, the driver returns a Java null.

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.

Parameters
parameterName	String!: the name of the parameter

Return
Any!	A java.lang.Object holding the OUT parameter value.

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

• java.sql.Types

getObject

Added in API level 1

abstract fun getObject(
    parameterName: String!, 
    map: MutableMap<String!, Class<*>!>!
): Any!

Returns an object representing the value of OUT parameter parameterName 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.

Parameters
parameterName	String!: the name of the parameter
map	MutableMap<String!, Class<*>!>!: the mapping from SQL type names to Java classes

Return
Any!	a java.lang.Object holding the OUT parameter value

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

getRef

Added in API level 1

abstract fun getRef(parameterIndex: Int): Ref!

Retrieves the value of the designated JDBC REF(<structured-type>) parameter as a java.sql.Ref object in the Java programming language.

Parameters
parameterIndex	Int: the first parameter is 1, the second is 2, and so on

Return
Ref!	the parameter value as a Ref object in the Java programming language. If the value was SQL NULL, the value null is returned.

Exceptions
java.sql.SQLException	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

getRef

Added in API level 1

abstract fun getRef(parameterName: String!): Ref!

Retrieves the value of a JDBC REF(<structured-type>) parameter as a java.sql.Ref object in the Java programming language.

Parameters
parameterName	String!: the name of the parameter

Return
Ref!	the parameter value as a Ref object in the Java programming language. If the value was SQL NULL, the value null is returned.

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

getRowId

Added in API level 9

abstract fun getRowId(parameterIndex: Int): RowId!

Retrieves the value of the designated JDBC ROWID parameter as a java.sql.RowId object.

Parameters
parameterIndex	Int: the first parameter is 1, the second is 2,...

Return
RowId!	a RowId object that represents the JDBC ROWID value is used as the designated parameter. If the parameter contains a SQL NULL, then a null value is returned.

Exceptions
java.sql.SQLException	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

getRowId

Added in API level 9

abstract fun getRowId(parameterName: String!): RowId!

Retrieves the value of the designated JDBC ROWID parameter as a java.sql.RowId object.

Parameters
parameterName	String!: the name of the parameter

Return
RowId!	a RowId object that represents the JDBC ROWID value is used as the designated parameter. If the parameter contains a SQL NULL, then a null value is returned.

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

getSQLXML

Added in API level 9

abstract fun getSQLXML(parameterIndex: Int): SQLXML!

Retrieves the value of the designated SQL XML parameter as a java.sql.SQLXML object in the Java programming language.

Parameters
parameterIndex	Int: index of the first parameter is 1, the second is 2, ...

Return
SQLXML!	a SQLXML object that maps an SQL XML value

Exceptions
java.sql.SQLException	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

getSQLXML

Added in API level 9

abstract fun getSQLXML(parameterName: String!): SQLXML!

Retrieves the value of the designated SQL XML parameter as a java.sql.SQLXML object in the Java programming language.

Parameters
parameterName	String!: the name of the parameter

Return
SQLXML!	a SQLXML object that maps an SQL XML value

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

getShort

Added in API level 1

abstract fun getShort(parameterIndex: Int): Short

Retrieves the value of the designated JDBC SMALLINT parameter as a short in the Java programming language.

Parameters
parameterIndex	Int: the first parameter is 1, the second is 2, and so on

Return
Short	the parameter value. If the value is SQL NULL, the result is 0.

Exceptions
java.sql.SQLException	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement

See Also

getShort

Added in API level 1

abstract fun getShort(parameterName: String!): Short

Retrieves the value of a JDBC SMALLINT parameter as a short in the Java programming language.

Parameters
parameterName	String!: the name of the parameter

Return
Short	the parameter value. If the value is SQL NULL, the result is 0.

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

getString

Added in API level 1

abstract fun getString(parameterIndex: Int): String!

Retrieves the value of the designated JDBC 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 SQL CHAR value had in the database, including any padding added by the database.

Parameters
parameterIndex	Int: the first parameter is 1, the second is 2, and so on

Return
String!	the parameter value. If the value is SQL NULL, the result is null.

Exceptions
java.sql.SQLException	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement

See Also

getString

Added in API level 1

abstract fun getString(parameterName: String!): String!

Retrieves the value of a JDBC 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 SQL CHAR value had in the database, including any padding added by the database.

Parameters
parameterName	String!: the name of the parameter

Return
String!	the parameter value. If the value is SQL NULL, the result is null.

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

getTime

Added in API level 1

abstract fun getTime(parameterIndex: Int): Time!

Retrieves the value of the designated JDBC TIME parameter as a java.sql.Time object.

Parameters
parameterIndex	Int: the first parameter is 1, the second is 2, and so on

Return
Time!	the parameter value. If the value is SQL NULL, the result is null.

Exceptions
java.sql.SQLException	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement

See Also

getTime

Added in API level 1

abstract fun getTime(
    parameterIndex: Int, 
    cal: Calendar!
): Time!

Retrieves the value of the designated JDBC 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.

Parameters
parameterIndex	Int: the first parameter is 1, the second is 2, and so on
cal	Calendar!: the Calendar object the driver will use to construct the time

Return
Time!	the parameter value; if the value is SQL NULL, the result is null.

Exceptions
java.sql.SQLException	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement

See Also

getTime

Added in API level 1

abstract fun getTime(parameterName: String!): Time!

Retrieves the value of a JDBC TIME parameter as a java.sql.Time object.

Parameters
parameterName	String!: the name of the parameter

Return
Time!	the parameter value. If the value is SQL NULL, the result is null.

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

getTime

Added in API level 1

abstract fun getTime(
    parameterName: String!, 
    cal: Calendar!
): Time!

Retrieves the value of a JDBC 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.

Parameters
parameterName	String!: the name of the parameter
cal	Calendar!: the Calendar object the driver will use to construct the time

Return
Time!	the parameter value; if the value is SQL NULL, the result is null.

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

getTimestamp

Added in API level 1

abstract fun getTimestamp(parameterIndex: Int): Timestamp!

Retrieves the value of the designated JDBC TIMESTAMP parameter as a java.sql.Timestamp object.

Parameters
parameterIndex	Int: the first parameter is 1, the second is 2, and so on

Return
Timestamp!	the parameter value. If the value is SQL NULL, the result is null.

Exceptions
java.sql.SQLException	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement

See Also

getTimestamp

Added in API level 1

abstract fun getTimestamp(
    parameterIndex: Int, 
    cal: Calendar!
): Timestamp!

Retrieves the value of the designated JDBC 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.

Parameters
parameterIndex	Int: the first parameter is 1, the second is 2, and so on
cal	Calendar!: the Calendar object the driver will use to construct the timestamp

Return
Timestamp!	the parameter value. If the value is SQL NULL, the result is null.

Exceptions
java.sql.SQLException	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement

See Also

getTimestamp

Added in API level 1

abstract fun getTimestamp(parameterName: String!): Timestamp!

Retrieves the value of a JDBC TIMESTAMP parameter as a java.sql.Timestamp object.

Parameters
parameterName	String!: the name of the parameter

Return
Timestamp!	the parameter value. If the value is SQL NULL, the result is null.

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

getTimestamp

Added in API level 1

abstract fun getTimestamp(
    parameterName: String!, 
    cal: Calendar!
): Timestamp!

Retrieves the value of a JDBC 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.

Parameters
parameterName	String!: the name of the parameter
cal	Calendar!: the Calendar object the driver will use to construct the timestamp

Return
Timestamp!	the parameter value. If the value is SQL NULL, the result is null.

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

getURL

Added in API level 1

abstract fun getURL(parameterIndex: Int): URL!

Retrieves the value of the designated JDBC DATALINK parameter as a java.net.URL object.

Parameters
parameterIndex	Int: the first parameter is 1, the second is 2,...

Return
URL!	a java.net.URL object that represents the JDBC DATALINK value used as the designated parameter

Exceptions
java.sql.SQLException	if the parameterIndex is not valid; if a database access error occurs, this method is called on a closed CallableStatement, or if the URL being returned is not a valid URL on the Java platform
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

getURL

Added in API level 1

abstract fun getURL(parameterName: String!): URL!

Retrieves the value of a JDBC DATALINK parameter as a java.net.URL object.

Parameters
parameterName	String!: the name of the parameter

Return
URL!	the parameter value as a java.net.URL object in the Java programming language. If the value was SQL NULL, the value null is returned.

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs, this method is called on a closed CallableStatement, or if there is a problem with the URL
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

registerOutParameter

Added in API level 1

abstract fun registerOutParameter(
    parameterIndex: Int, 
    sqlType: Int
): Unit

Registers the OUT parameter in ordinal position 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 retrieves the value.

Parameters
parameterIndex	Int: the first parameter is 1, the second is 2, and so on
sqlType	Int: 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.

Exceptions
java.sql.SQLException	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if sqlType is a ARRAY, BLOB, CLOB, DATALINK, JAVA_OBJECT, NCHAR, NCLOB, NVARCHAR, LONGNVARCHAR, REF, ROWID, SQLXML or STRUCT data type and the JDBC driver does not support this data type

See Also

• java.sql.Types

registerOutParameter

Added in API level 1

abstract fun registerOutParameter(
    parameterIndex: Int, 
    sqlType: Int, 
    scale: Int
): Unit

Registers the parameter in ordinal position parameterIndex to be of 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.

This version of registerOutParameter should be used when the parameter is of JDBC type NUMERIC or DECIMAL.

Parameters
parameterIndex	Int: the first parameter is 1, the second is 2, and so on
sqlType	Int: the SQL type code defined by java.sql.Types.
scale	Int: the desired number of digits to the right of the decimal point. It must be greater than or equal to zero.

Exceptions
java.sql.SQLException	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if sqlType is a ARRAY, BLOB, CLOB, DATALINK, JAVA_OBJECT, NCHAR, NCLOB, NVARCHAR, LONGNVARCHAR, REF, ROWID, SQLXML or STRUCT data type and the JDBC driver does not support this data type

See Also

• java.sql.Types

registerOutParameter

Added in API level 1

abstract fun registerOutParameter(
    parameterIndex: Int, 
    sqlType: Int, 
    typeName: String!
): Unit

Registers the designated output parameter. This version of the method registerOutParameter should be used for a user-defined or REF output parameter. Examples of user-defined types include: STRUCT, DISTINCT, JAVA_OBJECT, and named array types.

All OUT parameters must be registered before a stored procedure is executed.

For a user-defined parameter, the fully-qualified SQL type name of the parameter should also be given, while a REF parameter requires that the fully-qualified type name of the referenced type be given. A JDBC driver that does not need the type code and type name information may ignore it. To be portable, however, applications should always provide these values for user-defined and REF parameters. Although it is intended for user-defined and REF parameters, this method may be used to register a parameter of any JDBC type. If the parameter does not have a user-defined or REF type, the typeName parameter is ignored.

Note: When reading the value of an out parameter, you must use the getter method whose Java type corresponds to the parameter's registered SQL type.

Parameters
parameterIndex	Int: the first parameter is 1, the second is 2,...
sqlType	Int: a value from java.sql.Types
typeName	String!: the fully-qualified name of an SQL structured type

Exceptions
java.sql.SQLException	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if sqlType is a ARRAY, BLOB, CLOB, DATALINK, JAVA_OBJECT, NCHAR, NCLOB, NVARCHAR, LONGNVARCHAR, REF, ROWID, SQLXML or STRUCT data type and the JDBC driver does not support this data type

See Also

• java.sql.Types

registerOutParameter

Added in API level 1

abstract fun registerOutParameter(
    parameterName: String!, 
    sqlType: Int
): Unit

Registers the OUT parameter named parameterName 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 retrieves the value.

Parameters
parameterName	String!: the name of the parameter
sqlType	Int: 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.

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if sqlType is a ARRAY, BLOB, CLOB, DATALINK, JAVA_OBJECT, NCHAR, NCLOB, NVARCHAR, LONGNVARCHAR, REF, ROWID, SQLXML or STRUCT data type and the JDBC driver does not support this data type or if the JDBC driver does not support this method

See Also

• java.sql.Types

registerOutParameter

Added in API level 1

abstract fun registerOutParameter(
    parameterName: String!, 
    sqlType: Int, 
    scale: Int
): Unit

Registers the parameter named parameterName to be of 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.

This version of registerOutParameter should be used when the parameter is of JDBC type NUMERIC or DECIMAL.

Parameters
parameterName	String!: the name of the parameter
sqlType	Int: SQL type code defined by java.sql.Types.
scale	Int: the desired number of digits to the right of the decimal point. It must be greater than or equal to zero.

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if sqlType is a ARRAY, BLOB, CLOB, DATALINK, JAVA_OBJECT, NCHAR, NCLOB, NVARCHAR, LONGNVARCHAR, REF, ROWID, SQLXML or STRUCT data type and the JDBC driver does not support this data type or if the JDBC driver does not support this method

See Also

• java.sql.Types

registerOutParameter

Added in API level 1

abstract fun registerOutParameter(
    parameterName: String!, 
    sqlType: Int, 
    typeName: String!
): Unit

Registers the designated output parameter. This version of the method registerOutParameter should be used for a user-named or REF output parameter. Examples of user-named types include: STRUCT, DISTINCT, JAVA_OBJECT, and named array types.

All OUT parameters must be registered before a stored procedure is executed.

For a user-named parameter the fully-qualified SQL type name of the parameter should also be given, while a REF parameter requires that the fully-qualified type name of the referenced type be given. A JDBC driver that does not need the type code and type name information may ignore it. To be portable, however, applications should always provide these values for user-named and REF parameters. Although it is intended for user-named and REF parameters, this method may be used to register a parameter of any JDBC type. If the parameter does not have a user-named or REF type, the typeName parameter is ignored.

Note: When reading the value of an out parameter, you must use the getXXX method whose Java type XXX corresponds to the parameter's registered SQL type.

Parameters
parameterName	String!: the name of the parameter
sqlType	Int: a value from java.sql.Types
typeName	String!: the fully-qualified name of an SQL structured type

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if sqlType is a ARRAY, BLOB, CLOB, DATALINK, JAVA_OBJECT, NCHAR, NCLOB, NVARCHAR, LONGNVARCHAR, REF, ROWID, SQLXML or STRUCT data type and the JDBC driver does not support this data type or if the JDBC driver does not support this method

See Also

• java.sql.Types

setAsciiStream

Added in API level 9

abstract fun setAsciiStream(
    parameterName: String!, 
    x: InputStream!
): Unit

Sets the designated parameter to the given input stream. When a very large ASCII value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.InputStream. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setAsciiStream which takes a length parameter.

Parameters
parameterName	String!: the name of the parameter
x	InputStream!: the Java input stream that contains the ASCII parameter value

Exceptions
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

setAsciiStream

Added in API level 1

abstract fun setAsciiStream(
    parameterName: String!, 
    x: InputStream!, 
    length: Int
): Unit

Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large ASCII value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.InputStream. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Parameters
parameterName	String!: the name of the parameter
x	InputStream!: the Java input stream that contains the ASCII parameter value
length	Int: the number of bytes in the stream

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

setAsciiStream

Added in API level 9

abstract fun setAsciiStream(
    parameterName: String!, 
    x: InputStream!, 
    length: Long
): Unit

Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large ASCII value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.InputStream. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Parameters
parameterName	String!: the name of the parameter
x	InputStream!: the Java input stream that contains the ASCII parameter value
length	Long: the number of bytes in the stream

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

setBigDecimal

Added in API level 1

abstract fun setBigDecimal(
    parameterName: String!, 
    x: BigDecimal!
): Unit

Sets the designated parameter to the given java.math.BigDecimal value. The driver converts this to an SQL NUMERIC value when it sends it to the database.

Parameters
parameterName	String!: the name of the parameter
x	BigDecimal!: the parameter value

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

setBinaryStream

Added in API level 9

abstract fun setBinaryStream(
    parameterName: String!, 
    x: InputStream!
): Unit

Sets the designated parameter to the given input stream. When a very large binary value is input to a LONGVARBINARY parameter, it may be more practical to send it via a java.io.InputStream object. The data will be read from the stream as needed until end-of-file is reached.

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setBinaryStream which takes a length parameter.

Parameters
parameterName	String!: the name of the parameter
x	InputStream!: the java input stream which contains the binary parameter value

Exceptions
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

setBinaryStream

Added in API level 1

abstract fun setBinaryStream(
    parameterName: String!, 
    x: InputStream!, 
    length: Int
): Unit

Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large binary value is input to a LONGVARBINARY parameter, it may be more practical to send it via a java.io.InputStream object. The data will be read from the stream as needed until end-of-file is reached.

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Parameters
parameterName	String!: the name of the parameter
x	InputStream!: the java input stream which contains the binary parameter value
length	Int: the number of bytes in the stream

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

setBinaryStream

Added in API level 9

abstract fun setBinaryStream(
    parameterName: String!, 
    x: InputStream!, 
    length: Long
): Unit

Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large binary value is input to a LONGVARBINARY parameter, it may be more practical to send it via a java.io.InputStream object. The data will be read from the stream as needed until end-of-file is reached.

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Parameters
parameterName	String!: the name of the parameter
x	InputStream!: the java input stream which contains the binary parameter value
length	Long: the number of bytes in the stream

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

setBlob

Added in API level 9

abstract fun setBlob(
    parameterName: String!, 
    inputStream: InputStream!
): Unit

Sets the designated parameter to a InputStream object. This method differs from the setBinaryStream (int, InputStream) method because it informs the driver that the parameter value should be sent to the server as a BLOB. When the setBinaryStream method is used, the driver may have to do extra work to determine whether the parameter data should be send to the server as a LONGVARBINARY or a BLOB

Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setBlob which takes a length parameter.

Parameters
parameterName	String!: the name of the parameter
inputStream	InputStream!: An object that contains the data to set the parameter value to.

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

setBlob

Added in API level 9

abstract fun setBlob(
    parameterName: String!, 
    inputStream: InputStream!, 
    length: Long
): Unit

Sets the designated parameter to a InputStream object. The inputstream must contain the number of characters specified by length, otherwise a SQLException will be generated when the CallableStatement is executed. This method differs from the setBinaryStream (int, InputStream, int) method because it informs the driver that the parameter value should be sent to the server as a BLOB. When the setBinaryStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGVARBINARY or a BLOB

Parameters
parameterName	String!: the name of the parameter to be set the second is 2, ...
inputStream	InputStream!: An object that contains the data to set the parameter value to.
length	Long: the number of bytes in the parameter data.

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if the length specified is less than zero; if the number of bytes in the inputstream does not match the specfied length; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

setBlob

Added in API level 9

abstract fun setBlob(
    parameterName: String!, 
    x: Blob!
): Unit

Sets the designated parameter to the given java.sql.Blob object. The driver converts this to an SQL BLOB value when it sends it to the database.

Parameters
parameterName	String!: the name of the parameter
x	Blob!: a Blob object that maps an SQL BLOB value

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

setBoolean

Added in API level 1

abstract fun setBoolean(
    parameterName: String!, 
    x: Boolean
): Unit

Sets the designated parameter to the given Java boolean value. The driver converts this to an SQL BIT or BOOLEAN value when it sends it to the database.

Parameters
parameterName	String!: the name of the parameter
x	Boolean: the parameter value

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

setByte

Added in API level 1

abstract fun setByte(
    parameterName: String!, 
    x: Byte
): Unit

Sets the designated parameter to the given Java byte value. The driver converts this to an SQL TINYINT value when it sends it to the database.

Parameters
parameterName	String!: the name of the parameter
x	Byte: the parameter value

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

setBytes

Added in API level 1

abstract fun setBytes(
    parameterName: String!, 
    x: ByteArray!
): Unit

Sets the designated parameter to the given Java array of bytes. The driver converts this to an SQL VARBINARY or LONGVARBINARY (depending on the argument's size relative to the driver's limits on VARBINARY values) when it sends it to the database.

Parameters
parameterName	String!: the name of the parameter
x	ByteArray!: the parameter value

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

setCharacterStream

Added in API level 9

abstract fun setCharacterStream(
    parameterName: String!, 
    reader: Reader!
): Unit

Sets the designated parameter to the given Reader object. When a very large UNICODE value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.Reader object. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setCharacterStream which takes a length parameter.

Parameters
parameterName	String!: the name of the parameter
reader	Reader!: the java.io.Reader object that contains the Unicode data

Exceptions
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

setCharacterStream

Added in API level 1

abstract fun setCharacterStream(
    parameterName: String!, 
    reader: Reader!, 
    length: Int
): Unit

Sets the designated parameter to the given 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.

Parameters
parameterName	String!: the name of the parameter
reader	Reader!: the java.io.Reader object that contains the UNICODE data used as the designated parameter
length	Int: the number of characters in the stream

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

setCharacterStream

Added in API level 9

abstract fun setCharacterStream(
    parameterName: String!, 
    reader: Reader!, 
    length: Long
): Unit

Sets the designated parameter to the given 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.

Parameters
parameterName	String!: the name of the parameter
reader	Reader!: the java.io.Reader object that contains the UNICODE data used as the designated parameter
length	Long: the number of characters in the stream

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

setClob

Added in API level 9

abstract fun setClob(
    parameterName: String!, 
    reader: Reader!
): Unit

Sets the designated parameter to a Reader object. This method differs from the setCharacterStream (int, Reader) method because it informs the driver that the parameter value should be sent to the server as a CLOB. When the setCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be send to the server as a LONGVARCHAR or a CLOB

Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setClob which takes a length parameter.

Parameters
parameterName	String!: the name of the parameter
reader	Reader!: An object that contains the data to set the parameter value to.

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

setClob

Added in API level 9

abstract fun setClob(
    parameterName: String!, 
    reader: Reader!, 
    length: Long
): Unit

Sets the designated parameter to a Reader object. The reader must contain the number of characters specified by length otherwise a SQLException will be generated when the CallableStatement is executed. This method differs from the setCharacterStream (int, Reader, int) method because it informs the driver that the parameter value should be sent to the server as a CLOB. When the setCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be send to the server as a LONGVARCHAR or a CLOB

Parameters
parameterName	String!: the name of the parameter to be set
reader	Reader!: An object that contains the data to set the parameter value to.
length	Long: the number of characters in the parameter data.

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if the length specified is less than zero; a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

setClob

Added in API level 9

abstract fun setClob(
    parameterName: String!, 
    x: Clob!
): Unit

Sets the designated parameter to the given java.sql.Clob object. The driver converts this to an SQL CLOB value when it sends it to the database.

Parameters
parameterName	String!: the name of the parameter
x	Clob!: a Clob object that maps an SQL CLOB value

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

setDate

Added in API level 1

abstract fun setDate(
    parameterName: String!, 
    x: Date!
): Unit

Sets the designated parameter to the given java.sql.Date value using the default time zone of the virtual machine that is running the application. The driver converts this to an SQL DATE value when it sends it to the database.

Parameters
parameterName	String!: the name of the parameter
x	Date!: the parameter value

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

setDate

Added in API level 1

abstract fun setDate(
    parameterName: String!, 
    x: Date!, 
    cal: Calendar!
): Unit

Sets the designated parameter to the given 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.

Parameters
parameterName	String!: the name of the parameter
x	Date!: the parameter value
cal	Calendar!: the Calendar object the driver will use to construct the date

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

setDouble

Added in API level 1

abstract fun setDouble(
    parameterName: String!, 
    x: Double
): Unit

Sets the designated parameter to the given Java double value. The driver converts this to an SQL DOUBLE value when it sends it to the database.

Parameters
parameterName	String!: the name of the parameter
x	Double: the parameter value

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

setFloat

Added in API level 1

abstract fun setFloat(
    parameterName: String!, 
    x: Float
): Unit

Sets the designated parameter to the given Java float value. The driver converts this to an SQL FLOAT value when it sends it to the database.

Parameters
parameterName	String!: the name of the parameter
x	Float: the parameter value

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

setInt

Added in API level 1

abstract fun setInt(
    parameterName: String!, 
    x: Int
): Unit

Sets the designated parameter to the given Java int value. The driver converts this to an SQL INTEGER value when it sends it to the database.

Parameters
parameterName	String!: the name of the parameter
x	Int: the parameter value

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

setLong

Added in API level 1

abstract fun setLong(
    parameterName: String!, 
    x: Long
): Unit

Sets the designated parameter to the given Java long value. The driver converts this to an SQL BIGINT value when it sends it to the database.

Parameters
parameterName	String!: the name of the parameter
x	Long: the parameter value

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

setNCharacterStream

Added in API level 9

abstract fun setNCharacterStream(
    parameterName: String!, 
    value: Reader!
): Unit

Sets the designated parameter to a Reader object. The Reader reads the data till end-of-file is reached. The driver does the necessary conversion from Java character format to the national character set in the database.

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setNCharacterStream which takes a length parameter.

Parameters
parameterName	String!: the name of the parameter
value	Reader!: the parameter value

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs; or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

setNCharacterStream

Added in API level 9

abstract fun setNCharacterStream(
    parameterName: String!, 
    value: Reader!, 
    length: Long
): Unit

Sets the designated parameter to a Reader object. The Reader reads the data till end-of-file is reached. The driver does the necessary conversion from Java character format to the national character set in the database.

Parameters
parameterName	String!: the name of the parameter to be set
value	Reader!: the parameter value
length	Long: the number of characters in the parameter data.

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

setNClob

Added in API level 9

abstract fun setNClob(
    parameterName: String!, 
    reader: Reader!
): Unit

Sets the designated parameter to a Reader object. This method differs from the setCharacterStream (int, Reader) method because it informs the driver that the parameter value should be sent to the server as a NCLOB. When the setCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be send to the server as a LONGNVARCHAR or a NCLOB

Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setNClob which takes a length parameter.

Parameters
parameterName	String!: the name of the parameter
reader	Reader!: An object that contains the data to set the parameter value to.

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

setNClob

Added in API level 9

abstract fun setNClob(
    parameterName: String!, 
    reader: Reader!, 
    length: Long
): Unit

Sets the designated parameter to a Reader object. The reader must contain the number of characters specified by length otherwise a SQLException will be generated when the CallableStatement is executed. This method differs from the setCharacterStream (int, Reader, int) method because it informs the driver that the parameter value should be sent to the server as a NCLOB. When the setCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be send to the server as a LONGNVARCHAR or a NCLOB

Parameters
parameterName	String!: the name of the parameter to be set
reader	Reader!: An object that contains the data to set the parameter value to.
length	Long: the number of characters in the parameter data.

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if the length specified is less than zero; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

setNClob

Added in API level 9

abstract fun setNClob(
    parameterName: String!, 
    value: NClob!
): Unit

Sets the designated parameter to a java.sql.NClob object. The object implements the java.sql.NClob interface. This NClob object maps to a SQL NCLOB.

Parameters
parameterName	String!: the name of the parameter to be set
value	NClob!: the parameter value

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

setNString

Added in API level 9

abstract fun setNString(
    parameterName: String!, 
    value: String!
): Unit

Sets the designated parameter to the given String object. The driver converts this to a SQL NCHAR or NVARCHAR or LONGNVARCHAR

Parameters
parameterName	String!: the name of the parameter to be set
value	String!: the parameter value

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

setNull

Added in API level 1

abstract fun setNull(
    parameterName: String!, 
    sqlType: Int
): Unit

Sets the designated parameter to SQL NULL.

Note: You must specify the parameter's SQL type.

Parameters
parameterName	String!: the name of the parameter
sqlType	Int: the SQL type code defined in java.sql.Types

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

setNull

Added in API level 1

abstract fun setNull(
    parameterName: String!, 
    sqlType: Int, 
    typeName: String!
): Unit

Sets the designated parameter to SQL 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.

Although it is intended for user-defined and Ref parameters, this method may be used to set a null parameter of any JDBC type. If the parameter does not have a user-defined or REF type, the given typeName is ignored.

Parameters
parameterName	String!: the name of the parameter
sqlType	Int: a value from java.sql.Types
typeName	String!: the fully-qualified name of an SQL user-defined type; ignored if the parameter is not a user-defined type or SQL REF value

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

setObject

Added in API level 1

abstract fun setObject(
    parameterName: String!, 
    x: Any!
): Unit

Sets the value of the designated parameter with the given object. The second parameter must be of type Object; therefore, the java.lang equivalent objects should be used for built-in types.

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

Note that this method may be used to pass datatabase- specific abstract data types, by using a driver-specific Java type. If the object is of a class implementing the 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, NClob, Struct, java.net.URL, or Array, 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.

Note: Not all databases allow for a non-typed Null to be sent to the backend. For maximum portability, the setNull or the setObject(String parameterName, Object x, int sqlType) method should be used instead of setObject(String parameterName, Object x).

Parameters
parameterName	String!: the name of the parameter
x	Any!: the object containing the input parameter value

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs, this method is called on a closed CallableStatement or if the given Object parameter is ambiguous
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

setObject

Added in API level 1

abstract fun setObject(
    parameterName: String!, 
    x: Any!, 
    targetSqlType: Int
): Unit

Sets the value of the designated parameter with the given object. This method is like the method setObject above, except that it assumes a scale of zero.

Parameters
parameterName	String!: the name of the parameter
x	Any!: the object containing the input parameter value
targetSqlType	Int: the SQL type (as defined in java.sql.Types) to be sent to the database

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if targetSqlType is a ARRAY, BLOB, CLOB, DATALINK, JAVA_OBJECT, NCHAR, NCLOB, NVARCHAR, LONGNVARCHAR, REF, ROWID, SQLXML or STRUCT data type and the JDBC driver does not support this data type

See Also

setObject

Added in API level 1

abstract fun setObject(
    parameterName: String!, 
    x: Any!, 
    targetSqlType: Int, 
    scale: Int
): Unit

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, NClob, Struct, java.net.URL, or Array, the driver should pass it to the database as a value of the corresponding SQL type.

Note that this method may be used to pass datatabase- specific abstract data types.

Parameters
parameterName	String!: the name of the parameter
x	Any!: the object containing the input parameter value
targetSqlType	Int: the SQL type (as defined in java.sql.Types) to be sent to the database. The scale argument may further qualify this type.
scale	Int: 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.

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if targetSqlType is a ARRAY, BLOB, CLOB, DATALINK, JAVA_OBJECT, NCHAR, NCLOB, NVARCHAR, LONGNVARCHAR, REF, ROWID, SQLXML or STRUCT data type and the JDBC driver does not support this data type

See Also

• java.sql.Types

setRowId

Added in API level 9

abstract fun setRowId(
    parameterName: String!, 
    x: RowId!
): Unit

Sets the designated parameter to the given java.sql.RowId object. The driver converts this to a SQL ROWID when it sends it to the database.

Parameters
parameterName	String!: the name of the parameter
x	RowId!: the parameter value

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

setSQLXML

Added in API level 9

abstract fun setSQLXML(
    parameterName: String!, 
    xmlObject: SQLXML!
): Unit

Sets the designated parameter to the given java.sql.SQLXML object. The driver converts this to an SQL XML value when it sends it to the database.

Parameters
parameterName	String!: the name of the parameter
xmlObject	SQLXML!: a SQLXML object that maps an SQL XML value

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs; this method is called on a closed CallableStatement or the java.xml.transform.Result, Writer or OutputStream has not been closed for the SQLXML object
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

setShort

Added in API level 1

abstract fun setShort(
    parameterName: String!, 
    x: Short
): Unit

Sets the designated parameter to the given Java short value. The driver converts this to an SQL SMALLINT value when it sends it to the database.

Parameters
parameterName	String!: the name of the parameter
x	Short: the parameter value

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

setString

Added in API level 1

abstract fun setString(
    parameterName: String!, 
    x: String!
): Unit

Sets the designated parameter to the given Java String value. The driver converts this to an SQL VARCHAR or LONGVARCHAR value (depending on the argument's size relative to the driver's limits on VARCHAR values) when it sends it to the database.

Parameters
parameterName	String!: the name of the parameter
x	String!: the parameter value

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

setTime

Added in API level 1

abstract fun setTime(
    parameterName: String!, 
    x: Time!
): Unit

Sets the designated parameter to the given java.sql.Time value. The driver converts this to an SQL TIME value when it sends it to the database.

Parameters
parameterName	String!: the name of the parameter
x	Time!: the parameter value

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

setTime

Added in API level 1

abstract fun setTime(
    parameterName: String!, 
    x: Time!, 
    cal: Calendar!
): Unit

Sets the designated parameter to the given 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.

Parameters
parameterName	String!: the name of the parameter
x	Time!: the parameter value
cal	Calendar!: the Calendar object the driver will use to construct the time

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

setTimestamp

Added in API level 1

abstract fun setTimestamp(
    parameterName: String!, 
    x: Timestamp!
): Unit

Sets the designated parameter to the given java.sql.Timestamp value. The driver converts this to an SQL TIMESTAMP value when it sends it to the database.

Parameters
parameterName	String!: the name of the parameter
x	Timestamp!: the parameter value

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

setTimestamp

Added in API level 1

abstract fun setTimestamp(
    parameterName: String!, 
    x: Timestamp!, 
    cal: Calendar!
): Unit

Sets the designated parameter to the given 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.

Parameters
parameterName	String!: the name of the parameter
x	Timestamp!: the parameter value
cal	Calendar!: the Calendar object the driver will use to construct the timestamp

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

setURL

Added in API level 1

abstract fun setURL(
    parameterName: String!, 
    val: URL!
): Unit

Sets the designated parameter to the given java.net.URL object. The driver converts this to an SQL DATALINK value when it sends it to the database.

Parameters
parameterName	String!: the name of the parameter
val	URL!: the parameter value

Exceptions
java.sql.SQLException	if parameterName does not correspond to a named parameter; if a database access error occurs; this method is called on a closed CallableStatement or if a URL is malformed
java.sql.SQLFeatureNotSupportedException	if the JDBC driver does not support this method

See Also

wasNull

Added in API level 1

abstract fun wasNull(): Boolean

Retrieves whether the last OUT parameter read had the value of SQL NULL. Note that this method should be called only after calling a getter method; otherwise, there is no value to use in determining whether it is null or not.

Return
Boolean	true if the last parameter read was SQL NULL; false otherwise

Exceptions
java.sql.SQLException	if a database access error occurs or this method is called on a closed CallableStatement