CL_DBReader Class Reference
[clanDatabase System]

Database reader. More...

#include <db_reader.h>

List of all members.

Public Member Functions

Construction

 CL_DBReader ()
 Constructs a database reader.
 CL_DBReader (const CL_SharedPtr< CL_DBReader_Impl > &impl)
 Constructs a DBReader.
 ~CL_DBReader ()
Attributes

int get_column_count () const
 Returns the number of columns in the result set.
CL_String get_column_name (int index) const
 Returns the name of the specified column index.
int get_name_index (const CL_StringRef &name) const
 Returns the index of the specified column name.
CL_DBValue get_column_value (int index) const
 Retrieves the value of the specified column.
CL_DBValue get_column_value (const CL_StringRef &name) const
 Retrieves the value of the specified column name.
CL_String get_column_string (int index) const
 Retrieves the value of the specified column as a string.
bool get_column_bool (int index) const
 Retrieves the value of the specified column as a boolean.
int get_column_int (int index) const
 Retrieves the value of the specified column as an integer.
double get_column_double (int index) const
 Retrieves the value of the specified column as a double.
CL_DateTime get_column_datetime (int index) const
 Retrieves the value of the specified column as a CL_DateTime.
CL_DataBuffer get_column_binary (int index) const
 Retrieves the value of the specified column as a CL_DataBuffer.
CL_String get_column_string (const CL_StringRef &column_name) const
 Retrieves the value of the specified column as a string.
bool get_column_bool (const CL_StringRef &column_name) const
 Retrieves the value of the specified column as a boolean.
int get_column_int (const CL_StringRef &column_name) const
 Retrieves the value of the specified column as an integer.
double get_column_double (const CL_StringRef &column_name) const
 Retrieves the value of the specified column as a double.
CL_DateTime get_column_datetime (const CL_StringRef &column_name) const
 Retrieves the value of the specified column as a CL_DateTime.
CL_DataBuffer get_column_binary (const CL_StringRef &column_name) const
 Retrieves the value of the specified column as a CL_DataBuffer.
CL_DBReaderProviderget_provider ()
 Returns the provider interface for this reader.
Operations

bool retrieve_row ()
 Retrieves a row from the command execution result.
void close ()
 Closes the database reader.

Detailed Description

Database reader.


Constructor & Destructor Documentation

CL_DBReader::CL_DBReader (  ) 

Constructs a database reader.

CL_DBReader::CL_DBReader ( const CL_SharedPtr< CL_DBReader_Impl > &  impl  ) 

Constructs a DBReader.

Parameters:
impl = Shared Ptr
CL_DBReader::~CL_DBReader (  ) 

Member Function Documentation

void CL_DBReader::close (  ) 

Closes the database reader.

CL_DataBuffer CL_DBReader::get_column_binary ( int  index  )  const

Retrieves the value of the specified column as a CL_DataBuffer.

CL_DataBuffer CL_DBReader::get_column_binary ( const CL_StringRef column_name  )  const

Retrieves the value of the specified column as a CL_DataBuffer.

bool CL_DBReader::get_column_bool ( int  index  )  const

Retrieves the value of the specified column as a boolean.

bool CL_DBReader::get_column_bool ( const CL_StringRef column_name  )  const

Retrieves the value of the specified column as a boolean.

int CL_DBReader::get_column_count (  )  const

Returns the number of columns in the result set.

CL_DateTime CL_DBReader::get_column_datetime ( const CL_StringRef column_name  )  const

Retrieves the value of the specified column as a CL_DateTime.

CL_DateTime CL_DBReader::get_column_datetime ( int  index  )  const

Retrieves the value of the specified column as a CL_DateTime.

double CL_DBReader::get_column_double ( int  index  )  const

Retrieves the value of the specified column as a double.

double CL_DBReader::get_column_double ( const CL_StringRef column_name  )  const

Retrieves the value of the specified column as a double.

int CL_DBReader::get_column_int ( int  index  )  const

Retrieves the value of the specified column as an integer.

int CL_DBReader::get_column_int ( const CL_StringRef column_name  )  const

Retrieves the value of the specified column as an integer.

CL_String CL_DBReader::get_column_name ( int  index  )  const

Returns the name of the specified column index.

CL_String CL_DBReader::get_column_string ( int  index  )  const

Retrieves the value of the specified column as a string.

CL_String CL_DBReader::get_column_string ( const CL_StringRef column_name  )  const

Retrieves the value of the specified column as a string.

CL_DBValue CL_DBReader::get_column_value ( int  index  )  const

Retrieves the value of the specified column.

CL_DBValue CL_DBReader::get_column_value ( const CL_StringRef name  )  const

Retrieves the value of the specified column name.

int CL_DBReader::get_name_index ( const CL_StringRef name  )  const

Returns the index of the specified column name.

CL_DBReaderProvider* CL_DBReader::get_provider (  ) 

Returns the provider interface for this reader.

bool CL_DBReader::retrieve_row (  ) 

Retrieves a row from the command execution result.

Returns:
True if a row was retrieved, false if there are no more rows

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