is new.
All Superinterfaces:
Wrapper
public interface ResultSet
extends
WrapperA 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
The 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,
there is no way for
the programmer
should take care
to guarantee that they
uniquely
actually
refer to the intended
columns, which can be assured with the SQL
AS
clause.
columns.
A set of updater methods were added to this interface in the JDBC 2.0 API
(Java
TM
2 SDK, Standard Edition, version
(JDK
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:
rs.absolute(5); // moves the cursor to the fifth row of rs
rs.updateString("NAME", "AINSWORTH"); // updates the
// NAME column of row 5 to be AINSWORTH
rs.updateRow(); // updates the row in the data source
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 be 35
rs.updateBoolean(3, true); // updates the third column to true
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 ResulSetMetaData object returned by the ResultSet.getMetaData method.
| Field Summary | |
|---|---|
| static int |
CLOSE_CURSORS_AT_COMMIT
The constant indicating that
open
ResultSet objects
with this holdability will
current transaction
commited.
|
| static int |
CONCUR_READ_ONLY
The constant indicating the concurrency mode for a ResultSet object that may NOT be updated. |
| static int |
CONCUR_UPDATABLE
The constant indicating the concurrency mode for a ResultSet object that may be updated. |
| static int |
FETCH_FORWARD
The constant indicating that the rows in a result set will be processed in a forward direction; first-to-last. |
| static int |
FETCH_REVERSE
The constant indicating that the rows in a result set will be processed in a reverse direction; last-to-first. |
| static int |
FETCH_UNKNOWN
The constant indicating that the order in which rows in a result set will be processed is unknown. |
| static int |
HOLD_CURSORS_OVER_COMMIT
The constant indicating that
open
ResultSet objects
with this holdability will remain open
current transaction
commited.
|
| static int |
TYPE_FORWARD_ONLY
The constant indicating the type for a ResultSet object whose cursor may move only forward. |
| static 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.
|
| static 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.
|
| Method Summary | |
|---|---|
| boolean |
absolute
(int row) Moves the cursor to the given row number in this ResultSet object. |
| void |
afterLast
() Moves the cursor to the end of this ResultSet object, just after the last row. |
| void |
beforeFirst
() Moves the cursor to the front of this ResultSet object, just before the first row. |
| void |
cancelRowUpdates
() Cancels the updates made to the current row in this ResultSet object. |
| void |
clearWarnings
() Clears all warnings reported on this ResultSet object. |
| void |
close
() Releases this ResultSet object's database and JDBC resources immediately instead of waiting for this to happen when it is automatically closed. |
| void |
deleteRow
() Deletes the current row from this ResultSet object and from the underlying database. |
| int |
findColumn
(
String
columnName) Maps the given ResultSet column name to its ResultSet column index. |
| boolean |
first
() Moves the cursor to the first row in this ResultSet object. |
| 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. |
| Array |
getArray
(
String
Retrieves the value of the designated column in the current row of this ResultSet object as an Array object in the Java programming language. |
| 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. |
| InputStream |
getAsciiStream
(
String
columnName) Retrieves the value of the designated column in the current row of this ResultSet object as a stream of ASCII characters. |
| 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. |
| BigDecimal |
getBigDecimal
(int columnIndex, int scale) Deprecated. |
| BigDecimal |
getBigDecimal
(
String
columnName) Retrieves the value of the designated column in the current row of this ResultSet object as a java.math.BigDecimal with full precision. |
| BigDecimal |
getBigDecimal
(
String
columnName, int scale) Deprecated. |
| InputStream |
getBinaryStream
(int columnIndex) Retrieves the value of the designated column in the current row of this ResultSet object as a
|
| InputStream |
getBinaryStream
(
String
columnName) Retrieves the value of the designated column in the current row of this ResultSet object as a stream of uninterpreted bytes. |
| 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. |
| Blob |
getBlob
(
String
Retrieves the value of the designated column in the current row of this ResultSet object as a Blob object in the Java programming language. |
| 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. |
| boolean |
getBoolean
(
String
columnName) Retrieves the value of the designated column in the current row of this ResultSet object as a boolean in the Java programming language. |
| 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. |
| byte |
getByte
(
String
columnName) Retrieves the value of the designated column in the current row of this ResultSet object as a byte in the Java programming language. |
| 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. |
| byte[] |
getBytes
(
String
columnName) Retrieves the value of the designated column in the current row of this ResultSet object as a byte array in the Java programming language. |
| 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. |
| Reader |
getCharacterStream
(
String
columnName) Retrieves the value of the designated column in the current row of this ResultSet object as a java.io.Reader object. |
| 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. |
| Clob |
getClob
(
String
Retrieves the value of the designated column in the current row of this ResultSet object as a Clob object in the Java programming language. |
| int |
getConcurrency
() Retrieves the concurrency mode of this ResultSet object. |
| String |
getCursorName
() Retrieves the name of the SQL cursor used by this ResultSet object. |
| 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. |
| 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. |
| Date |
getDate
(
String
columnName) 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. |
| Date |
getDate
(
String
columnName,
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. |
| 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. |
| double |
getDouble
(
String
columnName) Retrieves the value of the designated column in the current row of this ResultSet object as a double in the Java programming language. |
| int |
getFetchDirection
() Retrieves the fetch direction for this ResultSet object. |
| int |
getFetchSize
() Retrieves the fetch size for this ResultSet object. |
| 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. |
| float |
getFloat
(
String
columnName) Retrieves the value of the designated column in the current row of this ResultSet object as a float in the Java programming language. |
int
|
getHoldability
()
Retrieves the holdability of this ResultSet object
|
| 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. |
| int |
getInt
(
String
columnName) Retrieves the value of the designated column in the current row of this ResultSet object as an int in the Java programming language. |
| 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. |
| long |
getLong
(
String
columnName) Retrieves the value of the designated column in the current row of this ResultSet object as a long in the Java programming language. |
| ResultSetMetaData |
getMetaData
() Retrieves the number, types and properties of this ResultSet object's columns. |
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.
|
Reader
|
getNCharacterStream
(
String
Retrieves the value of the designated column in the current row of this ResultSet object as a java.io.Reader object.
|
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.
|
NClob
|
getNClob
(
String
Retrieves the value of the designated column in the current row of this ResultSet object as a NClob object in the Java programming language.
|
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.
|
String
|
getNString
(
String
Retrieves the value of the designated column in the current row of this ResultSet object as a String in the Java programming language.
|
| 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. |
| Object |
getObject
(int columnIndex,
Retrieves the value of the designated column in the current row of this ResultSet object as an Object in the Java programming language. |
| Object |
getObject
(
String
columnName) Gets the value of the designated column in the current row of this ResultSet object as an Object in the Java programming language. |
| Object |
getObject
(
String
columnName,
Retrieves the value of the designated column in the current row of this ResultSet object as an Object in the Java programming language. |
| 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. |
| Ref |
getRef
(
String
Retrieves the value of the designated column in the current row of this ResultSet object as a Ref object in the Java programming language. |
| int |
getRow
() Retrieves the current row number. |
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.
|
RowId
|
getRowId
(
String
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.
|
| 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. |
| short |
getShort
(
String
columnName) Retrieves the value of the designated column in the current row of this ResultSet object as a short in the Java programming language. |
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.
|
SQLXML
|
getSQLXML
(
String
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.
|
| Statement |
getStatement
() Retrieves the Statement object that produced this ResultSet object. |
| 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. |
| String |
getString
(
String
columnName) Retrieves the value of the designated column in the current row of this ResultSet object as a String in the Java programming language. |
| 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. |
| 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. |
| Time |
getTime
(
String
columnName) 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. |
| Time |
getTime
(
String
columnName,
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. |
| 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. |
| 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. |
| Timestamp |
getTimestamp
(
String
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.
|
| Timestamp |
getTimestamp
(
String
columnName,
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. |
| int |
getType
() Retrieves the type of this ResultSet object. |
| InputStream |
getUnicodeStream
(int columnIndex) Deprecated. use getCharacterStream in place of getUnicodeStream |
| InputStream |
getUnicodeStream
(
String
columnName) Deprecated. use getCharacterStream instead |
| 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. |
| URL |
getURL
(
String
columnName) 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. |
| SQLWarning |
getWarnings
() Retrieves the first warning reported by calls on this ResultSet object. |
| void |
insertRow
() Inserts the contents of the insert row into this ResultSet object and into the database. |
| boolean |
isAfterLast
() Retrieves whether the cursor is after the last row in this ResultSet object. |
| boolean |
isBeforeFirst
() Retrieves whether the cursor is before the first row in this ResultSet object. |
boolean
|
isClosed
()
Retrieves whether this ResultSet object has been closed.
|
| boolean |
isFirst
() Retrieves whether the cursor is on the first row of this ResultSet object. |
| boolean |
isLast
() Retrieves whether the cursor is on the last row of this ResultSet object. |
| boolean |
last
() Moves the cursor to the last row in this ResultSet object. |
| void |
moveToCurrentRow
() Moves the cursor to the remembered cursor position, usually the current row. |
| void |
moveToInsertRow
() Moves the cursor to the insert row. |
| boolean |
next
() Moves the cursor
froward
|
| boolean |
previous
() Moves the cursor to the previous row in this ResultSet object. |
| void |
refreshRow
() Refreshes the current row with its most recent value in the database. |
| boolean |
relative
(int rows) Moves the cursor a relative number of rows, either positive or negative. |
| boolean |
rowDeleted
() Retrieves whether a row has been deleted. |
| boolean |
rowInserted
() Retrieves whether the current row has had an insertion. |
| boolean |
rowUpdated
() Retrieves whether the current row has been updated. |
| void |
setFetchDirection
(int direction) Gives a hint as to the direction in which the rows in this ResultSet object will be processed. |
| 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. |
| void |
updateArray
(int columnIndex,
Array
x) Updates the designated column with a java.sql.Array value. |
| void |
updateArray
(
String
columnName,
Array
x) Updates the designated column with a java.sql.Array value. |
| void |
updateAsciiStream
(int columnIndex,
InputStream
Updates the designated column with an ascii stream
value, which will have the specified number of bytes.
|
| void |
updateAsciiStream
(
String
columnName,
InputStream
Updates the designated column with an ascii stream
value, which will have the specified number of bytes..
|
| void |
updateBigDecimal
(int columnIndex,
BigDecimal
x) Updates the designated column with a java.math.BigDecimal value. |
| void |
updateBigDecimal
(
String
columnName,
BigDecimal
x) Updates the designated column with a java.sql.BigDecimal value. |
| void |
updateBinaryStream
(int columnIndex,
InputStream
Updates the designated column with a binary stream
value, which will have the specified number of bytes.
|
| void |
updateBinaryStream
(
String
columnName,
InputStream
Updates the designated column with a binary stream
value, which will have the specified number of bytes.
|
| void |
updateBlob
(int columnIndex,
Blob
x) Updates the designated column with a java.sql.Blob value. |
| void |
updateBlob
(
String
columnName,
Blob
x) Updates the designated column with a java.sql.Blob value. |
| void |
updateBoolean
(int columnIndex, boolean x) Updates the designated column with a boolean value. |
| void |
updateBoolean
(
String
columnName, boolean x) Updates the designated column with a boolean value. |
| void |
updateByte
(int columnIndex, byte x) Updates the designated column with a byte value. |
| void |
updateByte
(
String
columnName, byte x) Updates the designated column with a byte value. |
| void |
updateBytes
(int columnIndex, byte[] x) Updates the designated column with a byte array value. |
| void |
updateBytes
(
String
columnName, byte[] x) Updates the designated column with a byte array value. |
| void |
updateCharacterStream
(int columnIndex,
Reader
Updates the designated column with a character stream
value, which will have the specified number of bytes.
|
| void |
updateCharacterStream
(
String
columnName,
Reader
Updates the designated column with a character stream
value, which will have the specified number of bytes.
|
| void |
updateClob
(int columnIndex,
Clob
x) Updates the designated column with a java.sql.Clob value. |
| void |
updateClob
(
String
columnName,
Clob
x) Updates the designated column with a java.sql.Clob value. |
| void |
updateDate
(int columnIndex,
Date
x) Updates the designated column with a java.sql.Date value. |
| void |
updateDate
(
String
columnName,
Date
x) Updates the designated column with a java.sql.Date value. |
| void |
updateDouble
(int columnIndex, double x) Updates the designated column with a double value. |
| void |
updateDouble
(
String
columnName, double x) Updates the designated column with a double value. |
| void |
updateFloat
(int columnIndex, float x) Updates the designated column with a float value. |
| void |
updateFloat
(
String
columnName, float x) Updates the designated column with a float value. |
| void |
updateInt
(int columnIndex, int x) Updates the designated column with an int value. |
| void |
updateInt
(
String
columnName, int x) Updates the designated column with an int value. |
| void |
updateLong
(int columnIndex, long x) Updates the designated column with a long value. |
| void |
updateLong
(
String
columnName, long x) Updates the designated column with a long value. |
void
|
updateNCharacterStream
(int columnIndex,
Reader
Updates the designated column with a character stream value, which will have the specified number of bytes.
|
|
|
void
|
updateNCharacterStream
(
String
columnName,
Reader
Updates the designated column with a character stream value, which will have the specified number of bytes.
|
void
|
updateNClob
(int columnIndex,
NClob
Updates the designated column with a java.sql.NClob value.
|
void
|
updateNClob
(
String
columnName,
NClob
Updates the designated column with a java.sql.NClob value.
|
void
|
updateNString
(int columnIndex,
String
Updates the designated column with a String value.
|
void
|
updateNString
(
String
columnName,
String
Updates the designated column with a String value.
|
void
|
updateNull
(int columnIndex)
Updates the designated column with a null value.
|
| void |
updateNull
(
String
columnName) Updates the designated column with a null value. |
| void |
updateObject
(int columnIndex,
Object
x) Updates the designated column with an Object value. |
| void |
updateObject
(int columnIndex,
Object
Updates the designated column with an Object value. |
| void |
updateObject
(
String
columnName,
Object
x) Updates the designated column with an Object value. |
| void |
updateObject
(
String
columnName,
Object
Updates the designated column with an Object value. |
| void |
updateRef
(int columnIndex,
Ref
x) Updates the designated column with a java.sql.Ref value. |
| void |
updateRef
(
String
columnName,
Ref
x) Updates the designated column with a java.sql.Ref value. |
| void |
updateRow
() Updates the underlying database with the new contents of the current row of this ResultSet object. |
void
|
updateRowId
(int columnIndex,
RowId
Updates the designated column with a RowId value.
|
void
|
updateRowId
(
String
columnName,
RowId
Updates the designated column with a RowId value.
|
| void |
updateShort
(int columnIndex, short x) Updates the designated column with a short value. |
| void |
updateShort
(
String
columnName, short x) Updates the designated column with a short value. |
void
|
updateSQLXML
(int columnIndex,
SQLXML
Updates the designated column with a java.sql.SQLXML value.
|
void
|
updateSQLXML
(
String
columnName,
SQLXML
Updates the designated column with a java.sql.SQLXML value.
|
| void |
updateString
(int columnIndex,
String
x) Updates the designated column with a String value. |
| void |
updateString
(
String
columnName,
String
x) Updates the designated column with a String value. |
| void |
updateTime
(int columnIndex,
Time
x) Updates the designated column with a java.sql.Time value. |
| void |
updateTime
(
String
columnName,
Time
x) Updates the designated column with a java.sql.Time value. |
| void |
updateTimestamp
(int columnIndex,
Timestamp
x) Updates the designated column with a java.sql.Timestamp value. |
| void |
updateTimestamp
(
String
columnName,
Timestamp
x) Updates the designated column with a java.sql.Timestamp value. |
| boolean |
wasNull
() Reports whether the last column read had a value of SQL NULL. |
Methods inherited from interface java.sql.
Wrapper
|
|---|
isWrapperFor
,
unwrap
|
| Field Detail |
|---|
static final int FETCH_FORWARD
static final int FETCH_REVERSE
static final int FETCH_UNKNOWN
static final int TYPE_FORWARD_ONLY
static final int TYPE_SCROLL_INSENSITIVE
to the data that underlies the ResultSet.
static final int TYPE_SCROLL_SENSITIVE
to the data that underlies the ResultSet.
static final int CONCUR_READ_ONLY
static final int CONCUR_UPDATABLE
static final int HOLD_CURSORS_OVER_COMMIT
open
ResultSet objects
with this holdability will remain open
current transaction
commited.
static final int CLOSE_CURSORS_AT_COMMIT
open
ResultSet objects
with this holdability will
current transaction
commited.
| Method Detail |
|---|
boolean next()
throws SQLException
froward
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.
void close()
throws SQLException
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.
A ResultSet object is also automatically closed when it is garbage collected.
boolean wasNull()
throws SQLException
String getString(int columnIndex)
throws SQLException
boolean getBoolean(int columnIndex)
throws SQLException
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.
byte getByte(int columnIndex)
throws SQLException
short getShort(int columnIndex)
throws SQLException
int getInt(int columnIndex)
throws SQLException
long getLong(int columnIndex)
throws SQLException
float getFloat(int columnIndex)
throws SQLException
double getDouble(int columnIndex)
throws SQLException
@DeprecatedBigDecimalgetBigDecimal(int columnIndex, int scale) throws SQLException
byte[] getBytes(int columnIndex)
throws SQLException
Date getDate(int columnIndex)
throws SQLException
Time getTime(int columnIndex)
throws SQLException
Timestamp getTimestamp(int columnIndex)
throws SQLException
InputStream getAsciiStream(int columnIndex)
throws SQLException
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.
@DeprecatedInputStreamgetUnicodeStream(int columnIndex) throws SQLException
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.
InputStream getBinaryStream(int columnIndex)
throws SQLException
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.
String getString(String columnName)
throws SQLException
boolean getBoolean(String columnName)
throws SQLException
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.
byte getByte(String columnName)
throws SQLException
short getShort(String columnName)
throws SQLException
int getInt(String columnName)
throws SQLException
long getLong(String columnName)
throws SQLException
float getFloat(String columnName)
throws SQLException
double getDouble(String columnName)
throws SQLException
@DeprecatedBigDecimalgetBigDecimal(String columnName, int scale) throws SQLException
byte[] getBytes(String columnName)
throws SQLException
Date getDate(String columnName)
throws SQLException
Time getTime(String columnName)
throws SQLException
Timestamp getTimestamp(String columnName)
throws SQLException
object in the Java programming language.
InputStream getAsciiStream(String columnName)
throws SQLException
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.
@DeprecatedInputStreamgetUnicodeStream(String columnName) throws SQLException
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.
InputStream getBinaryStream(String columnName)
throws SQLException
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.
SQLWarning getWarnings()
throws SQLException
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.
void clearWarnings()
throws SQLException
String getCursorName()
throws SQLException
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.
Note: If positioned update is not supported, a SQLException is thrown.
ResultSetMetaData getMetaData()
throws SQLException
Object getObject(int columnIndex)
throws SQLException
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. 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()).
Object getObject(String columnName)
throws SQLException
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()).
int findColumn(String columnName)
throws SQLException
Reader getCharacterStream(int columnIndex)
throws SQLException
Reader getCharacterStream(String columnName)
throws SQLException
BigDecimal getBigDecimal(int columnIndex)
throws SQLException
BigDecimal getBigDecimal(String columnName)
throws SQLException
boolean isBeforeFirst()
throws SQLException
boolean isAfterLast()
throws SQLException
boolean isFirst()
throws SQLException
boolean isLast()
throws SQLException
void beforeFirst()
throws SQLException
void afterLast()
throws SQLException
boolean first()
throws SQLException
boolean last()
throws SQLException
int getRow()
throws SQLException
boolean absolute(int row)
throws SQLException
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.
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().
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
boolean relative(int rows)
throws SQLException
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().
boolean previous()
throws SQLException
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.
now positioned
on a valid row; false if
the cursor
positioned before
first row
void setFetchDirection(int direction)
throws SQLException
int getFetchDirection()
throws SQLException
void setFetchSize(int rows)
throws SQLException
rows >=
0
is not satisfied
int getFetchSize()
throws SQLException
int getType()
throws SQLException
int getConcurrency()
throws SQLException
boolean rowUpdated()
throws SQLException
boolean rowInserted()
throws SQLException
boolean rowDeleted()
throws SQLException
void updateNull(int columnIndex)
throws SQLException
Updates the designated
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.
void updateBoolean(int columnIndex,
boolean x)
throws SQLException
void updateByte(int columnIndex,
byte x)
throws SQLException
void updateShort(int columnIndex,
short x)
throws SQLException
void updateInt(int columnIndex,
int x)
throws SQLException
void updateLong(int columnIndex,
long x)
throws SQLException
void updateFloat(int columnIndex,
float x)
throws SQLException
void updateDouble(int columnIndex,
double x)
throws SQLException
void updateBigDecimal(int columnIndex,
BigDecimal x)
throws SQLException
void updateString(int columnIndex,
String x)
throws SQLException
void updateBytes(int columnIndex,
byte[] x)
throws SQLException
void updateDate(int columnIndex,
Date x)
throws SQLException
void updateTime(int columnIndex,
Time x)
throws SQLException
void updateTimestamp(int columnIndex,
Timestamp x)
throws SQLException
void updateAsciiStream(int columnIndex,
InputStream x,
int length)
throws SQLException
value, which will have the specified number of bytes.
void updateBinaryStream(int columnIndex,
InputStream x,
int length)
throws SQLException
value, which will have the specified number of bytes.
void updateCharacterStream(int columnIndex,
Reader x,
int length)
throws SQLException
value, which will have the specified number of bytes.
void updateObject(int columnIndex,
Object x,
int scaleOrLength)

int scale)
throws SQLException
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.
scaleOrLength
an object of java.math.BigDecimal ,
Java Object types InputStream and Reader, this is the length of the data in the stream or reader. For
all other
types,
void updateObject(int columnIndex,
Object x)
throws SQLException
void updateNull(String columnName)
throws SQLException
void updateBoolean(String columnName,
boolean x)
throws SQLException
void updateByte(String columnName,
byte x)
throws SQLException
void updateShort(String columnName,
short x)
throws SQLException
void updateInt(String columnName,
int x)
throws SQLException
void updateLong(String columnName,
long x)
throws SQLException
void updateFloat(String columnName,
float x)
throws SQLException
void updateDouble(String columnName,
double x)
throws SQLException
void updateBigDecimal(String columnName,
BigDecimal x)
throws SQLException
void updateString(String columnName,
String x)
throws SQLException
void updateBytes(String columnName,
byte[] x)
throws SQLException
void updateDate(String columnName,
Date x)
throws SQLException
void updateTime(String columnName,
Time x)
throws SQLException
void updateTimestamp(String columnName,
Timestamp x)
throws SQLException
void updateAsciiStream(String columnName,
InputStream x,
int length)
throws SQLException
value, which will have the specified number of bytes..
void updateBinaryStream(String columnName,
InputStream x,
int length)
throws SQLException
value, which will have the specified number of bytes.
void updateCharacterStream(String columnName,
Reader reader,
int length)
throws SQLException
value, which will have the specified number of bytes.
void updateObject(String columnName,
Object x,
int scaleOrLength)

int scale)
throws SQLException
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.
scaleOrLength
an object of java.math.BigDecimal ,
Java Object types InputStream and Reader, this is the length of the data in the stream or reader. For
all other
types,
void updateObject(String columnName,
Object x)
throws SQLException
void insertRow()
throws SQLException
non-null
value
void updateRow()
throws SQLException
void deleteRow()
throws SQLException
void refreshRow()
throws SQLException
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.
void cancelRowUpdates()
throws SQLException
void moveToInsertRow()
throws SQLException
void moveToCurrentRow()
throws SQLException
Statement getStatement()
throws SQLException
may return
ObjectgetObject(int columnIndex,
(int i,Map<String,Class<?>> map) throws SQLException
columnIndex
RefgetRef(int columnIndex)
(int i)throws SQLException
columnIndex
BlobgetBlob(int columnIndex)
(int i)throws SQLException
columnIndex
ClobgetClob(int columnIndex)
(int i)throws SQLException
columnIndex
ArraygetArray(int columnIndex)
(int i)throws SQLException
columnIndex
ObjectgetObject(StringcolumnName,
colName,Map<String,Class<?>> map) throws SQLException
columnName
RefgetRef(StringcolumnName)
colName)throws SQLException
columnName
BlobgetBlob(StringcolumnName)
colName)throws SQLException
columnName
ClobgetClob(StringcolumnName)
colName)throws SQLException
columnName
ArraygetArray(StringcolumnName)
colName)throws SQLException
columnName
Date getDate(int columnIndex,
Calendar cal)
throws SQLException
Date getDate(String columnName,
Calendar cal)
throws SQLException
Time getTime(int columnIndex,
Calendar cal)
throws SQLException
Time getTime(String columnName,
Calendar cal)
throws SQLException
Timestamp getTimestamp(int columnIndex,
Calendar cal)
throws SQLException
Timestamp getTimestamp(String columnName,
Calendar cal)
throws SQLException
URL getURL(int columnIndex)
throws SQLException
URL getURL(String columnName)
throws SQLException
void updateRef(int columnIndex,
Ref x)
throws SQLException
void updateRef(String columnName,
Ref x)
throws SQLException
void updateBlob(int columnIndex,
Blob x)
throws SQLException
void updateBlob(String columnName,
Blob x)
throws SQLException
void updateClob(int columnIndex,
Clob x)
throws SQLException
void updateClob(String columnName,
Clob x)
throws SQLException
void updateArray(int columnIndex,
Array x)
throws SQLException
void updateArray(String columnName,
Array x)
throws SQLException
getRowId
RowId
getRowId
(int columnIndex) throws
SQLException
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 - the first column is 1, the second 2, ...
Returns:
the column value; if the value is a SQL NULL the value returned is null
Throws:
SQLException
- if a database access error occurs
Since:
1.6
getRowId
RowId
getRowId
(
String
columnName) throws
SQLException
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:
columnName - the name of the column
Returns:
the column value ; if the value is a SQL NULL the value returned is null
Throws:
SQLException
- if a database access error occurs
Since:
1.6
updateRowId
void
updateRowId
(int columnIndex,
RowId
x) throws
SQLException
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 - the first column is 1, the second 2, ...
x - the column value
Throws:
SQLException
- if a database access occurs
Since:
1.6
updateRowId
void
updateRowId
(
String
columnName,
RowId
x) throws
SQLException
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:
columnName - the name of the column
x - the column value
Throws:
SQLException
- if a database access occurs
Since:
1.6
getHoldability
int
getHoldability
() throws
SQLException
Retrieves the holdability of this ResultSet object
Returns:
either ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
Throws:
SQLException
- if a database error occurs
Since:
1.6
isClosed
boolean
isClosed
() throws
SQLException
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:
true if this ResultSet object is closed; false if it is still open
Throws:
SQLException
- if a database access error occurs
Since:
1.6
updateNString
void
updateNString
(int columnIndex,
String
nString) throws
SQLException
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 - the first column is 1, the second 2, ...
nString - the value for the column to be updated
Throws:
SQLException
- if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; or if a database access error occurs
Since:
1.6
updateNString
void
updateNString
(
String
columnName,
String
nString) throws
SQLException
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:
columnName - name of the Column
nString - the value for the column to be updated
Throws:
SQLException
- if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; or if a database access error occurs
Since:
1.6
updateNClob
void
updateNClob
(int columnIndex,
NClob
nClob) throws
SQLException
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 - the first column is 1, the second 2, ...
nClob - the value for the column to be updated
Throws:
SQLException
- if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; or if a database access error occurs
Since:
1.6
updateNClob
void
updateNClob
(
String
columnName,
NClob
nClob) throws
SQLException
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:
columnName - name of the column
nClob - the value for the column to be updated
Throws:
SQLException
- if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; or if a database access error occurs
Since:
1.6
getNClob
NClob
getNClob
(int columnIndex) throws
SQLException
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 - the first column is 1, the second is 2, ...
Returns:
a NClob object representing the SQL NCLOB value in the specified column
Throws:
SQLException
- if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; or if a database access error occurss
Since:
1.6
getNClob
NClob
getNClob
(
String
columnName) throws
SQLException
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:
columnName - the name of the column from which to retrieve the value
Returns:
a NClob object representing the SQL NCLOB value in the specified column
Throws:
SQLException
- if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; or if a database access error occurs
Since:
1.6
getSQLXML
SQLXML
getSQLXML
(int columnIndex) throws
SQLException
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 - the first column is 1, the second is 2, ...
Returns:
a SQLXML object that maps an SQL XML value
Throws:
SQLException
- if a database access error occurs
Since:
1.6
getSQLXML
SQLXML
getSQLXML
(
String
columnName) throws
SQLException
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:
columnName - the name of the column from which to retrieve the value
Returns:
a SQLXML object that maps an SQL XML value
Throws:
SQLException
- if a database access error occurs
updateSQLXML
void
updateSQLXML
(int columnIndex,
SQLXML
xmlObject) throws
SQLException
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 - the first column is 1, the second 2, ...
xmlObject - the value for the column to be updated
Throws:
SQLException
- if a database access error occurs
Since:
1.6
updateSQLXML
void
updateSQLXML
(
String
columnName,
SQLXML
xmlObject) throws
SQLException
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:
columnName - the name of the column
xmlObject - the column value
Throws:
SQLException
- if a database access occurs
Since:
1.6
getNString
String
getNString
(int columnIndex) throws
SQLException
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 - the first column is 1, the second is 2, ...
Returns:
the column value; if the value is SQL NULL, the value returned is null
Throws:
SQLException
- if a database access error occurs
Since:
1.6
getNString
String
getNString
(
String
columnName) throws
SQLException
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:
columnName - the SQL name of the column
Returns:
the column value; if the value is SQL NULL, the value returned is null
Throws:
SQLException
- if a database access error occurs
Since:
1.6
getNCharacterStream
Reader
getNCharacterStream
(int columnIndex) throws
SQLException
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 - the first column is 1, the second is 2, ...
Returns:
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 a database access error occurs
Since:
1.6
getNCharacterStream
Reader
getNCharacterStream
(
String
columnName) throws
SQLException
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:
columnName - the name of the column
Returns:
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 a database access error occurs
Since:
1.6
updateNCharacterStream
void
updateNCharacterStream
(int columnIndex,
Reader
x, int length) throws
SQLException
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 - - the first column is 1, the second is 2, ...
x - - the new column value
length - - the length of the stream
Throws:
SQLException
- if a database access error occurs
Since:
1.6
updateNCharacterStream
void
updateNCharacterStream
(
String
columnName,
Reader
x, int length) throws
SQLException
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:
columnName - - name of the Column
x - - the new column value
length - - the length of the stream
Throws:
SQLException
- if a database access error occurs
Since:
1.6