libodbc++  0.2.5
Public Types | Public Member Functions | List of all members
odbc::ResultSet Class Reference

A result set. More...

#include <resultset.h>

Inheritance diagram for odbc::ResultSet:
odbc::ErrorHandler

Public Types

enum  { CONCUR_READ_ONLY, CONCUR_UPDATABLE }
 ResultSet concurrency constants. More...
 
enum  { TYPE_FORWARD_ONLY, TYPE_SCROLL_INSENSITIVE, TYPE_SCROLL_SENSITIVE }
 ResultSet type constants. More...
 

Public Member Functions

virtual ~ResultSet ()
 Destructor.
 
bool absolute (int row)
 Moves the cursor to a specific row in this result set.
 
bool relative (int rows)
 Moves the cursor inside the result set relative to the current row.
 
void afterLast ()
 Places the cursor after the last row in the result set.
 
void beforeFirst ()
 Places the cursor before the first row in the result set.
 
bool isAfterLast ()
 Checks if the cursor is after the last row in the result set.
 
bool isBeforeFirst ()
 Checks if the cursor is before the first row in the result set.
 
bool isFirst ()
 Checks if the cursor is on the first row in the result set.
 
bool isLast ()
 Checks if the cursor is on the last row in the result set.
 
int getRow ()
 Returns the current row number.
 
bool next ()
 Moves to the next row in the result set.
 
bool previous ()
 Moves to the previous row in the result set.
 
bool first ()
 Moves to the first row in the result set.
 
bool last ()
 Moves to the last row in the result set.
 
void moveToInsertRow ()
 Moves the cursor to the 'insert row' of this result set.
 
void moveToCurrentRow ()
 Moves the cursor back to where it was before it was moved to the insert row.
 
void refreshRow ()
 Refreshes the current row.
 
void deleteRow ()
 Deletes the current row.
 
void insertRow ()
 Inserts the current row.
 
void updateRow ()
 Updates the current row.
 
void cancelRowUpdates ()
 Cancels any updates done to the current row.
 
ResultSetMetaDatagetMetaData ()
 Returns meta data about this result set.
 
int findColumn (const std::string &colName)
 Find a column index by the column's name.
 
bool rowDeleted ()
 Checks if the current row is deleted.
 
bool rowInserted ()
 Checks if the current row was inserted.
 
bool rowUpdated ()
 Checks if the current row was updated.
 
int getType ()
 Gets the type of this result set.
 
int getConcurrency ()
 Gets the concurrency of this result set.
 
int getFetchSize ()
 Gets this result set's current fetch size.
 
void setFetchSize (int fetchSize)
 Sets this result set's fetch size (doesn't apply immediately)
 
std::string getCursorName ()
 Gets the cursor name associated with this result set.
 
StatementgetStatement ()
 Gets the Statement that created this result set.
 
double getDouble (int idx)
 Gets a column's value as a double.
 
bool getBoolean (int idx)
 Gets a column's value as a bool.
 
signed char getByte (int idx)
 Gets a column's value as a signed char.
 
Bytes getBytes (int idx)
 Gets a column's value as a chunk of bytes.
 
Date getDate (int idx)
 Gets a column's value as a Date.
 
float getFloat (int idx)
 Gets a column's value as a float.
 
int getInt (int idx)
 Gets a column's value as an int.
 
Long getLong (int idx)
 Gets a column's value as a Long.
 
short getShort (int idx)
 Gets a column's value as a short.
 
std::string getString (int idx)
 Gets a column's value as a string.
 
Time getTime (int idx)
 Gets a column's value as a Time.
 
Timestamp getTimestamp (int idx)
 Gets a column's value as a Timestamp.
 
double getDouble (const std::string &colName)
 Gets a column's value as a double.
 
bool getBoolean (const std::string &colName)
 Gets a column's value as a bool.
 
signed char getByte (const std::string &colName)
 Gets a column's value as a signed char.
 
Bytes getBytes (const std::string &colName)
 Gets a column's value as a chunk of bytes.
 
Date getDate (const std::string &colName)
 Gets a column's value as a Date.
 
float getFloat (const std::string &colName)
 Gets a column's value as a float.
 
int getInt (const std::string &colName)
 Gets a column's value as an int.
 
Long getLong (const std::string &colName)
 Gets a column's value as a Long.
 
short getShort (const std::string &colName)
 Gets a column's value as a short.
 
std::string getString (const std::string &colName)
 Gets a column's value as a string.
 
Time getTime (const std::string &colName)
 Gets a column's value as a Time.
 
Timestamp getTimestamp (const std::string &colName)
 Gets a column's value as a Timestamp.
 
std::istream * getAsciiStream (int idx)
 Fetches a column's value as a stream.
 
std::istream * getAsciiStream (const std::string &colName)
 Fetches a column's value as a stream.
 
std::istream * getBinaryStream (int idx)
 Fetches a column's value as a stream.
 
std::istream * getBinaryStream (const std::string &colName)
 Fetches a column's value as a stream.
 
bool wasNull ()
 Checks if the last fetched column value was NULL.
 
void updateDouble (int idx, double val)
 Sets the value of a column to a double.
 
void updateBoolean (int idx, bool val)
 Sets the value of a column to a bool.
 
void updateByte (int idx, signed char val)
 Sets the value of a column to a signed char.
 
void updateBytes (int idx, const Bytes &val)
 Sets the value of a column to a chunk of bytes.
 
void updateDate (int idx, const Date &val)
 Sets the value of a column to a Date.
 
void updateFloat (int idx, float val)
 Sets the value of a column to a float.
 
void updateInt (int idx, int val)
 Sets the value of a column to an int.
 
void updateLong (int idx, Long val)
 Sets the value of a column to a Long.
 
void updateShort (int idx, short val)
 Sets the value of a column to a short.
 
void updateString (int idx, const std::string &val)
 Sets the value of a column to a string.
 
void updateTime (int idx, const Time &val)
 Sets the value of a column to a Time.
 
void updateTimestamp (int idx, const Timestamp &val)
 Sets the value of a column to a Timestamp.
 
void updateNull (int idx)
 Sets the value of a column to NULL.
 
void updateDouble (const std::string &colName, double val)
 Sets the value of a column to a double.
 
void updateBoolean (const std::string &colName, bool val)
 Sets the value of a column to a bool.
 
void updateByte (const std::string &colName, signed char val)
 Sets the value of a column to a signed char.
 
void updateBytes (const std::string &colName, const Bytes &val)
 Sets the value of a column to a chunk of bytes.
 
void updateDate (const std::string &colName, const Date &val)
 Sets the value of a column to a Date.
 
void updateFloat (const std::string &colName, float val)
 Sets the value of a column to a float.
 
void updateInt (const std::string &colName, int val)
 Sets the value of a column to an int.
 
void updateLong (const std::string &colName, Long val)
 Sets the value of a column to a Long.
 
void updateShort (const std::string &colName, short val)
 Sets the value of a column to a short.
 
void updateString (const std::string &colName, const std::string &val)
 Sets the value of a column to a string.
 
void updateTime (const std::string &colName, const Time &val)
 Sets the value of a column to a Time.
 
void updateTimestamp (const std::string &colName, const Timestamp &val)
 Sets the value of a column to a Timestamp.
 
void updateAsciiStream (int idx, std::istream *s, int len)
 Sets the value of a column to a stream.
 
void updateAsciiStream (const std::string &colName, std::istream *s, int len)
 Sets the value of a column to the contens of a stream.
 
void updateBinaryStream (int idx, std::istream *s, int len)
 Sets the value of a column to the contens of a stream.
 
void updateBinaryStream (const std::string &colName, std::istream *s, int len)
 Sets the value of a column to the contens of a stream.
 
void updateNull (const std::string &colName)
 Sets the value of a column to NULL.
 
- Public Member Functions inherited from odbc::ErrorHandler
void clearWarnings ()
 Clears all the warnings stored in this object.
 
WarningList * getWarnings ()
 Fetches all the warnings in this object.
 
virtual ~ErrorHandler ()
 Destructor.
 

Additional Inherited Members

- Protected Member Functions inherited from odbc::ErrorHandler
 ErrorHandler (bool collectWarnings=true)
 Constructor.
 

Detailed Description

A result set.

Member Enumeration Documentation

anonymous enum

ResultSet concurrency constants.

Enumerator:
CONCUR_READ_ONLY 

The ResultSet is read only.

CONCUR_UPDATABLE 

The ResultSet is updatable.

anonymous enum

ResultSet type constants.

Enumerator:
TYPE_FORWARD_ONLY 

The result set only goes forward.

TYPE_SCROLL_INSENSITIVE 

The result set is scrollable, but the data in it is not affected by changes in the database.

TYPE_SCROLL_SENSITIVE 

The result set is scrollable and sensitive to database changes.

Member Function Documentation

bool odbc::ResultSet::absolute ( int  row)

Moves the cursor to a specific row in this result set.

If row is negative, the actual row number is calculated from the end of the result set. Calling absolute(0) is equivalent to calling beforeFirst()

Returns
true if the cursor is in the result set
bool odbc::ResultSet::first ( )

Moves to the first row in the result set.

Returns
true if the cursor is in the result set
std::istream* odbc::ResultSet::getAsciiStream ( int  idx)

Fetches a column's value as a stream.

Note that the stream is owned by the result set and should in no case be deleted by the caller. Also, the returned stream is only valid while the cursor remains on this position.

Parameters
idxThe column index, starting at 1
std::istream* odbc::ResultSet::getAsciiStream ( const std::string &  colName)

Fetches a column's value as a stream.

Note that the stream is owned by the result set and should in no case be deleted by the caller. Also, the returned stream is only valid while the cursor remains on this position.

Parameters
colNameThe column name
std::istream* odbc::ResultSet::getBinaryStream ( int  idx)

Fetches a column's value as a stream.

Note that the stream is owned by the result set and should in no case be deleted by the caller. Also, the returned stream is only valid while the cursor remains on this position.

Parameters
idxThe column index, starting at 1
std::istream* odbc::ResultSet::getBinaryStream ( const std::string &  colName)

Fetches a column's value as a stream.

Note that the stream is owned by the result set and should in no case be deleted by the caller. Also, the returned stream is only valid while the cursor remains on this position.

Parameters
colNameThe column name
bool odbc::ResultSet::getBoolean ( int  idx)

Gets a column's value as a bool.

Parameters
idxThe column index, starting at 1
bool odbc::ResultSet::getBoolean ( const std::string &  colName)

Gets a column's value as a bool.

Parameters
colNameThe name of the column
signed char odbc::ResultSet::getByte ( int  idx)

Gets a column's value as a signed char.

Parameters
idxThe column index, starting at 1
signed char odbc::ResultSet::getByte ( const std::string &  colName)

Gets a column's value as a signed char.

Parameters
colNameThe name of the column
Bytes odbc::ResultSet::getBytes ( int  idx)

Gets a column's value as a chunk of bytes.

Parameters
idxThe column index, starting at 1
Bytes odbc::ResultSet::getBytes ( const std::string &  colName)

Gets a column's value as a chunk of bytes.

Parameters
colNameThe name of the column
Date odbc::ResultSet::getDate ( int  idx)

Gets a column's value as a Date.

Parameters
idxThe column index, starting at 1
Date odbc::ResultSet::getDate ( const std::string &  colName)

Gets a column's value as a Date.

Parameters
colNameThe name of the column
double odbc::ResultSet::getDouble ( int  idx)

Gets a column's value as a double.

Parameters
idxThe column index, starting at 1
double odbc::ResultSet::getDouble ( const std::string &  colName)

Gets a column's value as a double.

Parameters
colNameThe name of the column
float odbc::ResultSet::getFloat ( int  idx)

Gets a column's value as a float.

Parameters
idxThe column index, starting at 1
float odbc::ResultSet::getFloat ( const std::string &  colName)

Gets a column's value as a float.

Parameters
colNameThe name of the column
int odbc::ResultSet::getInt ( int  idx)

Gets a column's value as an int.

Parameters
idxThe column index, starting at 1
int odbc::ResultSet::getInt ( const std::string &  colName)

Gets a column's value as an int.

Parameters
colNameThe name of the column
Long odbc::ResultSet::getLong ( int  idx)

Gets a column's value as a Long.

Parameters
idxThe column index, starting at 1
Long odbc::ResultSet::getLong ( const std::string &  colName)

Gets a column's value as a Long.

Parameters
colNameThe name of the column
ResultSetMetaData* odbc::ResultSet::getMetaData ( )

Returns meta data about this result set.

See Also
ResultSetMetaData
int odbc::ResultSet::getRow ( )

Returns the current row number.

Returns
The current row number in the result set, or 0 if it can't be determined.
short odbc::ResultSet::getShort ( int  idx)

Gets a column's value as a short.

Parameters
idxThe column index, starting at 1
short odbc::ResultSet::getShort ( const std::string &  colName)

Gets a column's value as a short.

Parameters
colNameThe name of the column
std::string odbc::ResultSet::getString ( int  idx)

Gets a column's value as a string.

Parameters
idxThe column index, starting at 1
std::string odbc::ResultSet::getString ( const std::string &  colName)

Gets a column's value as a string.

Parameters
colNameThe name of the column
Time odbc::ResultSet::getTime ( int  idx)

Gets a column's value as a Time.

Parameters
idxThe column index, starting at 1
Time odbc::ResultSet::getTime ( const std::string &  colName)

Gets a column's value as a Time.

Parameters
colNameThe name of the column
Timestamp odbc::ResultSet::getTimestamp ( int  idx)

Gets a column's value as a Timestamp.

Parameters
idxThe column index, starting at 1
Timestamp odbc::ResultSet::getTimestamp ( const std::string &  colName)

Gets a column's value as a Timestamp.

Parameters
colNameThe name of the column
void odbc::ResultSet::insertRow ( )

Inserts the current row.

Only valid while on the insert row.

See Also
moveToInsertRow()
bool odbc::ResultSet::last ( )

Moves to the last row in the result set.

Returns
true if the cursor is in the result set
void odbc::ResultSet::moveToInsertRow ( )

Moves the cursor to the 'insert row' of this result set.

Warning
The only valid methods while on the insert row are updateXXX(), insertRow() and moveToCurrentRow().
See Also
moveToCurrentRow()
bool odbc::ResultSet::next ( )

Moves to the next row in the result set.

Returns
true if the cursor is in the result set
bool odbc::ResultSet::previous ( )

Moves to the previous row in the result set.

Returns
true if the cursor is in the result set
bool odbc::ResultSet::relative ( int  rows)

Moves the cursor inside the result set relative to the current row.

Negative values are allowed. This call is illegal if there is no current row.

Returns
true if the cursor is in the result set
void odbc::ResultSet::updateAsciiStream ( int  idx,
std::istream *  s,
int  len 
)

Sets the value of a column to a stream.

Parameters
idxThe column index, starting at 1
sThe stream to assign
lenThe number of bytes in the stream
void odbc::ResultSet::updateAsciiStream ( const std::string &  colName,
std::istream *  s,
int  len 
)

Sets the value of a column to the contens of a stream.

Parameters
colNameThe column name
sThe stream to assign
lenThe number of bytes in the stream
void odbc::ResultSet::updateBinaryStream ( int  idx,
std::istream *  s,
int  len 
)

Sets the value of a column to the contens of a stream.

Parameters
idxThe column index, starting at 1
sThe stream to assign
lenThe number of bytes in the stream
void odbc::ResultSet::updateBinaryStream ( const std::string &  colName,
std::istream *  s,
int  len 
)

Sets the value of a column to the contens of a stream.

Parameters
colNameThe column name
sThe stream to assign
lenThe number of bytes in the stream
void odbc::ResultSet::updateBoolean ( int  idx,
bool  val 
)

Sets the value of a column to a bool.

Parameters
idxThe column index, starting at 1
valThe value to set
void odbc::ResultSet::updateBoolean ( const std::string &  colName,
bool  val 
)

Sets the value of a column to a bool.

Parameters
colNameThe name of the column
valThe value to set
void odbc::ResultSet::updateByte ( int  idx,
signed char  val 
)

Sets the value of a column to a signed char.

Parameters
idxThe column index, starting at 1
valThe value to set
void odbc::ResultSet::updateByte ( const std::string &  colName,
signed char  val 
)

Sets the value of a column to a signed char.

Parameters
colNameThe name of the column
valThe value to set
void odbc::ResultSet::updateBytes ( int  idx,
const Bytes val 
)

Sets the value of a column to a chunk of bytes.

Parameters
idxThe column index, starting at 1
valThe value to set
void odbc::ResultSet::updateBytes ( const std::string &  colName,
const Bytes val 
)

Sets the value of a column to a chunk of bytes.

Parameters
colNameThe name of the column
valThe value to set
void odbc::ResultSet::updateDate ( int  idx,
const Date val 
)

Sets the value of a column to a Date.

Parameters
idxThe column index, starting at 1
valThe value to set
void odbc::ResultSet::updateDate ( const std::string &  colName,
const Date val 
)

Sets the value of a column to a Date.

Parameters
colNameThe name of the column
valThe value to set
void odbc::ResultSet::updateDouble ( int  idx,
double  val 
)

Sets the value of a column to a double.

Parameters
idxThe column index, starting at 1
valThe value to set
void odbc::ResultSet::updateDouble ( const std::string &  colName,
double  val 
)

Sets the value of a column to a double.

Parameters
colNameThe name of the column
valThe value to set
void odbc::ResultSet::updateFloat ( int  idx,
float  val 
)

Sets the value of a column to a float.

Parameters
idxThe column index, starting at 1
valThe value to set
void odbc::ResultSet::updateFloat ( const std::string &  colName,
float  val 
)

Sets the value of a column to a float.

Parameters
colNameThe name of the column
valThe value to set
void odbc::ResultSet::updateInt ( int  idx,
int  val 
)

Sets the value of a column to an int.

Parameters
idxThe column index, starting at 1
valThe value to set
void odbc::ResultSet::updateInt ( const std::string &  colName,
int  val 
)

Sets the value of a column to an int.

Parameters
colNameThe name of the column
valThe value to set
void odbc::ResultSet::updateLong ( int  idx,
Long  val 
)

Sets the value of a column to a Long.

Parameters
idxThe column index, starting at 1
valThe value to set
void odbc::ResultSet::updateLong ( const std::string &  colName,
Long  val 
)

Sets the value of a column to a Long.

Parameters
colNameThe name of the column
valThe value to set
void odbc::ResultSet::updateNull ( int  idx)

Sets the value of a column to NULL.

Parameters
idxThe column index, starting at 1
void odbc::ResultSet::updateNull ( const std::string &  colName)

Sets the value of a column to NULL.

Parameters
colNameThe column name
void odbc::ResultSet::updateRow ( )

Updates the current row.

void odbc::ResultSet::updateShort ( int  idx,
short  val 
)

Sets the value of a column to a short.

Parameters
idxThe column index, starting at 1
valThe value to set
void odbc::ResultSet::updateShort ( const std::string &  colName,
short  val 
)

Sets the value of a column to a short.

Parameters
colNameThe name of the column
valThe value to set
void odbc::ResultSet::updateString ( int  idx,
const std::string &  val 
)

Sets the value of a column to a string.

Parameters
idxThe column index, starting at 1
valThe value to set
void odbc::ResultSet::updateString ( const std::string &  colName,
const std::string &  val 
)

Sets the value of a column to a string.

Parameters
colNameThe name of the column
valThe value to set
void odbc::ResultSet::updateTime ( int  idx,
const Time val 
)

Sets the value of a column to a Time.

Parameters
idxThe column index, starting at 1
valThe value to set
void odbc::ResultSet::updateTime ( const std::string &  colName,
const Time val 
)

Sets the value of a column to a Time.

Parameters
colNameThe name of the column
valThe value to set
void odbc::ResultSet::updateTimestamp ( int  idx,
const Timestamp val 
)

Sets the value of a column to a Timestamp.

Parameters
idxThe column index, starting at 1
valThe value to set
void odbc::ResultSet::updateTimestamp ( const std::string &  colName,
const Timestamp val 
)

Sets the value of a column to a Timestamp.

Parameters
colNameThe name of the column
valThe value to set
bool odbc::ResultSet::wasNull ( )

Checks if the last fetched column value was NULL.

Note that if this is true, the returned value was undefined.


The documentation for this class was generated from the following file:

Go back to the libodbc++ homepage