Database command result. More...

#include <DBresult.h>

Inheritance diagram for utl::DBresult:

Public Member Functions
void	initialize (uint_t numRows, uint_t numFields, DBfield **fields)
	Initialize a new result. More...

void	clear ()
	Delete field and value objects. More...

uint_t	status () const
	Get the status. More...

uint_t &	status ()
	Get the status. More...

uint_t	numRows () const
	Get the number of rows. More...

uint_t	numFields () const
	Get the number of fields. More...

const DBfield &	field (uint_t idx) const
	Get the field at the given index. More...

uint_t	rowIndex (uint_t rowIdx) const
	Get a row index. More...

const uint64_t *	values () const
	Get values pointer. More...

uint64_t *	values ()
	Get values pointer. More...

char *	getString (uint_t rowIdx, uint_t fieldIdx) const
	Get string value at given field index. More...

bool	getBool (uint_t rowIdx, uint_t fieldIdx) const
	Get boolean value at given field index. More...

int	getInt32 (uint_t rowIdx, uint_t fieldIdx) const
	Get 32-bit integer value at given field index. More...

int64_t	getInt64 (uint_t rowIdx, uint_t fieldIdx) const
	Get 64-bit integer value at given field index. More...

double	getDouble (uint_t rowIdx, uint_t fieldIdx) const
	Get double value at given field index. More...

char *	getDecimal (uint_t rowIdx, uint_t fieldIdx) const
	Get decimal value at given field index. More...

time_t	getDateTime (uint_t rowIdx, uint_t fieldIdx) const
	Get date/time value at given field index. More...

bool	isNull (uint_t rowIdx, uint_t fieldIdx) const
	Is the given value nullptr?

void	setNull (uint_t rowIdx, uint_t fieldIdx)
	Mark the given value as nullptr. More...

const BitArray &	nullArray () const
	Get the nullptr map. More...

const String &	errorMsg () const
	Get error message. More...

String &	errorMsg ()
	Get error message. More...

Public Member Functions inherited from utl::Object
void	clear ()
	Revert to initial state. More...

virtual int	compare (const Object &rhs) const
	Compare with another object. More...

virtual void	copy (const Object &rhs)
	Copy another instance. More...

virtual void	vclone (const Object &rhs)
	Make an exact copy of another instance. More...

virtual void	steal (Object &rhs)
	"Steal" the internal representation from another instance. More...

virtual void	dump (Stream &os, uint_t level=uint_t_max) const
	Dump a human-readable representation of self to the given output stream. More...

void	dumpWithClassName (Stream &os, uint_t indent=4, uint_t level=uint_t_max) const
	Front-end for dump() that prints the object's class name. More...

virtual const Object &	getKey () const
	Get the key for this object. More...

bool	hasKey () const
	Determine whether or not the object has a key. More...

virtual const Object &	getProxiedObject () const
	Get the proxied object (= self if none). More...

virtual Object &	getProxiedObject ()
	Get the proxied object (= self if none). More...

virtual size_t	hash (size_t size) const
	Get the hash code for the object. More...

bool	_isA (const RunTimeClass *runTimeClass) const
	Determine whether self's class is a descendent of the given class. More...

virtual String	toString () const
	Return a string representation of self. More...

	operator String () const
	Conversion to String. More...

size_t	allocatedSize () const
	Get the total allocated size of this object. More...

virtual size_t	innerAllocatedSize () const
	Get the "inner" allocated size. More...

virtual void	addOwnedIt (const class FwdIt *it) const
	Notify self that it owns the given iterator. More...

virtual void	removeOwnedIt (const class FwdIt *it) const
	Notify self that the given owned iterator has been destroyed. More...

bool	operator< (const Object &rhs) const
	Less-than operator. More...

bool	operator<= (const Object &rhs) const
	Less-than-or-equal-to operator. More...

bool	operator> (const Object &rhs) const
	Greater-than operator. More...

bool	operator>= (const Object &rhs) const
	Greater-than-or-equal-to operator. More...

bool	operator== (const Object &rhs) const
	Equal-to operator. More...

bool	operator!= (const Object &rhs) const
	Unequal-to operator. More...

void	serializeIn (Stream &is, uint_t mode=ser_default)
	Serialize from an input stream. More...

void	serializeOut (Stream &os, uint_t mode=ser_default) const
	Serialize to an output stream. More...

virtual void	serialize (Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize to or from a stream. More...

void	serializeOutBoxed (Stream &os, uint_t mode=ser_default) const
	Serialize a boxed object to an output stream. More...

Additional Inherited Members
Static Public Member Functions inherited from utl::Object
static Object *	serializeInNullable (Stream &is, uint_t mode=ser_default)
	Serialize a nullptr-able object from an input stream. More...

static void	serializeOutNullable (const Object *object, Stream &os, uint_t mode=ser_default)
	Serialize a nullptr-able object to an output stream. More...

static void	serializeNullable (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize a nullptr-able object to or from a stream. More...

static Object *	serializeInBoxed (Stream &is, uint_t mode=ser_default)
	Serialize a boxed object from an input stream. More...

static void	serializeBoxed (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize a boxed object to or from a stream. More...

Detailed Description

Database command result.

DBresult represents the result of an SQL command run on the RDBMS server.

Author: Adam McKee

Definition at line 40 of file DBresult.h.

Member Function Documentation

◆ initialize()

void utl::DBresult::initialize	(	uint_t	numRows,
		uint_t	numFields,
		DBfield **	fields
	)

Initialize a new result.

◆ clear()

void utl::DBresult::clear ( )

Delete field and value objects.

◆ status() [1/2]

uint_t utl::DBresult::status ( ) const

inline

Get the status.

Definition at line 53 of file DBresult.h.

◆ status() [2/2]

uint_t& utl::DBresult::status ( )

inline

Get the status.

Definition at line 60 of file DBresult.h.

◆ numRows()

uint_t utl::DBresult::numRows ( ) const

inline

Get the number of rows.

Definition at line 67 of file DBresult.h.

◆ numFields()

uint_t utl::DBresult::numFields ( ) const

inline

Get the number of fields.

Definition at line 74 of file DBresult.h.

◆ field()

const DBfield& utl::DBresult::field ( uint_t idx ) const

inline

Get the field at the given index.

Definition at line 81 of file DBresult.h.

◆ rowIndex()

uint_t utl::DBresult::rowIndex ( uint_t rowIdx ) const

inline

Get a row index.

Definition at line 88 of file DBresult.h.

References ASSERTD.

◆ values() [1/2]

const uint64_t* utl::DBresult::values ( ) const

inline

Get values pointer.

Definition at line 96 of file DBresult.h.

◆ values() [2/2]

uint64_t* utl::DBresult::values ( )

inline

Get values pointer.

Definition at line 103 of file DBresult.h.

◆ getString()

char* utl::DBresult::getString	(	uint_t	rowIdx,
		uint_t	fieldIdx
	)		const

Get string value at given field index.

◆ getBool()

bool utl::DBresult::getBool	(	uint_t	rowIdx,
		uint_t	fieldIdx
	)		const

Get boolean value at given field index.

◆ getInt32()

int utl::DBresult::getInt32	(	uint_t	rowIdx,
		uint_t	fieldIdx
	)		const

Get 32-bit integer value at given field index.

◆ getInt64()

int64_t utl::DBresult::getInt64	(	uint_t	rowIdx,
		uint_t	fieldIdx
	)		const

Get 64-bit integer value at given field index.

◆ getDouble()

double utl::DBresult::getDouble	(	uint_t	rowIdx,
		uint_t	fieldIdx
	)		const

Get double value at given field index.

◆ getDecimal()

char* utl::DBresult::getDecimal	(	uint_t	rowIdx,
		uint_t	fieldIdx
	)		const

Get decimal value at given field index.

◆ getDateTime()

time_t utl::DBresult::getDateTime	(	uint_t	rowIdx,
		uint_t	fieldIdx
	)		const

Get date/time value at given field index.

◆ setNull()

void utl::DBresult::setNull	(	uint_t	rowIdx,
		uint_t	fieldIdx
	)

inline

Mark the given value as nullptr.

Definition at line 141 of file DBresult.h.

References ASSERTD.

◆ nullArray()

const BitArray& utl::DBresult::nullArray ( ) const

inline

Get the nullptr map.

Definition at line 151 of file DBresult.h.

◆ errorMsg() [1/2]

const String& utl::DBresult::errorMsg ( ) const

inline

Get error message.

Definition at line 158 of file DBresult.h.

◆ errorMsg() [2/2]

String& utl::DBresult::errorMsg ( )

inline

Get error message.

Definition at line 165 of file DBresult.h.

References utl::deInit(), and utl::init().

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

DBresult.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ initialize()

◆ clear()

◆ status() [1/2]

◆ status() [2/2]

◆ numRows()

◆ numFields()

◆ field()

◆ rowIndex()

◆ values() [1/2]

◆ values() [2/2]

◆ getString()

◆ getBool()

◆ getInt32()

◆ getInt64()

◆ getDouble()

◆ getDecimal()

◆ getDateTime()

◆ setNull()

◆ nullArray()

◆ errorMsg() [1/2]

◆ errorMsg() [2/2]