ResultSet
public interface ResultSet
implements AutoCloseable, Wrapper
java.sql.ResultSet |
A table of data representing a database result set, which is usually generated by executing a statement that queries the database.
A ResultSet
object maintains a cursor pointing to its current row of data. Initially the cursor is positioned before the first row. The next
method moves the cursor to the next row, and because it returns false
when there are no more rows in the ResultSet
object, it can be used in a while
loop to iterate through the result set.
A default ResultSet
object is not updatable and has a cursor that moves forward only. Thus, you can iterate through it only once and only from the first row to the last row. It is possible to produce ResultSet
objects that are scrollable and/or updatable. The following code fragment, in which con
is a valid Connection
object, illustrates how to make a result set that is scrollable and insensitive to updates by others, and that is updatable. See ResultSet
fields for other options.
Statement stmt = con.createStatement( ResultSet.TYPE_SCROLL_INSENSITIVE, ResultSet.CONCUR_UPDATABLE); ResultSet rs = stmt.executeQuery("SELECT a, b FROM TABLE2"); // rs will be scrollable, will not show changes made by others, // and will be updatable
ResultSet
interface provides getter methods (getBoolean
, getLong
, and so on) for retrieving column values from the current row. Values can be retrieved using either the index number of the column or the name of the column. In general, using the column index will be more efficient. Columns are numbered from 1. For maximum portability, result set columns within each row should be read in left-to-right order, and each column should be read only once. For the getter methods, a JDBC driver attempts to convert the underlying data to the Java type specified in the getter method and returns a suitable Java value. The JDBC specification has a table showing the allowable mappings from SQL types to Java types that can be used by the ResultSet
getter methods.
Column names used as input to getter methods are case insensitive. When a getter method is called with a column name and several columns have the same name, the value of the first matching column will be returned. The column name option is designed to be used when column names are used in the SQL query that generated the result set. For columns that are NOT explicitly named in the query, it is best to use column numbers. If column names are used, the programmer should take care to guarantee that they uniquely refer to the intended columns, which can be assured with the SQL AS clause.
A set of updater methods were added to this interface in the JDBC 2.0 API (JavaTM 2 SDK, Standard Edition, version 1.2). The comments regarding parameters to the getter methods also apply to parameters to the updater methods.
The updater methods may be used in two ways:
- to update a column value in the current row. In a scrollable
ResultSet
object, the cursor can be moved backwards and forwards, to an absolute position, or to a position relative to the current row. The following code fragment updates theNAME
column in the fifth row of theResultSet
objectrs
and then uses the methodupdateRow
to update the data source table from whichrs
was derived.rs.absolute(5); // moves the cursor to the fifth row of rs rs.updateString("NAME", "AINSWORTH"); // updates the //
NAME
column of row 5 to beAINSWORTH
rs.updateRow(); // updates the row in the data source - to insert column values into the insert row. An updatable
ResultSet
object has a special row associated with it that serves as a staging area for building a row to be inserted. The following code fragment moves the cursor to the insert row, builds a three-column row, and inserts it intors
and into the data source table using the methodinsertRow
.rs.moveToInsertRow(); // moves cursor to the insert row rs.updateString(1, "AINSWORTH"); // updates the // first column of the insert row to be
AINSWORTH
rs.updateInt(2,35); // updates the second column to be35
rs.updateBoolean(3, true); // updates the third column totrue
rs.insertRow(); rs.moveToCurrentRow();
A ResultSet
object is automatically closed when the Statement
object that generated it is closed, re-executed, or used to retrieve the next result from a sequence of multiple results.
The number, types and properties of a ResultSet
object's columns are provided by the ResultSetMetaData
object returned by the ResultSet.getMetaData
method.
Summary
Constants | |
---|---|
int | CLOSE_CURSORS_AT_COMMIT The constant indicating that open |
int | CONCUR_READ_ONLY The constant indicating the concurrency mode for a |
int | CONCUR_UPDATABLE The constant indicating the concurrency mode for a |
int | FETCH_FORWARD The constant indicating that the rows in a result set will be processed in a forward direction; first-to-last. |
int | FETCH_REVERSE The constant indicating that the rows in a result set will be processed in a reverse direction; last-to-first. |
int | FETCH_UNKNOWN The constant indicating that the order in which rows in a result set will be processed is unknown. |
int | HOLD_CURSORS_OVER_COMMIT The constant indicating that open |
int | TYPE_FORWARD_ONLY The constant indicating the type for a |
int | TYPE_SCROLL_INSENSITIVE The constant indicating the type for a |
int | TYPE_SCROLL_SENSITIVE The constant indicating the type for a |
Public methods | |
---|---|
abstract boolean | absolute(int row) Moves the cursor to the given row number in this |
abstract void | afterLast() Moves the cursor to the end of this |
abstract void | beforeFirst() Moves the cursor to the front of this |
abstract void | cancelRowUpdates() Cancels the updates made to the current row in this |
abstract void | clearWarnings() Clears all warnings reported on this |
abstract void | close() Releases this |
abstract void | deleteRow() Deletes the current row from this |
abstract int | findColumn(String columnLabel) Maps the given |
abstract boolean | first() Moves the cursor to the first row in this |
abstract Array | getArray(int columnIndex) Retrieves the value of the designated column in the current row of this |
abstract Array | getArray(String columnLabel) Retrieves the value of the designated column in the current row of this |
abstract InputStream | getAsciiStream(int columnIndex) Retrieves the value of the designated column in the current row of this |
abstract InputStream | getAsciiStream(String columnLabel) Retrieves the value of the designated column in the current row of this |
abstract BigDecimal | getBigDecimal(String columnLabel) Retrieves the value of the designated column in the current row of this |
abstract BigDecimal | getBigDecimal(String columnLabel, int scale) This method was deprecated in API level 15. Use |
abstract BigDecimal | getBigDecimal(int columnIndex, int scale) This method was deprecated in API level 15. Use |
abstract BigDecimal | getBigDecimal(int columnIndex) Retrieves the value of the designated column in the current row of this |
abstract InputStream | getBinaryStream(String columnLabel) Retrieves the value of the designated column in the current row of this |
abstract InputStream | getBinaryStream(int columnIndex) Retrieves the value of the designated column in the current row of this |
abstract Blob | getBlob(int columnIndex) Retrieves the value of the designated column in the current row of this |
abstract Blob | getBlob(String columnLabel) Retrieves the value of the designated column in the current row of this |
abstract boolean | getBoolean(String columnLabel) Retrieves the value of the designated column in the current row of this |
abstract boolean | getBoolean(int columnIndex) Retrieves the value of the designated column in the current row of this |
abstract byte | getByte(String columnLabel) Retrieves the value of the designated column in the current row of this |
abstract byte | getByte(int columnIndex) Retrieves the value of the designated column in the current row of this |
abstract byte[] | getBytes(String columnLabel) Retrieves the value of the designated column in the current row of this |
abstract byte[] | getBytes(int columnIndex) Retrieves the value of the designated column in the current row of this |
abstract Reader | getCharacterStream(int columnIndex) Retrieves the value of the designated column in the current row of this |
abstract Reader | getCharacterStream(String columnLabel) Retrieves the value of the designated column in the current row of this |
abstract Clob | getClob(int columnIndex) Retrieves the value of the designated column in the current row of this |
abstract Clob | getClob(String columnLabel) Retrieves the value of the designated column in the current row of this |
abstract int | getConcurrency() Retrieves the concurrency mode of this |
abstract String | getCursorName() Retrieves the name of the SQL cursor used by this |
abstract Date | getDate(int columnIndex) Retrieves the value of the designated column in the current row of this |
abstract Date | getDate(String columnLabel) Retrieves the value of the designated column in the current row of this |
abstract Date | getDate(String columnLabel, Calendar cal) Retrieves the value of the designated column in the current row of this |
abstract Date | getDate(int columnIndex, Calendar cal) Retrieves the value of the designated column in the current row of this |
abstract double | getDouble(int columnIndex) Retrieves the value of the designated column in the current row of this |
abstract double | getDouble(String columnLabel) Retrieves the value of the designated column in the current row of this |
abstract int | getFetchDirection() Retrieves the fetch direction for this |
abstract int | getFetchSize() Retrieves the fetch size for this |
abstract float | getFloat(String columnLabel) Retrieves the value of the designated column in the current row of this |
abstract float | getFloat(int columnIndex) Retrieves the value of the designated column in the current row of this |
abstract int | getHoldability() Retrieves the holdability of this |
abstract int | getInt(int columnIndex) Retrieves the value of the designated column in the current row of this |
abstract int | getInt(String columnLabel) Retrieves the value of the designated column in the current row of this |
abstract long | getLong(String columnLabel) Retrieves the value of the designated column in the current row of this |
abstract long | getLong(int columnIndex) Retrieves the value of the designated column in the current row of this |
abstract ResultSetMetaData | getMetaData() Retrieves the number, types and properties of this |
abstract Reader | getNCharacterStream(int columnIndex) Retrieves the value of the designated column in the current row of this |
abstract Reader | getNCharacterStream(String columnLabel) Retrieves the value of the designated column in the current row of this |
abstract NClob | getNClob(String columnLabel) Retrieves the value of the designated column in the current row of this |
abstract NClob | getNClob(int columnIndex) Retrieves the value of the designated column in the current row of this |
abstract String | getNString(String columnLabel) Retrieves the value of the designated column in the current row of this |
abstract String | getNString(int columnIndex) Retrieves the value of the designated column in the current row of this |
abstract Object | getObject(String columnLabel, Map<String, Class<?>> map) Retrieves the value of the designated column in the current row of this |
abstract Object | getObject(int columnIndex, Map<String, Class<?>> map) Retrieves the value of the designated column in the current row of this |
abstract Object | getObject(int columnIndex) Gets the value of the designated column in the current row of this |
abstract Object | getObject(String columnLabel) Gets the value of the designated column in the current row of this |
abstract Ref | getRef(int columnIndex) Retrieves the value of the designated column in the current row of this |
abstract Ref | getRef(String columnLabel) Retrieves the value of the designated column in the current row of this |
abstract int | getRow() Retrieves the current row number. |
abstract RowId | getRowId(int columnIndex) Retrieves the value of the designated column in the current row of this |
abstract RowId | getRowId(String columnLabel) Retrieves the value of the designated column in the current row of this |
abstract SQLXML | getSQLXML(String columnLabel) Retrieves the value of the designated column in the current row of this |
abstract SQLXML | getSQLXML(int columnIndex) Retrieves the value of the designated column in the current row of this |
abstract short | getShort(String columnLabel) Retrieves the value of the designated column in the current row of this |
abstract short | getShort(int columnIndex) Retrieves the value of the designated column in the current row of this |
abstract Statement | getStatement() Retrieves the |
abstract String | getString(int columnIndex) Retrieves the value of the designated column in the current row of this |
abstract String | getString(String columnLabel) Retrieves the value of the designated column in the current row of this |
abstract Time | getTime(String columnLabel) Retrieves the value of the designated column in the current row of this |
abstract Time | getTime(String columnLabel, Calendar cal) Retrieves the value of the designated column in the current row of this |
abstract Time | getTime(int columnIndex) Retrieves the value of the designated column in the current row of this |
abstract Time | getTime(int columnIndex, Calendar cal) Retrieves the value of the designated column in the current row of this |
abstract Timestamp | getTimestamp(int columnIndex, Calendar cal) Retrieves the value of the designated column in the current row of this |
abstract Timestamp | getTimestamp(int columnIndex) Retrieves the value of the designated column in the current row of this |
abstract Timestamp | getTimestamp(String columnLabel, Calendar cal) Retrieves the value of the designated column in the current row of this |
abstract Timestamp | getTimestamp(String columnLabel) Retrieves the value of the designated column in the current row of this |
abstract int | getType() Retrieves the type of this |
abstract URL | getURL(int columnIndex) Retrieves the value of the designated column in the current row of this |
abstract URL | getURL(String columnLabel) Retrieves the value of the designated column in the current row of this |
abstract InputStream | getUnicodeStream(int columnIndex) This method was deprecated in API level 15. use |
abstract InputStream | getUnicodeStream(String columnLabel) This method was deprecated in API level 15. use |
abstract SQLWarning | getWarnings() Retrieves the first warning reported by calls on this |
abstract void | insertRow() Inserts the contents of the insert row into this |
abstract boolean | isAfterLast() Retrieves whether the cursor is after the last row in this |
abstract boolean | isBeforeFirst() Retrieves whether the cursor is before the first row in this |
abstract boolean | isClosed() Retrieves whether this |
abstract boolean | isFirst() Retrieves whether the cursor is on the first row of this |
abstract boolean | isLast() Retrieves whether the cursor is on the last row of this |
abstract boolean | last() Moves the cursor to the last row in this |
abstract void | moveToCurrentRow() Moves the cursor to the remembered cursor position, usually the current row. |
abstract void | moveToInsertRow() Moves the cursor to the insert row. |
abstract boolean | next() Moves the cursor froward one row from its current position. |
abstract boolean | previous() Moves the cursor to the previous row in this |
abstract void | refreshRow() Refreshes the current row with its most recent value in the database. |
abstract boolean | relative(int rows) Moves the cursor a relative number of rows, either positive or negative. |
abstract boolean | rowDeleted() Retrieves whether a row has been deleted. |
abstract boolean | rowInserted() Retrieves whether the current row has had an insertion. |
abstract boolean | rowUpdated() Retrieves whether the current row has been updated. |
abstract void | setFetchDirection(int direction) Gives a hint as to the direction in which the rows in this |
abstract void | setFetchSize(int rows) Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed for this |
abstract void | updateArray(String columnLabel, Array x) Updates the designated column with a |
abstract void | updateArray(int columnIndex, Array x) Updates the designated column with a |
abstract void | updateAsciiStream(int columnIndex, InputStream x) Updates the designated column with an ascii stream value. |
abstract void | updateAsciiStream(int columnIndex, InputStream x, long length) Updates the designated column with an ascii stream value, which will have the specified number of bytes. |
abstract void | updateAsciiStream(String columnLabel, InputStream x, long length) Updates the designated column with an ascii stream value, which will have the specified number of bytes. |
abstract void | updateAsciiStream(String columnLabel, InputStream x) Updates the designated column with an ascii stream value. |
abstract void | updateAsciiStream(int columnIndex, InputStream x, int length) Updates the designated column with an ascii stream value, which will have the specified number of bytes. |
abstract void | updateAsciiStream(String columnLabel, InputStream x, int length) Updates the designated column with an ascii stream value, which will have the specified number of bytes. |
abstract void | updateBigDecimal(int columnIndex, BigDecimal x) Updates the designated column with a |
abstract void | updateBigDecimal(String columnLabel, BigDecimal x) Updates the designated column with a |
abstract void | updateBinaryStream(int columnIndex, InputStream x, int length) Updates the designated column with a binary stream value, which will have the specified number of bytes. |
abstract void | updateBinaryStream(int columnIndex, InputStream x) Updates the designated column with a binary stream value. |
abstract void | updateBinaryStream(String columnLabel, InputStream x, long length) Updates the designated column with a binary stream value, which will have the specified number of bytes. |
abstract void | updateBinaryStream(String columnLabel, InputStream x) Updates the designated column with a binary stream value. |
abstract void | updateBinaryStream(String columnLabel, InputStream x, int length) Updates the designated column with a binary stream value, which will have the specified number of bytes. |
abstract void | updateBinaryStream(int columnIndex, InputStream x, long length) Updates the designated column with a binary stream value, which will have the specified number of bytes. |
abstract void | updateBlob(String columnLabel, Blob x) Updates the designated column with a |
abstract void | updateBlob(String columnLabel, InputStream inputStream) Updates the designated column using the given input stream. |
abstract void | updateBlob(int columnIndex, Blob x) Updates the designated column with a |
abstract void | updateBlob(String columnLabel, InputStream inputStream, long length) Updates the designated column using the given input stream, which will have the specified number of bytes. |
abstract void | updateBlob(int columnIndex, InputStream inputStream) Updates the designated column using the given input stream. |
abstract void | updateBlob(int columnIndex, InputStream inputStream, long length) Updates the designated column using the given input stream, which will have the specified number of bytes. |
abstract void | updateBoolean(String columnLabel, boolean x) Updates the designated column with a |
abstract void | updateBoolean(int columnIndex, boolean x) Updates the designated column with a |
abstract void | updateByte(int columnIndex, byte x) Updates the designated column with a |
abstract void | updateByte(String columnLabel, byte x) Updates the designated column with a |
abstract void | updateBytes(int columnIndex, byte[] x) Updates the designated column with a |
abstract void | updateBytes(String columnLabel, byte[] x) Updates the designated column with a byte array value. |
abstract void | updateCharacterStream(String columnLabel, Reader reader, int length) Updates the designated column with a character stream value, which will have the specified number of bytes. |
abstract void | updateCharacterStream(String columnLabel, Reader reader, long length) Updates the designated column with a character stream value, which will have the specified number of bytes. |
abstract void | updateCharacterStream(int columnIndex, Reader x, long length) Updates the designated column with a character stream value, which will have the specified number of bytes. |
abstract void | updateCharacterStream(int columnIndex, Reader x) Updates the designated column with a character stream value. |
abstract void | updateCharacterStream(int columnIndex, Reader x, int length) Updates the designated column with a character stream value, which will have the specified number of bytes. |
abstract void | updateCharacterStream(String columnLabel, Reader reader) Updates the designated column with a character stream value. |
abstract void | updateClob(int columnIndex, Clob x) Updates the designated column with a |
abstract void | updateClob(String columnLabel, Reader reader) Updates the designated column using the given |
abstract void | updateClob(String columnLabel, Reader reader, long length) Updates the designated column using the given |
abstract void | updateClob(int columnIndex, Reader reader) Updates the designated column using the given |
abstract void | updateClob(int columnIndex, Reader reader, long length) Updates the designated column using the given |
abstract void | updateClob(String columnLabel, Clob x) Updates the designated column with a |
abstract void | updateDate(int columnIndex, Date x) Updates the designated column with a |
abstract void | updateDate(String columnLabel, Date x) Updates the designated column with a |
abstract void | updateDouble(String columnLabel, double x) Updates the designated column with a |
abstract void | updateDouble(int columnIndex, double x) Updates the designated column with a |
abstract void | updateFloat(int columnIndex, float x) Updates the designated column with a |
abstract void | updateFloat(String columnLabel, float x) Updates the designated column with a |
abstract void | updateInt(String columnLabel, int x) Updates the designated column with an |
abstract void | updateInt(int columnIndex, int x) Updates the designated column with an |
abstract void | updateLong(int columnIndex, long x) Updates the designated column with a |
abstract void | updateLong(String columnLabel, long x) Updates the designated column with a |
abstract void | updateNCharacterStream(int columnIndex, Reader x, long length) Updates the designated column with a character stream value, which will have the specified number of bytes. |
abstract void | updateNCharacterStream(String columnLabel, Reader reader) Updates the designated column with a character stream value. |
abstract void | updateNCharacterStream(int columnIndex, Reader x) Updates the designated column with a character stream value. |
abstract void | updateNCharacterStream(String columnLabel, Reader reader, long length) Updates the designated column with a character stream value, which will have the specified number of bytes. |
abstract void | updateNClob(int columnIndex, Reader reader, long length) Updates the designated column using the given |
abstract void | updateNClob(int columnIndex, NClob nClob) Updates the designated column with a |
abstract void | updateNClob(String columnLabel, NClob nClob) Updates the designated column with a |
abstract void | updateNClob(String columnLabel, Reader reader) Updates the designated column using the given |
abstract void | updateNClob(String columnLabel, Reader reader, long length) Updates the designated column using the given |
abstract void | updateNClob(int columnIndex, Reader reader) Updates the designated column using the given |
abstract void | updateNString(String columnLabel, String nString) Updates the designated column with a |
abstract void | updateNString(int columnIndex, String nString) Updates the designated column with a |
abstract void | updateNull(int columnIndex) Updates the designated column with a |
abstract void | updateNull(String columnLabel) Updates the designated column with a |
abstract void | updateObject(int columnIndex, Object x) Updates the designated column with an |
abstract void | updateObject(int columnIndex, Object x, int scaleOrLength) Updates the designated column with an |
abstract void | updateObject(String columnLabel, Object x, int scaleOrLength) Updates the designated column with an |
abstract void | updateObject(String columnLabel, Object x) Updates the designated column with an |
abstract void | updateRef(int columnIndex, Ref x) Updates the designated column with a |
abstract void | updateRef(String columnLabel, Ref x) Updates the designated column with a |
abstract void | updateRow() Updates the underlying database with the new contents of the current row of this |
abstract void | updateRowId(int columnIndex, RowId x) Updates the designated column with a |
abstract void | updateRowId(String columnLabel, RowId x) Updates the designated column with a |
abstract void | updateSQLXML(int columnIndex, SQLXML xmlObject) Updates the designated column with a |
abstract void | updateSQLXML(String columnLabel, SQLXML xmlObject) Updates the designated column with a |
abstract void | updateShort(String columnLabel, short x) Updates the designated column with a |
abstract void | updateShort(int columnIndex, short x) Updates the designated column with a |
abstract void | updateString(String columnLabel, String x) Updates the designated column with a |
abstract void | updateString(int columnIndex, String x) Updates the designated column with a |
abstract void | updateTime(int columnIndex, Time x) Updates the designated column with a |
abstract void | updateTime(String columnLabel, Time x) Updates the designated column with a |
abstract void | updateTimestamp(String columnLabel, Timestamp x) Updates the designated column with a |
abstract void | updateTimestamp(int columnIndex, Timestamp x) Updates the designated column with a |
abstract boolean | wasNull() Reports whether the last column read had a value of SQL |
Inherited methods | |
---|---|
Constants
CLOSE_CURSORS_AT_COMMIT
public static final int CLOSE_CURSORS_AT_COMMIT
The constant indicating that open ResultSet
objects with this holdability will be closed when the current transaction is commited.
Constant Value: 2 (0x00000002)
CONCUR_READ_ONLY
public static final int CONCUR_READ_ONLY
The constant indicating the concurrency mode for a ResultSet
object that may NOT be updated.
Constant Value: 1007 (0x000003ef)
CONCUR_UPDATABLE
public static final int CONCUR_UPDATABLE
The constant indicating the concurrency mode for a ResultSet
object that may be updated.
Constant Value: 1008 (0x000003f0)
FETCH_FORWARD
public static final int FETCH_FORWARD
The constant indicating that the rows in a result set will be processed in a forward direction; first-to-last. This constant is used by the method setFetchDirection
as a hint to the driver, which the driver may ignore.
Constant Value: 1000 (0x000003e8)
FETCH_REVERSE
public static final int FETCH_REVERSE
The constant indicating that the rows in a result set will be processed in a reverse direction; last-to-first. This constant is used by the method setFetchDirection
as a hint to the driver, which the driver may ignore.
Constant Value: 1001 (0x000003e9)
FETCH_UNKNOWN
public static final int FETCH_UNKNOWN
The constant indicating that the order in which rows in a result set will be processed is unknown. This constant is used by the method setFetchDirection
as a hint to the driver, which the driver may ignore.
Constant Value: 1002 (0x000003ea)
HOLD_CURSORS_OVER_COMMIT
public static final int HOLD_CURSORS_OVER_COMMIT
The constant indicating that open ResultSet
objects with this holdability will remain open when the current transaction is commited.
Constant Value: 1 (0x00000001)
TYPE_FORWARD_ONLY
public static final int TYPE_FORWARD_ONLY
The constant indicating the type for a ResultSet
object whose cursor may move only forward.
Constant Value: 1003 (0x000003eb)
TYPE_SCROLL_INSENSITIVE
public static final int TYPE_SCROLL_INSENSITIVE
The constant indicating the type for a ResultSet
object that is scrollable but generally not sensitive to changes to the data that underlies the ResultSet
.
Constant Value: 1004 (0x000003ec)
TYPE_SCROLL_SENSITIVE
public static final int TYPE_SCROLL_SENSITIVE
The constant indicating the type for a ResultSet
object that is scrollable and generally sensitive to changes to the data that underlies the ResultSet
.
Constant Value: 1005 (0x000003ed)
Public methods
absolute
public abstract boolean absolute (int row)
Moves the cursor to the given row number in this ResultSet
object.
If the row number is positive, the cursor moves to the given row number with respect to the beginning of the result set. The first row is row 1, the second is row 2, and so on.
If the given row number is negative, the cursor moves to an absolute row position with respect to the end of the result set. For example, calling the method absolute(-1)
positions the cursor on the last row; calling the method absolute(-2)
moves the cursor to the next-to-last row, and so on.
If the row number specified is zero, the cursor is moved to before the first row.
An attempt to position the cursor beyond the first/last row in the result set leaves the cursor before the first row or after the last row.
Note: Calling absolute(1)
is the same as calling first()
. Calling absolute(-1)
is the same as calling last()
.
Parameters | |
---|---|
row | int : the number of the row to which the cursor should move. A value of zero indicates that the cursor will be positioned before the first row; a positive number indicates the row number counting from the beginning of the result set; a negative number indicates the row number counting from the end of the result set |
Returns | |
---|---|
boolean | true if the cursor is moved to a position in this ResultSet object; false if the cursor is before the first row or after the last row |
Throws | |
---|---|
SQLException | if a database access error occurs; this method is called on a closed result set or the result set type is TYPE_FORWARD_ONLY |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
afterLast
public abstract void afterLast ()
Moves the cursor to the end of this ResultSet
object, just after the last row. This method has no effect if the result set contains no rows.
Throws | |
---|---|
SQLException | if a database access error occurs; this method is called on a closed result set or the result set type is TYPE_FORWARD_ONLY |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
beforeFirst
public abstract void beforeFirst ()
Moves the cursor to the front of this ResultSet
object, just before the first row. This method has no effect if the result set contains no rows.
Throws | |
---|---|
SQLException | if a database access error occurs; this method is called on a closed result set or the result set type is TYPE_FORWARD_ONLY |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
cancelRowUpdates
public abstract void cancelRowUpdates ()
Cancels the updates made to the current row in this ResultSet
object. This method may be called after calling an updater method(s) and before calling the method updateRow
to roll back the updates made to a row. If no updates have been made or updateRow
has already been called, this method has no effect.
Throws | |
---|---|
SQLException | if a database access error occurs; this method is called on a closed result set; the result set concurrency is CONCUR_READ_ONLY or if this method is called when the cursor is on the insert row |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
clearWarnings
public abstract void clearWarnings ()
Clears all warnings reported on this ResultSet
object. After this method is called, the method getWarnings
returns null
until a new warning is reported for this ResultSet
object.
Throws | |
---|---|
SQLException | if a database access error occurs or this method is called on a closed result set |
close
public abstract void close ()
Releases this ResultSet
object's database and JDBC resources immediately instead of waiting for this to happen when it is automatically closed.
The closing of a ResultSet
object does not close the Blob
, Clob
or NClob
objects created by the ResultSet
. Blob
, Clob
or NClob
objects remain valid for at least the duration of the transaction in which they are creataed, unless their free
method is invoked.
When a ResultSet
is closed, any ResultSetMetaData
instances that were created by calling the getMetaData
method remain accessible.
Note: A ResultSet
object is automatically closed by the Statement
object that generated it when that Statement
object is closed, re-executed, or is used to retrieve the next result from a sequence of multiple results.
Calling the method close
on a ResultSet
object that is already closed is a no-op.
Throws | |
---|---|
SQLException | if a database access error occurs |
deleteRow
public abstract void deleteRow ()
Deletes the current row from this ResultSet
object and from the underlying database. This method cannot be called when the cursor is on the insert row.
Throws | |
---|---|
SQLException | if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY ; this method is called on a closed result set or if this method is called when the cursor is on the insert row |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
findColumn
public abstract int findColumn (String columnLabel)
Maps the given ResultSet
column label to its ResultSet
column index.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
Returns | |
---|---|
int | the column index of the given column name |
Throws | |
---|---|
SQLException | if the ResultSet object does not contain a column labeled columnLabel , a database access error occurs or this method is called on a closed result set |
first
public abstract boolean first ()
Moves the cursor to the first row in this ResultSet
object.
Returns | |
---|---|
boolean | true if the cursor is on a valid row; false if there are no rows in the result set |
Throws | |
---|---|
SQLException | if a database access error occurs; this method is called on a closed result set or the result set type is TYPE_FORWARD_ONLY |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
getArray
public abstract Array getArray (int columnIndex)
Retrieves the value of the designated column in the current row of this ResultSet
object as an Array
object in the Java programming language.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
Returns | |
---|---|
Array | an Array object representing the SQL ARRAY value in the specified column |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
getArray
public abstract Array getArray (String columnLabel)
Retrieves the value of the designated column in the current row of this ResultSet
object as an Array
object in the Java programming language.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
Returns | |
---|---|
Array | an Array object representing the SQL ARRAY value in the specified column |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
getAsciiStream
public abstract InputStream getAsciiStream (int columnIndex)
Retrieves the value of the designated column in the current row of this ResultSet
object as a stream of ASCII characters. The value can then be read in chunks from the stream. This method is particularly suitable for retrieving large LONGVARCHAR
values. The JDBC driver will do any necessary conversion from the database format into ASCII.
Note: All the data in the returned stream must be read prior to getting the value of any other column. The next call to a getter method implicitly closes the stream. Also, a stream may return 0
when the method InputStream.available
is called whether there is data available or not.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
Returns | |
---|---|
InputStream | a Java input stream that delivers the database column value as a stream of one-byte ASCII characters; if the value is SQL NULL , the value returned is null |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set |
getAsciiStream
public abstract InputStream getAsciiStream (String columnLabel)
Retrieves the value of the designated column in the current row of this ResultSet
object as a stream of ASCII characters. The value can then be read in chunks from the stream. This method is particularly suitable for retrieving large LONGVARCHAR
values. The JDBC driver will do any necessary conversion from the database format into ASCII.
Note: All the data in the returned stream must be read prior to getting the value of any other column. The next call to a getter method implicitly closes the stream. Also, a stream may return 0
when the method available
is called whether there is data available or not.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
Returns | |
---|---|
InputStream | a Java input stream that delivers the database column value as a stream of one-byte ASCII characters. If the value is SQL NULL , the value returned is null . |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set |
getBigDecimal
public abstract BigDecimal getBigDecimal (String columnLabel)
Retrieves the value of the designated column in the current row of this ResultSet
object as a java.math.BigDecimal
with full precision.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
Returns | |
---|---|
BigDecimal | the column value (full precision); if the value is SQL NULL , the value returned is null in the Java programming language. |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set |
getBigDecimal
public abstract BigDecimal getBigDecimal (String columnLabel, int scale)
This method was deprecated in API level 15.
Use getBigDecimal(int columnIndex)
or getBigDecimal(String columnLabel)
Retrieves the value of the designated column in the current row of this ResultSet
object as a java.math.BigDecimal
in the Java programming language.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
scale | int : the number of digits to the right of the decimal point |
Returns | |
---|---|
BigDecimal | the column value; if the value is SQL NULL , the value returned is null |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
getBigDecimal
public abstract BigDecimal getBigDecimal (int columnIndex, int scale)
This method was deprecated in API level 15.
Use getBigDecimal(int columnIndex)
or getBigDecimal(String columnLabel)
Retrieves the value of the designated column in the current row of this ResultSet
object as a java.sql.BigDecimal
in the Java programming language.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
scale | int : the number of digits to the right of the decimal point |
Returns | |
---|---|
BigDecimal | the column value; if the value is SQL NULL , the value returned is null |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
getBigDecimal
public abstract BigDecimal getBigDecimal (int columnIndex)
Retrieves the value of the designated column in the current row of this ResultSet
object as a java.math.BigDecimal
with full precision.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
Returns | |
---|---|
BigDecimal | the column value (full precision); if the value is SQL NULL , the value returned is null in the Java programming language. |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set |
getBinaryStream
public abstract InputStream getBinaryStream (String columnLabel)
Retrieves the value of the designated column in the current row of this ResultSet
object as a stream of uninterpreted byte
s. The value can then be read in chunks from the stream. This method is particularly suitable for retrieving large LONGVARBINARY
values.
Note: All the data in the returned stream must be read prior to getting the value of any other column. The next call to a getter method implicitly closes the stream. Also, a stream may return 0
when the method available
is called whether there is data available or not.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
Returns | |
---|---|
InputStream | a Java input stream that delivers the database column value as a stream of uninterpreted bytes; if the value is SQL NULL , the result is null |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set |
getBinaryStream
public abstract InputStream getBinaryStream (int columnIndex)
Retrieves the value of the designated column in the current row of this ResultSet
object as a stream of uninterpreted bytes. The value can then be read in chunks from the stream. This method is particularly suitable for retrieving large LONGVARBINARY
values.
Note: All the data in the returned stream must be read prior to getting the value of any other column. The next call to a getter method implicitly closes the stream. Also, a stream may return 0
when the method InputStream.available
is called whether there is data available or not.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
Returns | |
---|---|
InputStream | a Java input stream that delivers the database column value as a stream of uninterpreted bytes; if the value is SQL NULL , the value returned is null |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set |
getBlob
public abstract Blob getBlob (int columnIndex)
Retrieves the value of the designated column in the current row of this ResultSet
object as a Blob
object in the Java programming language.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
Returns | |
---|---|
Blob | a Blob object representing the SQL BLOB value in the specified column |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
getBlob
public abstract Blob getBlob (String columnLabel)
Retrieves the value of the designated column in the current row of this ResultSet
object as a Blob
object in the Java programming language.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
Returns | |
---|---|
Blob | a Blob object representing the SQL BLOB value in the specified column |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
getBoolean
public abstract boolean getBoolean (String columnLabel)
Retrieves the value of the designated column in the current row of this ResultSet
object as a boolean
in the Java programming language.
If the designated column has a datatype of CHAR or VARCHAR and contains a "0" or has a datatype of BIT, TINYINT, SMALLINT, INTEGER or BIGINT and contains a 0, a value of false
is returned. If the designated column has a datatype of CHAR or VARCHAR and contains a "1" or has a datatype of BIT, TINYINT, SMALLINT, INTEGER or BIGINT and contains a 1, a value of true
is returned.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
Returns | |
---|---|
boolean | the column value; if the value is SQL NULL , the value returned is false |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set |
getBoolean
public abstract boolean getBoolean (int columnIndex)
Retrieves the value of the designated column in the current row of this ResultSet
object as a boolean
in the Java programming language.
If the designated column has a datatype of CHAR or VARCHAR and contains a "0" or has a datatype of BIT, TINYINT, SMALLINT, INTEGER or BIGINT and contains a 0, a value of false
is returned. If the designated column has a datatype of CHAR or VARCHAR and contains a "1" or has a datatype of BIT, TINYINT, SMALLINT, INTEGER or BIGINT and contains a 1, a value of true
is returned.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
Returns | |
---|---|
boolean | the column value; if the value is SQL NULL , the value returned is false |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set |
getByte
public abstract byte getByte (String columnLabel)
Retrieves the value of the designated column in the current row of this ResultSet
object as a byte
in the Java programming language.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
Returns | |
---|---|
byte | the column value; if the value is SQL NULL , the value returned is 0 |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set |
getByte
public abstract byte getByte (int columnIndex)
Retrieves the value of the designated column in the current row of this ResultSet
object as a byte
in the Java programming language.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
Returns | |
---|---|
byte | the column value; if the value is SQL NULL , the value returned is 0 |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set |
getBytes
public abstract byte[] getBytes (String columnLabel)
Retrieves the value of the designated column in the current row of this ResultSet
object as a byte
array in the Java programming language. The bytes represent the raw values returned by the driver.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
Returns | |
---|---|
byte[] | the column value; if the value is SQL NULL , the value returned is null |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set |
getBytes
public abstract byte[] getBytes (int columnIndex)
Retrieves the value of the designated column in the current row of this ResultSet
object as a byte
array in the Java programming language. The bytes represent the raw values returned by the driver.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
Returns | |
---|---|
byte[] | the column value; if the value is SQL NULL , the value returned is null |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set |
getCharacterStream
public abstract Reader getCharacterStream (int columnIndex)
Retrieves the value of the designated column in the current row of this ResultSet
object as a java.io.Reader
object.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
Returns | |
---|---|
Reader | a java.io.Reader object that contains the column value; if the value is SQL NULL , the value returned is null in the Java programming language. |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set |
getCharacterStream
public abstract Reader getCharacterStream (String columnLabel)
Retrieves the value of the designated column in the current row of this ResultSet
object as a java.io.Reader
object.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
Returns | |
---|---|
Reader | a java.io.Reader object that contains the column value; if the value is SQL NULL , the value returned is null in the Java programming language |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set |
getClob
public abstract Clob getClob (int columnIndex)
Retrieves the value of the designated column in the current row of this ResultSet
object as a Clob
object in the Java programming language.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
Returns | |
---|---|
Clob | a Clob object representing the SQL CLOB value in the specified column |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
getClob
public abstract Clob getClob (String columnLabel)
Retrieves the value of the designated column in the current row of this ResultSet
object as a Clob
object in the Java programming language.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
Returns | |
---|---|
Clob | a Clob object representing the SQL CLOB value in the specified column |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
getConcurrency
public abstract int getConcurrency ()
Retrieves the concurrency mode of this ResultSet
object. The concurrency used is determined by the Statement
object that created the result set.
Returns | |
---|---|
int | the concurrency type, either ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE |
Throws | |
---|---|
SQLException | if a database access error occurs or this method is called on a closed result set |
getCursorName
public abstract String getCursorName ()
Retrieves the name of the SQL cursor used by this ResultSet
object.
In SQL, a result table is retrieved through a cursor that is named. The current row of a result set can be updated or deleted using a positioned update/delete statement that references the cursor name. To insure that the cursor has the proper isolation level to support update, the cursor's SELECT
statement should be of the form SELECT FOR UPDATE
. If FOR UPDATE
is omitted, the positioned updates may fail.
The JDBC API supports this SQL feature by providing the name of the SQL cursor used by a ResultSet
object. The current row of a ResultSet
object is also the current row of this SQL cursor.
Returns | |
---|---|
String | the SQL name for this ResultSet object's cursor |
Throws | |
---|---|
SQLException | if a database access error occurs or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
getDate
public abstract Date getDate (int columnIndex)
Retrieves the value of the designated column in the current row of this ResultSet
object as a java.sql.Date
object in the Java programming language.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
Returns | |
---|---|
Date | the column value; if the value is SQL NULL , the value returned is null |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set |
getDate
public abstract Date getDate (String columnLabel)
Retrieves the value of the designated column in the current row of this ResultSet
object as a java.sql.Date
object in the Java programming language.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
Returns | |
---|---|
Date | the column value; if the value is SQL NULL , the value returned is null |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set |
getDate
public abstract Date getDate (String columnLabel, Calendar cal)
Retrieves the value of the designated column in the current row of this ResultSet
object as a java.sql.Date
object in the Java programming language. This method uses the given calendar to construct an appropriate millisecond value for the date if the underlying database does not store timezone information.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
cal | Calendar : the java.util.Calendar object to use in constructing the date |
Returns | |
---|---|
Date | the column value as a java.sql.Date object; if the value is SQL NULL , the value returned is null in the Java programming language |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set |
getDate
public abstract Date getDate (int columnIndex, Calendar cal)
Retrieves the value of the designated column in the current row of this ResultSet
object as a java.sql.Date
object in the Java programming language. This method uses the given calendar to construct an appropriate millisecond value for the date if the underlying database does not store timezone information.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
cal | Calendar : the java.util.Calendar object to use in constructing the date |
Returns | |
---|---|
Date | the column value as a java.sql.Date object; if the value is SQL NULL , the value returned is null in the Java programming language |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set |
getDouble
public abstract double getDouble (int columnIndex)
Retrieves the value of the designated column in the current row of this ResultSet
object as a double
in the Java programming language.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
Returns | |
---|---|
double | the column value; if the value is SQL NULL , the value returned is 0 |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set |
getDouble
public abstract double getDouble (String columnLabel)
Retrieves the value of the designated column in the current row of this ResultSet
object as a double
in the Java programming language.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
Returns | |
---|---|
double | the column value; if the value is SQL NULL , the value returned is 0 |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set |
getFetchDirection
public abstract int getFetchDirection ()
Retrieves the fetch direction for this ResultSet
object.
Returns | |
---|---|
int | the current fetch direction for this ResultSet object |
Throws | |
---|---|
SQLException | if a database access error occurs or this method is called on a closed result set |
See also:
getFetchSize
public abstract int getFetchSize ()
Retrieves the fetch size for this ResultSet
object.
Returns | |
---|---|
int | the current fetch size for this ResultSet object |
Throws | |
---|---|
SQLException | if a database access error occurs or this method is called on a closed result set |
See also:
getFloat
public abstract float getFloat (String columnLabel)
Retrieves the value of the designated column in the current row of this ResultSet
object as a float
in the Java programming language.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
Returns | |
---|---|
float | the column value; if the value is SQL NULL , the value returned is 0 |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set |
getFloat
public abstract float getFloat (int columnIndex)
Retrieves the value of the designated column in the current row of this ResultSet
object as a float
in the Java programming language.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
Returns | |
---|---|
float | the column value; if the value is SQL NULL , the value returned is 0 |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set |
getHoldability
public abstract int getHoldability ()
Retrieves the holdability of this ResultSet
object
Returns | |
---|---|
int | either ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT |
Throws | |
---|---|
SQLException | if a database access error occurs or this method is called on a closed result set |
getInt
public abstract int getInt (int columnIndex)
Retrieves the value of the designated column in the current row of this ResultSet
object as an int
in the Java programming language.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
Returns | |
---|---|
int | the column value; if the value is SQL NULL , the value returned is 0 |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set |
getInt
public abstract int getInt (String columnLabel)
Retrieves the value of the designated column in the current row of this ResultSet
object as an int
in the Java programming language.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
Returns | |
---|---|
int | the column value; if the value is SQL NULL , the value returned is 0 |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set |
getLong
public abstract long getLong (String columnLabel)
Retrieves the value of the designated column in the current row of this ResultSet
object as a long
in the Java programming language.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
Returns | |
---|---|
long | the column value; if the value is SQL NULL , the value returned is 0 |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set |
getLong
public abstract long getLong (int columnIndex)
Retrieves the value of the designated column in the current row of this ResultSet
object as a long
in the Java programming language.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
Returns | |
---|---|
long | the column value; if the value is SQL NULL , the value returned is 0 |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set |
getMetaData
public abstract ResultSetMetaData getMetaData ()
Retrieves the number, types and properties of this ResultSet
object's columns.
Returns | |
---|---|
ResultSetMetaData | the description of this ResultSet object's columns |
Throws | |
---|---|
SQLException | if a database access error occurs or this method is called on a closed result set |
getNCharacterStream
public abstract Reader getNCharacterStream (int columnIndex)
Retrieves the value of the designated column in the current row of this ResultSet
object as a java.io.Reader
object. It is intended for use when accessing NCHAR
,NVARCHAR
and LONGNVARCHAR
columns.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
Returns | |
---|---|
Reader | a java.io.Reader object that contains the column value; if the value is SQL NULL , the value returned is null in the Java programming language. |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
getNCharacterStream
public abstract Reader getNCharacterStream (String columnLabel)
Retrieves the value of the designated column in the current row of this ResultSet
object as a java.io.Reader
object. It is intended for use when accessing NCHAR
,NVARCHAR
and LONGNVARCHAR
columns.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
Returns | |
---|---|
Reader | a java.io.Reader object that contains the column value; if the value is SQL NULL , the value returned is null in the Java programming language |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
getNClob
public abstract NClob getNClob (String columnLabel)
Retrieves the value of the designated column in the current row of this ResultSet
object as a NClob
object in the Java programming language.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
Returns | |
---|---|
NClob | a NClob object representing the SQL NCLOB value in the specified column |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; this method is called on a closed result set or if a database access error occurs |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
getNClob
public abstract NClob getNClob (int columnIndex)
Retrieves the value of the designated column in the current row of this ResultSet
object as a NClob
object in the Java programming language.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
Returns | |
---|---|
NClob | a NClob object representing the SQL NCLOB value in the specified column |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; this method is called on a closed result set or if a database access error occurs |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
getNString
public abstract String getNString (String columnLabel)
Retrieves the value of the designated column in the current row of this ResultSet
object as a String
in the Java programming language. It is intended for use when accessing NCHAR
,NVARCHAR
and LONGNVARCHAR
columns.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
Returns | |
---|---|
String | the column value; if the value is SQL NULL , the value returned is null |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
getNString
public abstract String getNString (int columnIndex)
Retrieves the value of the designated column in the current row of this ResultSet
object as a String
in the Java programming language. It is intended for use when accessing NCHAR
,NVARCHAR
and LONGNVARCHAR
columns.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
Returns | |
---|---|
String | the column value; if the value is SQL NULL , the value returned is null |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
getObject
public abstract Object getObject (String columnLabel, Map<String, Class<?>> map)
Retrieves the value of the designated column in the current row of this ResultSet
object as an Object
in the Java programming language. If the value is an SQL NULL
, the driver returns a Java null
. This method uses the specified Map
object for custom mapping if appropriate.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
map | Map : a java.util.Map object that contains the mapping from SQL type names to classes in the Java programming language |
Returns | |
---|---|
Object | an Object representing the SQL value in the specified column |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
getObject
public abstract Object getObject (int columnIndex, Map<String, Class<?>> map)
Retrieves the value of the designated column in the current row of this ResultSet
object as an Object
in the Java programming language. If the value is an SQL NULL
, the driver returns a Java null
. This method uses the given Map
object for the custom mapping of the SQL structured or distinct type that is being retrieved.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
map | Map : a java.util.Map object that contains the mapping from SQL type names to classes in the Java programming language |
Returns | |
---|---|
Object | an Object in the Java programming language representing the SQL value |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
getObject
public abstract Object getObject (int columnIndex)
Gets the value of the designated column in the current row of this ResultSet
object as an Object
in the Java programming language.
This method will return the value of the given column as a Java object. The type of the Java object will be the default Java object type corresponding to the column's SQL type, following the mapping for built-in types specified in the JDBC specification. If the value is an SQL NULL
, the driver returns a Java null
.
This method may also be used to read database-specific abstract data types. In the JDBC 2.0 API, the behavior of method getObject
is extended to materialize data of SQL user-defined types.
If Connection.getTypeMap
does not throw a SQLFeatureNotSupportedException
, then when a column contains a structured or distinct value, the behavior of this method is as if it were a call to: getObject(columnIndex, this.getStatement().getConnection().getTypeMap())
. If Connection.getTypeMap
does throw a SQLFeatureNotSupportedException
, then structured values are not supported, and distinct values are mapped to the default Java class as determined by the underlying SQL type of the DISTINCT type.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
Returns | |
---|---|
Object | a java.lang.Object holding the column value |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set |
getObject
public abstract Object getObject (String columnLabel)
Gets the value of the designated column in the current row of this ResultSet
object as an Object
in the Java programming language.
This method will return the value of the given column as a Java object. The type of the Java object will be the default Java object type corresponding to the column's SQL type, following the mapping for built-in types specified in the JDBC specification. If the value is an SQL NULL
, the driver returns a Java null
.
This method may also be used to read database-specific abstract data types.
In the JDBC 2.0 API, the behavior of the method getObject
is extended to materialize data of SQL user-defined types. When a column contains a structured or distinct value, the behavior of this method is as if it were a call to: getObject(columnIndex, this.getStatement().getConnection().getTypeMap())
.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
Returns | |
---|---|
Object | a java.lang.Object holding the column value |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set |
getRef
public abstract Ref getRef (int columnIndex)
Retrieves the value of the designated column in the current row of this ResultSet
object as a Ref
object in the Java programming language.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
Returns | |
---|---|
Ref | a Ref object representing an SQL REF value |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
getRef
public abstract Ref getRef (String columnLabel)
Retrieves the value of the designated column in the current row of this ResultSet
object as a Ref
object in the Java programming language.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
Returns | |
---|---|
Ref | a Ref object representing the SQL REF value in the specified column |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
getRow
public abstract int getRow ()
Retrieves the current row number. The first row is number 1, the second number 2, and so on.
Note:Support for the getRow
method is optional for ResultSet
s with a result set type of TYPE_FORWARD_ONLY
Returns | |
---|---|
int | the current row number; 0 if there is no current row |
Throws | |
---|---|
SQLException | if a database access error occurs or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
getRowId
public abstract RowId getRowId (int columnIndex)
Retrieves the value of the designated column in the current row of this ResultSet
object as a java.sql.RowId
object in the Java programming language.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second 2, ... |
Returns | |
---|---|
RowId | the column value; if the value is a SQL NULL the value returned is null |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
getRowId
public abstract RowId getRowId (String columnLabel)
Retrieves the value of the designated column in the current row of this ResultSet
object as a java.sql.RowId
object in the Java programming language.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
Returns | |
---|---|
RowId | the column value ; if the value is a SQL NULL the value returned is null |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
getSQLXML
public abstract SQLXML getSQLXML (String columnLabel)
Retrieves the value of the designated column in the current row of this ResultSet
as a java.sql.SQLXML
object in the Java programming language.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
Returns | |
---|---|
SQLXML | a SQLXML object that maps an SQL XML value |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
getSQLXML
public abstract SQLXML getSQLXML (int columnIndex)
Retrieves the value of the designated column in the current row of this ResultSet
as a java.sql.SQLXML
object in the Java programming language.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
Returns | |
---|---|
SQLXML | a SQLXML object that maps an SQL XML value |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
getShort
public abstract short getShort (String columnLabel)
Retrieves the value of the designated column in the current row of this ResultSet
object as a short
in the Java programming language.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
Returns | |
---|---|
short | the column value; if the value is SQL NULL , the value returned is 0 |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set |
getShort
public abstract short getShort (int columnIndex)
Retrieves the value of the designated column in the current row of this ResultSet
object as a short
in the Java programming language.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
Returns | |
---|---|
short | the column value; if the value is SQL NULL , the value returned is 0 |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set |
getStatement
public abstract Statement getStatement ()
Retrieves the Statement
object that produced this ResultSet
object. If the result set was generated some other way, such as by a DatabaseMetaData
method, this method may return null
.
Returns | |
---|---|
Statement | the Statment object that produced this ResultSet object or null if the result set was produced some other way |
Throws | |
---|---|
SQLException | if a database access error occurs or this method is called on a closed result set |
getString
public abstract String getString (int columnIndex)
Retrieves the value of the designated column in the current row of this ResultSet
object as a String
in the Java programming language.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
Returns | |
---|---|
String | the column value; if the value is SQL NULL , the value returned is null |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set |
getString
public abstract String getString (String columnLabel)
Retrieves the value of the designated column in the current row of this ResultSet
object as a String
in the Java programming language.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
Returns | |
---|---|
String | the column value; if the value is SQL NULL , the value returned is null |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set |
getTime
public abstract Time getTime (String columnLabel)
Retrieves the value of the designated column in the current row of this ResultSet
object as a java.sql.Time
object in the Java programming language.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
Returns | |
---|---|
Time | the column value; if the value is SQL NULL , the value returned is null |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set |
getTime
public abstract Time getTime (String columnLabel, Calendar cal)
Retrieves the value of the designated column in the current row of this ResultSet
object as a java.sql.Time
object in the Java programming language. This method uses the given calendar to construct an appropriate millisecond value for the time if the underlying database does not store timezone information.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
cal | Calendar : the java.util.Calendar object to use in constructing the time |
Returns | |
---|---|
Time | the column value as a java.sql.Time object; if the value is SQL NULL , the value returned is null in the Java programming language |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set |
getTime
public abstract Time getTime (int columnIndex)
Retrieves the value of the designated column in the current row of this ResultSet
object as a java.sql.Time
object in the Java programming language.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
Returns | |
---|---|
Time | the column value; if the value is SQL NULL , the value returned is null |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set |
getTime
public abstract Time getTime (int columnIndex, Calendar cal)
Retrieves the value of the designated column in the current row of this ResultSet
object as a java.sql.Time
object in the Java programming language. This method uses the given calendar to construct an appropriate millisecond value for the time if the underlying database does not store timezone information.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
cal | Calendar : the java.util.Calendar object to use in constructing the time |
Returns | |
---|---|
Time | the column value as a java.sql.Time object; if the value is SQL NULL , the value returned is null in the Java programming language |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set |
getTimestamp
public abstract Timestamp getTimestamp (int columnIndex, Calendar cal)
Retrieves the value of the designated column in the current row of this ResultSet
object as a java.sql.Timestamp
object in the Java programming language. This method uses the given calendar to construct an appropriate millisecond value for the timestamp if the underlying database does not store timezone information.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
cal | Calendar : the java.util.Calendar object to use in constructing the timestamp |
Returns | |
---|---|
Timestamp | the column value as a java.sql.Timestamp object; if the value is SQL NULL , the value returned is null in the Java programming language |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set |
getTimestamp
public abstract Timestamp getTimestamp (int columnIndex)
Retrieves the value of the designated column in the current row of this ResultSet
object as a java.sql.Timestamp
object in the Java programming language.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
Returns | |
---|---|
Timestamp | the column value; if the value is SQL NULL , the value returned is null |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set |
getTimestamp
public abstract Timestamp getTimestamp (String columnLabel, Calendar cal)
Retrieves the value of the designated column in the current row of this ResultSet
object as a java.sql.Timestamp
object in the Java programming language. This method uses the given calendar to construct an appropriate millisecond value for the timestamp if the underlying database does not store timezone information.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
cal | Calendar : the java.util.Calendar object to use in constructing the date |
Returns | |
---|---|
Timestamp | the column value as a java.sql.Timestamp object; if the value is SQL NULL , the value returned is null in the Java programming language |
Throws | |
---|---|
SQLException | if the columnLabel is not valid or if a database access error occurs or this method is called on a closed result set |
getTimestamp
public abstract Timestamp getTimestamp (String columnLabel)
Retrieves the value of the designated column in the current row of this ResultSet
object as a java.sql.Timestamp
object in the Java programming language.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
Returns | |
---|---|
Timestamp | the column value; if the value is SQL NULL , the value returned is null |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set |
getType
public abstract int getType ()
Retrieves the type of this ResultSet
object. The type is determined by the Statement
object that created the result set.
Returns | |
---|---|
int | ResultSet.TYPE_FORWARD_ONLY , ResultSet.TYPE_SCROLL_INSENSITIVE , or ResultSet.TYPE_SCROLL_SENSITIVE |
Throws | |
---|---|
SQLException | if a database access error occurs or this method is called on a closed result set |
getURL
public abstract URL getURL (int columnIndex)
Retrieves the value of the designated column in the current row of this ResultSet
object as a java.net.URL
object in the Java programming language.
Parameters | |
---|---|
columnIndex | int : the index of the column 1 is the first, 2 is the second,... |
Returns | |
---|---|
URL | the column value as a java.net.URL object; if the value is SQL NULL , the value returned is null in the Java programming language |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; this method is called on a closed result set or if a URL is malformed |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
getURL
public abstract URL getURL (String columnLabel)
Retrieves the value of the designated column in the current row of this ResultSet
object as a java.net.URL
object in the Java programming language.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
Returns | |
---|---|
URL | the column value as a java.net.URL object; if the value is SQL NULL , the value returned is null in the Java programming language |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; this method is called on a closed result set or if a URL is malformed |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
getUnicodeStream
public abstract InputStream getUnicodeStream (int columnIndex)
This method was deprecated in API level 15.
use getCharacterStream
in place of getUnicodeStream
Retrieves the value of the designated column in the current row of this ResultSet
object as as a stream of two-byte 3 characters. The first byte is the high byte; the second byte is the low byte. The value can then be read in chunks from the stream. This method is particularly suitable for retrieving large LONGVARCHAR
values. The JDBC driver will do any necessary conversion from the database format into Unicode.
Note: All the data in the returned stream must be read prior to getting the value of any other column. The next call to a getter method implicitly closes the stream. Also, a stream may return 0
when the method InputStream.available
is called, whether there is data available or not.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
Returns | |
---|---|
InputStream | a Java input stream that delivers the database column value as a stream of two-byte Unicode characters; if the value is SQL NULL , the value returned is null |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
getUnicodeStream
public abstract InputStream getUnicodeStream (String columnLabel)
This method was deprecated in API level 15.
use getCharacterStream
instead
Retrieves the value of the designated column in the current row of this ResultSet
object as a stream of two-byte Unicode characters. The first byte is the high byte; the second byte is the low byte. The value can then be read in chunks from the stream. This method is particularly suitable for retrieving large LONGVARCHAR
values. The JDBC technology-enabled driver will do any necessary conversion from the database format into Unicode.
Note: All the data in the returned stream must be read prior to getting the value of any other column. The next call to a getter method implicitly closes the stream. Also, a stream may return 0
when the method InputStream.available
is called, whether there is data available or not.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
Returns | |
---|---|
InputStream | a Java input stream that delivers the database column value as a stream of two-byte Unicode characters. If the value is SQL NULL , the value returned is null . |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
getWarnings
public abstract SQLWarning getWarnings ()
Retrieves the first warning reported by calls on this ResultSet
object. Subsequent warnings on this ResultSet
object will be chained to the SQLWarning
object that this method returns.
The warning chain is automatically cleared each time a new row is read. This method may not be called on a ResultSet
object that has been closed; doing so will cause an SQLException
to be thrown.
Note: This warning chain only covers warnings caused by ResultSet
methods. Any warning caused by Statement
methods (such as reading OUT parameters) will be chained on the Statement
object.
Returns | |
---|---|
SQLWarning | the first SQLWarning object reported or null if there are none |
Throws | |
---|---|
SQLException | if a database access error occurs or this method is called on a closed result set |
insertRow
public abstract void insertRow ()
Inserts the contents of the insert row into this ResultSet
object and into the database. The cursor must be on the insert row when this method is called.
Throws | |
---|---|
SQLException | if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY , this method is called on a closed result set, if this method is called when the cursor is not on the insert row, or if not all of non-nullable columns in the insert row have been given a non-null value |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
isAfterLast
public abstract boolean isAfterLast ()
Retrieves whether the cursor is after the last row in this ResultSet
object.
Note:Support for the isAfterLast
method is optional for ResultSet
s with a result set type of TYPE_FORWARD_ONLY
Returns | |
---|---|
boolean | true if the cursor is after the last row; false if the cursor is at any other position or the result set contains no rows |
Throws | |
---|---|
SQLException | if a database access error occurs or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
isBeforeFirst
public abstract boolean isBeforeFirst ()
Retrieves whether the cursor is before the first row in this ResultSet
object.
Note:Support for the isBeforeFirst
method is optional for ResultSet
s with a result set type of TYPE_FORWARD_ONLY
Returns | |
---|---|
boolean | true if the cursor is before the first row; false if the cursor is at any other position or the result set contains no rows |
Throws | |
---|---|
SQLException | if a database access error occurs or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
isClosed
public abstract boolean isClosed ()
Retrieves whether this ResultSet
object has been closed. A ResultSet
is closed if the method close has been called on it, or if it is automatically closed.
Returns | |
---|---|
boolean | true if this ResultSet object is closed; false if it is still open |
Throws | |
---|---|
SQLException | if a database access error occurs |
isFirst
public abstract boolean isFirst ()
Retrieves whether the cursor is on the first row of this ResultSet
object.
Note:Support for the isFirst
method is optional for ResultSet
s with a result set type of TYPE_FORWARD_ONLY
Returns | |
---|---|
boolean | true if the cursor is on the first row; false otherwise |
Throws | |
---|---|
SQLException | if a database access error occurs or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
isLast
public abstract boolean isLast ()
Retrieves whether the cursor is on the last row of this ResultSet
object. Note: Calling the method isLast
may be expensive because the JDBC driver might need to fetch ahead one row in order to determine whether the current row is the last row in the result set.
Note: Support for the isLast
method is optional for ResultSet
s with a result set type of TYPE_FORWARD_ONLY
Returns | |
---|---|
boolean | true if the cursor is on the last row; false otherwise |
Throws | |
---|---|
SQLException | if a database access error occurs or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
last
public abstract boolean last ()
Moves the cursor to the last row in this ResultSet
object.
Returns | |
---|---|
boolean | true if the cursor is on a valid row; false if there are no rows in the result set |
Throws | |
---|---|
SQLException | if a database access error occurs; this method is called on a closed result set or the result set type is TYPE_FORWARD_ONLY |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
moveToCurrentRow
public abstract void moveToCurrentRow ()
Moves the cursor to the remembered cursor position, usually the current row. This method has no effect if the cursor is not on the insert row.
Throws | |
---|---|
SQLException | if a database access error occurs; this method is called on a closed result set or the result set concurrency is CONCUR_READ_ONLY |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
moveToInsertRow
public abstract void moveToInsertRow ()
Moves the cursor to the insert row. The current cursor position is remembered while the cursor is positioned on the insert row. The insert row is a special row associated with an updatable result set. It is essentially a buffer where a new row may be constructed by calling the updater methods prior to inserting the row into the result set. Only the updater, getter, and insertRow
methods may be called when the cursor is on the insert row. All of the columns in a result set must be given a value each time this method is called before calling insertRow
. An updater method must be called before a getter method can be called on a column value.
Throws | |
---|---|
SQLException | if a database access error occurs; this method is called on a closed result set or the result set concurrency is CONCUR_READ_ONLY |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
next
public abstract boolean next ()
Moves the cursor froward one row from its current position. A ResultSet
cursor is initially positioned before the first row; the first call to the method next
makes the first row the current row; the second call makes the second row the current row, and so on.
When a call to the next
method returns false
, the cursor is positioned after the last row. Any invocation of a ResultSet
method which requires a current row will result in a SQLException
being thrown. If the result set type is TYPE_FORWARD_ONLY
, it is vendor specified whether their JDBC driver implementation will return false
or throw an SQLException
on a subsequent call to next
.
If an input stream is open for the current row, a call to the method next
will implicitly close it. A ResultSet
object's warning chain is cleared when a new row is read.
Returns | |
---|---|
boolean | true if the new current row is valid; false if there are no more rows |
Throws | |
---|---|
SQLException | if a database access error occurs or this method is called on a closed result set |
previous
public abstract boolean previous ()
Moves the cursor to the previous row in this ResultSet
object.
When a call to the previous
method returns false
, the cursor is positioned before the first row. Any invocation of a ResultSet
method which requires a current row will result in a SQLException
being thrown.
If an input stream is open for the current row, a call to the method previous
will implicitly close it. A ResultSet
object's warning change is cleared when a new row is read.
Returns | |
---|---|
boolean | true if the cursor is now positioned on a valid row; false if the cursor is positioned before the first row |
Throws | |
---|---|
SQLException | if a database access error occurs; this method is called on a closed result set or the result set type is TYPE_FORWARD_ONLY |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
refreshRow
public abstract void refreshRow ()
Refreshes the current row with its most recent value in the database. This method cannot be called when the cursor is on the insert row.
The refreshRow
method provides a way for an application to explicitly tell the JDBC driver to refetch a row(s) from the database. An application may want to call refreshRow
when caching or prefetching is being done by the JDBC driver to fetch the latest value of a row from the database. The JDBC driver may actually refresh multiple rows at once if the fetch size is greater than one.
All values are refetched subject to the transaction isolation level and cursor sensitivity. If refreshRow
is called after calling an updater method, but before calling the method updateRow
, then the updates made to the row are lost. Calling the method refreshRow
frequently will likely slow performance.
Throws | |
---|---|
SQLException | if a database access error occurs; this method is called on a closed result set; the result set type is TYPE_FORWARD_ONLY or if this method is called when the cursor is on the insert row |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method or this method is not supported for the specified result set type and result set concurrency. |
relative
public abstract boolean relative (int rows)
Moves the cursor a relative number of rows, either positive or negative. Attempting to move beyond the first/last row in the result set positions the cursor before/after the the first/last row. Calling relative(0)
is valid, but does not change the cursor position.
Note: Calling the method relative(1)
is identical to calling the method next()
and calling the method relative(-1)
is identical to calling the method previous()
.
Parameters | |
---|---|
rows | int : an int specifying the number of rows to move from the current row; a positive number moves the cursor forward; a negative number moves the cursor backward |
Returns | |
---|---|
boolean | true if the cursor is on a row; false otherwise |
Throws | |
---|---|
SQLException | if a database access error occurs; this method is called on a closed result set or the result set type is TYPE_FORWARD_ONLY |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
rowDeleted
public abstract boolean rowDeleted ()
Retrieves whether a row has been deleted. A deleted row may leave a visible "hole" in a result set. This method can be used to detect holes in a result set. The value returned depends on whether or not this ResultSet
object can detect deletions.
Note: Support for the rowDeleted
method is optional with a result set concurrency of CONCUR_READ_ONLY
Returns | |
---|---|
boolean | true if the current row is detected to have been deleted by the owner or another; false otherwise |
Throws | |
---|---|
SQLException | if a database access error occurs or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
See also:
rowInserted
public abstract boolean rowInserted ()
Retrieves whether the current row has had an insertion. The value returned depends on whether or not this ResultSet
object can detect visible inserts.
Note: Support for the rowInserted
method is optional with a result set concurrency of CONCUR_READ_ONLY
Returns | |
---|---|
boolean | true if the current row is detected to have been inserted; false otherwise |
Throws | |
---|---|
SQLException | if a database access error occurs or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
See also:
rowUpdated
public abstract boolean rowUpdated ()
Retrieves whether the current row has been updated. The value returned depends on whether or not the result set can detect updates.
Note: Support for the rowUpdated
method is optional with a result set concurrency of CONCUR_READ_ONLY
Returns | |
---|---|
boolean | true if the current row is detected to have been visibly updated by the owner or another; false otherwise |
Throws | |
---|---|
SQLException | if a database access error occurs or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
See also:
setFetchDirection
public abstract void setFetchDirection (int direction)
Gives a hint as to the direction in which the rows in this ResultSet
object will be processed. The initial value is determined by the Statement
object that produced this ResultSet
object. The fetch direction may be changed at any time.
Parameters | |
---|---|
direction | int : an int specifying the suggested fetch direction; one of ResultSet.FETCH_FORWARD , ResultSet.FETCH_REVERSE , or ResultSet.FETCH_UNKNOWN |
Throws | |
---|---|
SQLException | if a database access error occurs; this method is called on a closed result set or the result set type is TYPE_FORWARD_ONLY and the fetch direction is not FETCH_FORWARD |
setFetchSize
public abstract void setFetchSize (int rows)
Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed for this ResultSet
object. If the fetch size specified is zero, the JDBC driver ignores the value and is free to make its own best guess as to what the fetch size should be. The default value is set by the Statement
object that created the result set. The fetch size may be changed at any time.
Parameters | |
---|---|
rows | int : the number of rows to fetch |
Throws | |
---|---|
SQLException | if a database access error occurs; this method is called on a closed result set or the condition rows >= 0 is not satisfied |
See also:
updateArray
public abstract void updateArray (String columnLabel, Array x)
Updates the designated column with a java.sql.Array
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
x | Array : the new column value |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateArray
public abstract void updateArray (int columnIndex, Array x)
Updates the designated column with a java.sql.Array
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
x | Array : the new column value |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateAsciiStream
public abstract void updateAsciiStream (int columnIndex, InputStream x)
Updates the designated column with an ascii stream value. The data will be read from the stream as needed until end-of-stream is reached.
The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of updateAsciiStream
which takes a length parameter.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
x | InputStream : the new column value |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateAsciiStream
public abstract void updateAsciiStream (int columnIndex, InputStream x, long length)
Updates the designated column with an ascii stream value, which will have the specified number of bytes.
The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
x | InputStream : the new column value |
length | long : the length of the stream |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateAsciiStream
public abstract void updateAsciiStream (String columnLabel, InputStream x, long length)
Updates the designated column with an ascii stream value, which will have the specified number of bytes.
The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
x | InputStream : the new column value |
length | long : the length of the stream |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateAsciiStream
public abstract void updateAsciiStream (String columnLabel, InputStream x)
Updates the designated column with an ascii stream value. The data will be read from the stream as needed until end-of-stream is reached.
The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of updateAsciiStream
which takes a length parameter.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
x | InputStream : the new column value |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateAsciiStream
public abstract void updateAsciiStream (int columnIndex, InputStream x, int length)
Updates the designated column with an ascii stream value, which will have the specified number of bytes. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
x | InputStream : the new column value |
length | int : the length of the stream |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateAsciiStream
public abstract void updateAsciiStream (String columnLabel, InputStream x, int length)
Updates the designated column with an ascii stream value, which will have the specified number of bytes. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
x | InputStream : the new column value |
length | int : the length of the stream |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateBigDecimal
public abstract void updateBigDecimal (int columnIndex, BigDecimal x)
Updates the designated column with a java.math.BigDecimal
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
x | BigDecimal : the new column value |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateBigDecimal
public abstract void updateBigDecimal (String columnLabel, BigDecimal x)
Updates the designated column with a java.sql.BigDecimal
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
x | BigDecimal : the new column value |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateBinaryStream
public abstract void updateBinaryStream (int columnIndex, InputStream x, int length)
Updates the designated column with a binary stream value, which will have the specified number of bytes. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
x | InputStream : the new column value |
length | int : the length of the stream |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateBinaryStream
public abstract void updateBinaryStream (int columnIndex, InputStream x)
Updates the designated column with a binary stream value. The data will be read from the stream as needed until end-of-stream is reached.
The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of updateBinaryStream
which takes a length parameter.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
x | InputStream : the new column value |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateBinaryStream
public abstract void updateBinaryStream (String columnLabel, InputStream x, long length)
Updates the designated column with a binary stream value, which will have the specified number of bytes.
The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
x | InputStream : the new column value |
length | long : the length of the stream |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateBinaryStream
public abstract void updateBinaryStream (String columnLabel, InputStream x)
Updates the designated column with a binary stream value. The data will be read from the stream as needed until end-of-stream is reached.
The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of updateBinaryStream
which takes a length parameter.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
x | InputStream : the new column value |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateBinaryStream
public abstract void updateBinaryStream (String columnLabel, InputStream x, int length)
Updates the designated column with a binary stream value, which will have the specified number of bytes. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
x | InputStream : the new column value |
length | int : the length of the stream |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateBinaryStream
public abstract void updateBinaryStream (int columnIndex, InputStream x, long length)
Updates the designated column with a binary stream value, which will have the specified number of bytes.
The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
x | InputStream : the new column value |
length | long : the length of the stream |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateBlob
public abstract void updateBlob (String columnLabel, Blob x)
Updates the designated column with a java.sql.Blob
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
x | Blob : the new column value |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateBlob
public abstract void updateBlob (String columnLabel, InputStream inputStream)
Updates the designated column using the given input stream. The data will be read from the stream as needed until end-of-stream is reached.
The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of updateBlob
which takes a length parameter.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
inputStream | InputStream : An object that contains the data to set the parameter value to. |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateBlob
public abstract void updateBlob (int columnIndex, Blob x)
Updates the designated column with a java.sql.Blob
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
x | Blob : the new column value |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateBlob
public abstract void updateBlob (String columnLabel, InputStream inputStream, long length)
Updates the designated column using the given input stream, which will have the specified number of bytes.
The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
inputStream | InputStream : An object that contains the data to set the parameter value to. |
length | long : the number of bytes in the parameter data. |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateBlob
public abstract void updateBlob (int columnIndex, InputStream inputStream)
Updates the designated column using the given input stream. The data will be read from the stream as needed until end-of-stream is reached.
The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of updateBlob
which takes a length parameter.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
inputStream | InputStream : An object that contains the data to set the parameter value to. |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateBlob
public abstract void updateBlob (int columnIndex, InputStream inputStream, long length)
Updates the designated column using the given input stream, which will have the specified number of bytes.
The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnIndex | int : the first column is 1, 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. |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateBoolean
public abstract void updateBoolean (String columnLabel, boolean x)
Updates the designated column with a boolean
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
x | boolean : the new column value |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateBoolean
public abstract void updateBoolean (int columnIndex, boolean x)
Updates the designated column with a boolean
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
x | boolean : the new column value |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateByte
public abstract void updateByte (int columnIndex, byte x)
Updates the designated column with a byte
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
x | byte : the new column value |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateByte
public abstract void updateByte (String columnLabel, byte x)
Updates the designated column with a byte
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
x | byte : the new column value |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateBytes
public abstract void updateBytes (int columnIndex, byte[] x)
Updates the designated column with a byte
array value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
x | byte : the new column value |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateBytes
public abstract void updateBytes (String columnLabel, byte[] x)
Updates the designated column with a byte array value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
x | byte : the new column value |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateCharacterStream
public abstract void updateCharacterStream (String columnLabel, Reader reader, int length)
Updates the designated column with a character stream value, which will have the specified number of bytes. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
reader | Reader : the java.io.Reader object containing the new column value |
length | int : the length of the stream |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateCharacterStream
public abstract void updateCharacterStream (String columnLabel, Reader reader, long length)
Updates the designated column with a character stream value, which will have the specified number of bytes.
The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
reader | Reader : the java.io.Reader object containing the new column value |
length | long : the length of the stream |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateCharacterStream
public abstract void updateCharacterStream (int columnIndex, Reader x, long length)
Updates the designated column with a character stream value, which will have the specified number of bytes.
The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
x | Reader : the new column value |
length | long : the length of the stream |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateCharacterStream
public abstract void updateCharacterStream (int columnIndex, Reader x)
Updates the designated column with a character stream value. The data will be read from the stream as needed until end-of-stream is reached.
The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of updateCharacterStream
which takes a length parameter.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
x | Reader : the new column value |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateCharacterStream
public abstract void updateCharacterStream (int columnIndex, Reader x, int length)
Updates the designated column with a character stream value, which will have the specified number of bytes. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
x | Reader : the new column value |
length | int : the length of the stream |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateCharacterStream
public abstract void updateCharacterStream (String columnLabel, Reader reader)
Updates the designated column with a character stream value. The data will be read from the stream as needed until end-of-stream is reached.
The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of updateCharacterStream
which takes a length parameter.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
reader | Reader : the java.io.Reader object containing the new column value |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateClob
public abstract void updateClob (int columnIndex, Clob x)
Updates the designated column with a java.sql.Clob
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
x | Clob : the new column value |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateClob
public abstract void updateClob (String columnLabel, Reader reader)
Updates the designated column using the given Reader
object. The data will be read from the stream as needed until end-of-stream is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.
The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of updateClob
which takes a length parameter.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
reader | Reader : An object that contains the data to set the parameter value to. |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateClob
public abstract void updateClob (String columnLabel, Reader reader, long length)
Updates the designated column using 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 JDBC driver will do any necessary conversion from UNICODE to the database char format.
The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
reader | Reader : An object that contains the data to set the parameter value to. |
length | long : the number of characters in the parameter data. |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateClob
public abstract void updateClob (int columnIndex, Reader reader)
Updates the designated column using the given Reader
object. The data will be read from the stream as needed until end-of-stream is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.
The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of updateClob
which takes a length parameter.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
reader | Reader : An object that contains the data to set the parameter value to. |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateClob
public abstract void updateClob (int columnIndex, Reader reader, long length)
Updates the designated column using 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 JDBC driver will do any necessary conversion from UNICODE to the database char format.
The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
reader | Reader : An object that contains the data to set the parameter value to. |
length | long : the number of characters in the parameter data. |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateClob
public abstract void updateClob (String columnLabel, Clob x)
Updates the designated column with a java.sql.Clob
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
x | Clob : the new column value |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateDate
public abstract void updateDate (int columnIndex, Date x)
Updates the designated column with a java.sql.Date
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
x | Date : the new column value |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateDate
public abstract void updateDate (String columnLabel, Date x)
Updates the designated column with a java.sql.Date
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
x | Date : the new column value |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateDouble
public abstract void updateDouble (String columnLabel, double x)
Updates the designated column with a double
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
x | double : the new column value |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateDouble
public abstract void updateDouble (int columnIndex, double x)
Updates the designated column with a double
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
x | double : the new column value |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateFloat
public abstract void updateFloat (int columnIndex, float x)
Updates the designated column with a float
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
x | float : the new column value |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateFloat
public abstract void updateFloat (String columnLabel, float x)
Updates the designated column with a float
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
x | float : the new column value |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateInt
public abstract void updateInt (String columnLabel, int x)
Updates the designated column with an int
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
x | int : the new column value |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateInt
public abstract void updateInt (int columnIndex, int x)
Updates the designated column with an int
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
x | int : the new column value |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateLong
public abstract void updateLong (int columnIndex, long x)
Updates the designated column with a long
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
x | long : the new column value |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateLong
public abstract void updateLong (String columnLabel, long x)
Updates the designated column with a long
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
x | long : the new column value |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateNCharacterStream
public abstract void updateNCharacterStream (int columnIndex, Reader x, long length)
Updates the designated column with a character stream value, which will have the specified number of bytes. The driver does the necessary conversion from Java character format to the national character set in the database. It is intended for use when updating NCHAR
,NVARCHAR
and LONGNVARCHAR
columns.
The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
x | Reader : the new column value |
length | long : the length of the stream |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateNCharacterStream
public abstract void updateNCharacterStream (String columnLabel, Reader reader)
Updates the designated column with a character stream value. The data will be read from the stream as needed until end-of-stream is reached. The driver does the necessary conversion from Java character format to the national character set in the database. It is intended for use when updating NCHAR
,NVARCHAR
and LONGNVARCHAR
columns.
The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of updateNCharacterStream
which takes a length parameter.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
reader | Reader : the java.io.Reader object containing the new column value |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateNCharacterStream
public abstract void updateNCharacterStream (int columnIndex, Reader x)
Updates the designated column with a character stream value. The data will be read from the stream as needed until end-of-stream is reached. The driver does the necessary conversion from Java character format to the national character set in the database. It is intended for use when updating NCHAR
,NVARCHAR
and LONGNVARCHAR
columns.
The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of updateNCharacterStream
which takes a length parameter.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
x | Reader : the new column value |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateNCharacterStream
public abstract void updateNCharacterStream (String columnLabel, Reader reader, long length)
Updates the designated column with a character stream value, which will have the specified number of bytes. The driver does the necessary conversion from Java character format to the national character set in the database. It is intended for use when updating NCHAR
,NVARCHAR
and LONGNVARCHAR
columns.
The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
reader | Reader : the java.io.Reader object containing the new column value |
length | long : the length of the stream |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateNClob
public abstract void updateNClob (int columnIndex, Reader reader, long length)
Updates the designated column using 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 JDBC driver will do any necessary conversion from UNICODE to the database char format.
The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second 2, ... |
reader | Reader : An object that contains the data to set the parameter value to. |
length | long : the number of characters in the parameter data. |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; this method is called on a closed result set, if a database access error occurs or the result set concurrency is CONCUR_READ_ONLY |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateNClob
public abstract void updateNClob (int columnIndex, NClob nClob)
Updates the designated column with a java.sql.NClob
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second 2, ... |
nClob | NClob : the value for the column to be updated |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; this method is called on a closed result set; if a database access error occurs or the result set concurrency is CONCUR_READ_ONLY |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateNClob
public abstract void updateNClob (String columnLabel, NClob nClob)
Updates the designated column with a java.sql.NClob
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
nClob | NClob : the value for the column to be updated |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; this method is called on a closed result set; if a database access error occurs or the result set concurrency is CONCUR_READ_ONLY |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateNClob
public abstract void updateNClob (String columnLabel, Reader reader)
Updates the designated column using the given Reader
object. The data will be read from the stream as needed until end-of-stream is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.
The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of updateNClob
which takes a length parameter.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
reader | Reader : An object that contains the data to set the parameter value to. |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; this method is called on a closed result set; if a database access error occurs or the result set concurrency is CONCUR_READ_ONLY |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateNClob
public abstract void updateNClob (String columnLabel, Reader reader, long length)
Updates the designated column using 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 JDBC driver will do any necessary conversion from UNICODE to the database char format.
The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
reader | Reader : An object that contains the data to set the parameter value to. |
length | long : the number of characters in the parameter data. |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; this method is called on a closed result set; if a database access error occurs or the result set concurrency is CONCUR_READ_ONLY |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateNClob
public abstract void updateNClob (int columnIndex, Reader reader)
Updates the designated column using the given Reader
The data will be read from the stream as needed until end-of-stream is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.
The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of updateNClob
which takes a length parameter.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second 2, ... |
reader | Reader : An object that contains the data to set the parameter value to. |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; this method is called on a closed result set, if a database access error occurs or the result set concurrency is CONCUR_READ_ONLY |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateNString
public abstract void updateNString (String columnLabel, String nString)
Updates the designated column with a String
value. It is intended for use when updating NCHAR
,NVARCHAR
and LONGNVARCHAR
columns. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
nString | String : the value for the column to be updated |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; this method is called on a closed result set; the result set concurrency is CONCUR_READ_ONLY or if a database access error occurs |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateNString
public abstract void updateNString (int columnIndex, String nString)
Updates the designated column with a String
value. It is intended for use when updating NCHAR
,NVARCHAR
and LONGNVARCHAR
columns. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second 2, ... |
nString | String : the value for the column to be updated |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; this method is called on a closed result set; the result set concurrency is CONCUR_READ_ONLY or if a database access error occurs |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateNull
public abstract void updateNull (int columnIndex)
Updates the designated column with a null
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateNull
public abstract void updateNull (String columnLabel)
Updates the designated column with a null
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateObject
public abstract void updateObject (int columnIndex, Object x)
Updates the designated column with an Object
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
x | Object : the new column value |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateObject
public abstract void updateObject (int columnIndex, Object x, int scaleOrLength)
Updates the designated column with an Object
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
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 statement is executed.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
x | Object : the new column value |
scaleOrLength | int : for an object of java.math.BigDecimal , this is the number of digits after the decimal point. For Java Object types InputStream and Reader , this is the length of the data in the stream or reader. For all other types, this value will be ignored. |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateObject
public abstract void updateObject (String columnLabel, Object x, int scaleOrLength)
Updates the designated column with an Object
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
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 statement is executed.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
x | Object : the new column value |
scaleOrLength | int : for an object of java.math.BigDecimal , this is the number of digits after the decimal point. For Java Object types InputStream and Reader , this is the length of the data in the stream or reader. For all other types, this value will be ignored. |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateObject
public abstract void updateObject (String columnLabel, Object x)
Updates the designated column with an Object
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
x | Object : the new column value |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateRef
public abstract void updateRef (int columnIndex, Ref x)
Updates the designated column with a java.sql.Ref
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
x | Ref : the new column value |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateRef
public abstract void updateRef (String columnLabel, Ref x)
Updates the designated column with a java.sql.Ref
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
x | Ref : the new column value |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateRow
public abstract void updateRow ()
Updates the underlying database with the new contents of the current row of this ResultSet
object. This method cannot be called when the cursor is on the insert row.
Throws | |
---|---|
SQLException | if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY ; this method is called on a closed result set or if this method is called when the cursor is on the insert row |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateRowId
public abstract void updateRowId (int columnIndex, RowId x)
Updates the designated column with a RowId
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second 2, ... |
x | RowId : the column value |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateRowId
public abstract void updateRowId (String columnLabel, RowId x)
Updates the designated column with a RowId
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
x | RowId : the column value |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateSQLXML
public abstract void updateSQLXML (int columnIndex, SQLXML xmlObject)
Updates the designated column with a java.sql.SQLXML
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second 2, ... |
xmlObject | SQLXML : the value for the column to be updated |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; this method is called on a closed result set; the java.xml.transform.Result , Writer or OutputStream has not been closed for the SQLXML object; if there is an error processing the XML value or the result set concurrency is CONCUR_READ_ONLY . The getCause method of the exception may provide a more detailed exception, for example, if the stream does not contain valid XML. |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateSQLXML
public abstract void updateSQLXML (String columnLabel, SQLXML xmlObject)
Updates the designated column with a java.sql.SQLXML
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
xmlObject | SQLXML : the column value |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; this method is called on a closed result set; the java.xml.transform.Result , Writer or OutputStream has not been closed for the SQLXML object; if there is an error processing the XML value or the result set concurrency is CONCUR_READ_ONLY . The getCause method of the exception may provide a more detailed exception, for example, if the stream does not contain valid XML. |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateShort
public abstract void updateShort (String columnLabel, short x)
Updates the designated column with a short
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
x | short : the new column value |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateShort
public abstract void updateShort (int columnIndex, short x)
Updates the designated column with a short
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
x | short : the new column value |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateString
public abstract void updateString (String columnLabel, String x)
Updates the designated column with a String
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
x | String : the new column value |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateString
public abstract void updateString (int columnIndex, String x)
Updates the designated column with a String
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
x | String : the new column value |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateTime
public abstract void updateTime (int columnIndex, Time x)
Updates the designated column with a java.sql.Time
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
x | Time : the new column value |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateTime
public abstract void updateTime (String columnLabel, Time x)
Updates the designated column with a java.sql.Time
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
x | Time : the new column value |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateTimestamp
public abstract void updateTimestamp (String columnLabel, Timestamp x)
Updates the designated column with a java.sql.Timestamp
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnLabel | String : the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column |
x | Timestamp : the new column value |
Throws | |
---|---|
SQLException | if the columnLabel is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
updateTimestamp
public abstract void updateTimestamp (int columnIndex, Timestamp x)
Updates the designated column with a java.sql.Timestamp
value. The updater methods are used to update column values in the current row or the insert row. The updater methods do not update the underlying database; instead the updateRow
or insertRow
methods are called to update the database.
Parameters | |
---|---|
columnIndex | int : the first column is 1, the second is 2, ... |
x | Timestamp : the new column value |
Throws | |
---|---|
SQLException | if the columnIndex is not valid; if a database access error occurs; the result set concurrency is CONCUR_READ_ONLY or this method is called on a closed result set |
SQLFeatureNotSupportedException | if the JDBC driver does not support this method |
wasNull
public abstract boolean wasNull ()
Reports whether the last column read had a value of SQL NULL
. Note that you must first call one of the getter methods on a column to try to read its value and then call the method wasNull
to see if the value read was SQL NULL
.
Returns | |
---|---|
boolean | true if the last column value read was SQL NULL and false otherwise |
Throws | |
---|---|
SQLException | if a database access error occurs or this method is called on a closed result set |