ResultSet Class

A ResultSet provides access to a table of data generated by executing a Statement. Table rows are retrieved in sequence. Within a row, column values can be accessed in any order.

A ResultSet 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.

The getxxx() methods retrieve column values for the current row. You can retrieve values using the index number of the column. Columns are numbered beginning at 1. For the getxxx() methods, OCCI attempts to convert the underlying data to the specified C++ type and returns a C++ value. SQL types are mapped to C++ types with the ResultSet::getxxx() methods.

The number, types and properties of a ResultSet's columns are provided by the MetaData object returned by the getColumnListMetaData() method.

enum Status{   END_OF_FETCH = 0,   DATA_AVAILABLE,   STREAM_DATA_AVAILABLE};

cancel()

This method cancels the result set.

void cancel();

closeStream()

This method closes the stream specified by the parameter stream.

void closeStream(
   Stream *stream); 

stream

getBDouble()

This method returns the value of a column in the current row as a BDouble. If the value is SQL NULL, the result is NULL.

BDouble getBDouble(
   unsigned int colIndex) = 0;

colIndex

getBfile()

This method returns the value of a column in the current row as a Bfile. Returns the column value; if the value is SQL NULL, the result is NULL.

Bfile getBfile(
   unsigned int colIndex);

colIndex

getBFloat()

This method returns the value of a column in the current row as a BFloat. If the value is SQL NULL, the result is NULL.

BFloat getBFloat(
   unsigned int colIndex) = 0;

colIndex

getBlob()

Get the value of a column in the current row as an Blob. Returns the column value; if the value is SQL NULL, the result is NULL.

Blob getBlob(
   unsigned int colIndex);

colIndex

getBytes()

Get the value of a column in the current row as a Bytes array. The bytes represent the raw values returned by the server. Returns the column value; if the value is SQL NULL, the result is NULL array

Bytes getBytes(
   unsigned int colIndex);

colIndex

getCharSet()

Gets the character set in which data would be fetched, as a string.

string getCharSet(
   unsigned int paramIndex) const;

paramIndex

getCharSetUString()

Gets the character set in which data would be fetched, as a string.

UString getCharSetUString(
   unsigned int paramIndex) const;

paramIndex

getClob()

Get the value of a column in the current row as a Clob. Returns the column value; if the value is SQL NULL, the result is NULL.

Clob getClob(
   unsigned int colIndex);

colIndex

getColumnListMetaData()

The number, types and properties of a ResultSet's columns are provided by the getMetaData method. Returns the description of a ResultSet's columns. This method will return the value of the given column as a PObject. The type of the C++ object will be the C++ PObject type corresponding to the column's SQL type registered with Environment's map. This method is used to materialize data of SQL user-defined types.

vector<MetaData> getColumnListMetaData() const;

getCurrentStreamColumn()

If the result set has any input Stream parameters, this method returns the column index of the current input Stream that must be read. If no output Stream needs to be read, or there are no input Stream columns in the result set, this method returns 0. Returns the column index of the current input Stream column that must be read.

unsigned int getCurrentStreamColumn() const;

getCurrentStreamRow()

If the result has any input Streams, this method returns the current row of the result set that is being processed by OCCI. If this method is called after all the rows in the set of array of rows have been processed, it returns 0. Returns the row number of the current row that is being processed. The first row is numbered 1 and so on.

unsigned int getCurrentStreamRow() const;

getCursor()

Get the nested cursor as an ResultSet. Data can be fetched from this result set. A nested cursor results from a nested query with a CURSOR(SELECT ... ) clause:

SELECT ename, 
       CURSOR(SELECT  dname, loc FROM dept) 
FROM emp WHERE ename = 'JONES'

Note that if there are multiple REF CURSORs being returned, data from each cursor must be completely fetched before retrieving the next REF CURSOR and starting fetch on it. Returns A ResultSet for the nested cursor.

ResultSet * getCursor(
   unsigned int colIndex);

colIndex

getDate()

Get the value of a column in the current row as a Date object. Returns the column value; if the value is SQL NULL, the result is NULL.

Date getDate(
   unsigned int colIndex);

colIndex

getDatebaseNCHARParam()

Returns whether data is in NCHAR character set or not.

bool getDatebaseNCHARParam(
   unsigned int paramIndex) const;

paramIndex

getBDouble()

Gets the value of an IEEE754 DOUBLE column as a C++ double, which has been defined as an OUT bind. If the value is SQL NULL, the result is 0.

double getBDouble(
   unsigned int colIndex) const;

colIndex

getDouble()

Gets the value of a column in the current row as a C++ double. Returns the column value; if the value is SQL NULL, the result is 0.

double getDouble(
   unsigned int colIndex);

colIndex

getBFloat()

Gets the value of an IEEE754 FLOAT column as a C++ float, which has been defined as an OUT bind. If the value is SQL NULL, the result is 0.

float getBFloat(
   unsigned int colIndex) const;

colIndex

getFloat()

Get the value of a column in the current row as a C++ float. Returns the column value; if the value is SQL NULL, the result is 0.

float getFloat(
   unsigned int colIndex);

colIndex

getInt()

Get the value of a column in the current row as a C++ int. Returns the column value; if the value is SQL NULL, the result is 0.

int getInt(
   unsigned int colIndex);

colIndex

getIntervalDS()

Get the value of a column in the current row as a IntervalDS object. Returns the column value; if the value is SQL NULL, the result is NULL.

IntervalDS getIntervalDS(
   unsigned int colIndex);

colIndex

getIntervalYM()

Get the value of a column in the current row as a IntervalYM object. Returns the column value; if the value is SQL NULL, the result is NULL.

IntervalYM getIntervalYM(
   unsigned int colIndex);

colIndex

getMaxColumnSize()

Get the maximum amount of data to read for a column.

unsigned int getMaxColumnSize(
   unsigned int colIndex) const;

colIndex

getNumArrayRows()

Returns the actual number of rows fetched in the last array fetch when next() returned END_OF_DATA. Returns the actual number of rows fetched in the final array fetch

unsigned int getNumArrayRows() const;

getNumber()

Get the value of a column in the current row as a Number object. Returns the column value; if the value is SQL NULL, the result is NULL.

Number getNumber(
   unsigned int colIndex);

colIndex

getObject()

Returns a pointer to a PObject holding the parameter value.

PObject * getObject(
   unsigned int paramIndex);

PObject * getObject(
   unsigned int paramIndex
   const UString &sqltyp);

paramIndex

sqltyp

getRef()

Get the value of a column in the current row as a RefAny. Retrieving a Ref value does not materialize the data to which Ref refers. Also the Ref value remains valid while the session or connection on which it is created is open. Returns a RefAny holding the column value.

RefAny getRef(
   unsigned int colIndex);

colIndex

getRowid()

Get the current row id for a SELECT ... FOR UPDATE statement. The row id can be bound to a prepared DELETE statement and so on. Returns current rowid for a SELECT ... FOR UPDATE statement.

Bytes getRowid(
   unsigned int colIndex);

colIndex

getRowPosition()

Get the rowid of the current row position.

Bytes getRowPosition() const;

getStatement()

This method returns the statement of the ResultSet.

const Statement* getStatement() const;

getStream()

This method returns the value of a column in the current row as a Stream.

Stream * getStream(
   unsigned int colIndex);

colIndex

getString()

Get the value of a column in the current row as a string. Returns the column value; if the value is SQL NULL, the result is an empty string.

string getString(
   unsigned int colIndex);

colIndex

getTimestamp()

Get the value of a column in the current row as a Timestamp object. Returns the column value; if the value is SQL NULL, the result is NULL.

Timestamp getTimestamp(
   unsigned int colIndex);

colIndex

getUInt()

Get the value of a column in the current row as a C++ int. Returns the column value; if the value is SQL NULL, the result is 0.

unsigned int getUInt(
   unsigned int colIndex);

colIndex

getUString()

Return the value as a UString.

UString getUString(
   unsigned int paramIndex);

paramIndex

getVector()

This method returns the column in the current position as a vector. The column should be a collection type (varray or nested table). The SQL type of the elements in the collection should be compatible with the data type of the objects in the vector.

void getVector(
   ResultSet *rs,
   unsigned int colIndex,
   vector<BDouble> &vect);

void getVector(
   ResultSet *rs,
   unsigned int colIndex,
   vector<Bfile> &vect);

void getVector(
   ResultSet *rs,
   unsigned int colIndex,
   vector<BFloat> &vect);

void getVector(
   ResultSet *rs,
   unsigned int colIndex,
   vector<Blob> &vect);

void getVector(
   ResultSet *rs,
   unsigned int colIndex,
   vector<Clob> &vect);

void getVector(
   ResultSet *rs,
   unsigned int colIndex,
   vector<Date> &vect);

void getVector(
   ResultSet *rs,
   unsigned int colIndex,
   vector<double> &vect);

void getVector(
   ResultSet *rs,
   unsigned int colIndex,
   vector<float> &vect);

void getVector(
   ResultSet *rs,
   unsigned int colIndex,
   vector<int> &vect);

void getVector(
   ResultSet *rs,
   unsigned int colIndex,
   vector<IntervalDS> &vect);

void getVector(
   ResultSet *rs,
   unsigned int colIndex,
   vector<IntervalYM> &vect);

void getVector(
   ResultSet *rs,
   unsigned int colIndex,
   vector<Number> &vect);

void getVector(
   ResultSet *rs,
   unsigned int colIndex,
   vector<Ref<T>> &vect);

void getVector(
   ResultSet *rs,
   unsigned int colIndex,
   vector<Ref> &vect);

void getVector(
   ResultSet *rs,
   unsigned int colIndex,
   vector<RefAny> &vect);

void getVector(
   ResultSet *rs,
   unsigned int colIndex,
   vector<string> &vect);

void getVector(
   ResultSet *rs,
   unsigned int colIndex,
   vector<T *> &vect);

void getVector(
   ResultSet *rs,
   unsigned int colIndex,
   vector<T> &vect);

void getVector(
   ResultSet *rs,
   unsigned int colIndex,
   vector<Timestamp> &vect);

void getVector(
   ResultSet *rs,
   unsigned int colIndex,
   vector<unsigned int> &vect);

void getVector(
   ResultSet *rs,
   unsigned int colIndex,
   vector<UString> &vect);

rs

colIndex

vect

getVectorOfRefs()

Returns the column in the current position as a vector of REFs. The column should be a collection type (varray or nested table) of REFs. It is recommend to use this function instead of specialized method getVector() for Ref<T>.

void getVectorOfRefs(
   ResultSet *rs,
   unsigned int colIndex,
   vector< Ref<T> > &vect);

rs

colIndex

vect

isNull()

A column may have the value of SQL NULL; wasNull() reports whether the last column read had this special value. Note that you must first call getxxx() on a column to try to read its value and then call wasNull() to find if the value was the SQL NULL. Returns TRUE if last column read was SQL NULL.

bool isNull(
   unsigned int colIndex) const;

colIndex

isTruncated()

This method checks whether the value of the parameter is truncated. If the value of the parameter is truncated, then TRUE is returned; otherwise, FALSE is returned.

bool isTruncated(
   unsigned int paramIndex) const;

paramIndex

next()

A ResultSet is initially positioned before its first row; the first call to next makes the first row the current row; the second call makes the second row the current row, and so on. If a read-able stream from the previous row is open, it is implicitly closed. The ResultSet's warning chain is cleared when a new row is read.

For non-streamed mode, next() always returns RESULT_SET_AVAILABLE or END_OF_DATA. Data is available for getxxx()method when the RESULT_SET_REMOVE_AVAILABLE status is returned. When this version of next() is used, array fetches are done for data being fetched with the setDataBuffer() interface. This means that getxxx() methods should not be called. The numRows amount of data for each column would materialize in the buffers specified with the setDataBuffer() interface. With array fetches, stream input is allowed, so getxxxStream() methods can also be called, once for each column.

Returns one of following:

• DATA_AVAILABLE — call getxxx() or read data from buffers specified with setDataBuffer()

• END_OF_FETCH — no more data available. This is the last set of rows for array fetches. This value is defined to be 0.

• STREAM_DATA_AVAILABLE — call the getCurrentStreamColumn() method and read stream

Status next(
   unsigned int numRows =1);

numRows

preTruncationLength()

Returns the actual length of the parameter before truncation.

int preTruncationLength(
   unsigned int paramIndex) const;

paramIndex

setBinaryStreamMode()

Defines that a column is to be returned as a binary stream by the getStream method.

void setBinaryStreamMode(
   unsigned int colIndex,
   unsigned int size);

colIndex

size

setCharacterStreamMode()

Defines that a column is to be returned as a character stream by the getStream() method.

void setCharacterStreamMode(
   unsigned int colIndex,
   unsigned int size);

colIndex

size

setCharSet()

Overrides the default character set for the specified column. Data is converted from the database character set to the specified character set for this column.

void setCharSet(
   unsigned int colIndex,
   string charSet);

colIndex

charSet

setCharSetUString()

Specify the character set value as a UString in which the data is returned.

UString setCharSetUString(
   unsigned int colIndex,
   string charSet);

colIndex

charSet

setDatebaseNCHARParam()

If the parameter is going to be retrieved from a column that contains data in the database's NCHAR character set, then OCCI must be informed by passing a TRUE value. A FALSE can be passed to restore the default.

void setDatabaseNCHARParam(
   unsigned int paramIndex, 
   bool isNCHAR);

paramIndex

isNCHAR

setDataBuffer()

Specify a data buffer where data would be fetched. The buffer parameter is a pointer to a user allocated data buffer. The current length of data must be specified in the length parameter. The amount of data should not exceed the size parameter. Finally, type is the data type of the data. Only non OCCI and non C++ specific types can be used, such as STL string. OCCI classes like Bytes and Date cannot be used.

If setDataBuffer() is used to fetch data for array fetches, it should be called only once for each result set. Data for each row is assumed to be at buffer (i- 1)location, where i is the row number. Similarly, the length of the data would be assumed to be at (length+(i-1)).

void setDataBuffer(
   unsigned int colIndex,
   void *buffer,
   Type type,
   sb4 size = 0,
   ub2 *length = NULL,
   sb2 *ind = NULL,
   ub2 *rc = NULL);

colIndex

buffer

type

size

length

ind

rc

setErrorOnNull()

This method enables/disables exceptions for reading of NULL values on colIndex column of the result set.

void setErrorOnNull(
   unsigned int colIndex,
   bool causeException);

colIndex

causeException

setErrorOnTruncate()

This method enables/disables exceptions when truncation occurs.

void setErrorOnTruncate(
   unsigned int paramIndex,
   bool causeException);

paramIndex

causeException

setMaxColumnSize()

Set the maximum amount of data to read for a column.

void setMaxColumnSize(
   unsigned int colIndex,
   unsigned int max);

colIndex

max

status()

Returns the current status of the result set. The status method can be called repeatedly to find out the status of the result. Data is available for getxxx method when the RESULT_SET_AVAILABLE status is returned. Returns one of following:

• DATA_AVAILABLE — call getxxx() or read data from buffers specified with the setDataBuffer method

• STREAM_DATA_AVAILABLE — call getCurrentStream() and read stream

• END_OF_FETCH

Status status() const;