Template Class for reading a row. More...

#include "rdm_db_read_row.h"

Public Member Functions
uint8_t *	serialize (uint8_t *buffer)

uint8_t *	unserialize (uint8_t *buffer)

RDM_RETCODE	fetch (direction dir, bool first_or_last)
	Fetch a row. More...

read_row &	operator= (const read_row &)

	read_row (const read_row &r)

	read_row ()

	~read_row ()

uint32_t	init_tables_to_write_lock (RDM_TABLE_ID *)
	IDs of the tables where rows are inserted. More...

uint32_t	init_tables_to_read_lock (RDM_TABLE_ID *tables)
	IDs of the tables where rows are read. More...

RDM_RETCODE	init (RDM_DB p_db)
	Initialize this object. More...

void	reset (void)
	Reset this object. More...

template<class TARGET_ROW_T >
RDM_RETCODE	bind_row (TARGET_ROW_T *target_row)
	Bind a row. More...

RDM_RETCODE	get_rows (void)
	Get rows. More...

RDM_RETCODE	get_rows_by_key (RDM_KEY_ID key_id)
	Get rows by key. More...

template<class KEY_T >
RDM_RETCODE	get_rows_by_key (RDM_KEY_ID key_id, const KEY_T startValue, const KEY_T endValue)
	Get rows by key within a key range. More...

template<class KEY_T >
RDM_RETCODE	get_rows_by_key (RDM_KEY_ID key_id, const KEY_T *value)
	Get rows by key for a give key value. More...

template<class KEY_T >
RDM_RETCODE	get_rows_from_key (RDM_KEY_ID key_id, const KEY_T *startValue)
	Get rows by key within a key range that is open at the end. More...

template<class KEY_T >
RDM_RETCODE	get_rows_to_key (RDM_KEY_ID key_id, const KEY_T *endValue)
	Get rows by key within a key range that is open at the beginning. More...

RDM_RETCODE	get_rows_by_key (RDM_KEY_ID key_id, const RDM_RANGE_KEY startValue, const RDM_RANGE_KEY endValue)
	Get rows by key within a key range. More...

RDM_RETCODE	get_rows_by_key (RDM_KEY_ID key_id, const RDM_RANGE_KEY *value)
	Get rows by key for a give key value. More...

RDM_RETCODE	get_rows_from_key (RDM_KEY_ID key_id, const RDM_RANGE_KEY *startValue)
	Get rows by key within a key range that is open at the end. More...

RDM_RETCODE	get_rows_to_key (RDM_KEY_ID key_id, const RDM_RANGE_KEY *endValue)
	Get rows by key within a key range that is open at the beginning. More...

RDM_RETCODE	get_rows_by_key (RDM_KEY_ID key_id, const RDM_SEARCH_KEY startValue, const RDM_SEARCH_KEY endValue)
	Get rows by key within a key range. More...

RDM_RETCODE	get_rows_by_key (RDM_KEY_ID key_id, const RDM_SEARCH_KEY *value)
	Get rows by key for a give key value. More...

RDM_RETCODE	get_rows_from_key (RDM_KEY_ID key_id, const RDM_SEARCH_KEY *startValue)
	Get rows by key within a key range that is open at the end. More...

RDM_RETCODE	get_rows_to_key (RDM_KEY_ID key_id, const RDM_SEARCH_KEY *endValue)
	Get rows by key within a key range that is open at the beginning. More...

RDM_RETCODE	get_rows_by_rtree_key (RDM_KEY_ID key_id, const RDM_RTREE_KEY *value)
	Get rows by an R-tree key. More...

RDM_RETCODE	fetch_first (void)
	Fetch the first row. More...

RDM_RETCODE	fetch_prev (void)
	Fetch the previouse row. More...

RDM_RETCODE	fetch_next (void)
	Fetch the next row. More...

RDM_RETCODE	fetch_last (void)
	Fetch the first row. More...

Static Public Member Functions
constexpr static int	get_serialize_size (void)
	Get the size of a buffer for serialization to hold its state. More...

constexpr static int	number_of_tables_to_write_lock (void)
	Number of tables where rows are inserted. More...

constexpr static int	number_of_tables_to_read_lock (void)
	Number of tables where rows are read. More...

Data Fields
RDM_DB	db

RDM_CURSOR	cursor

void *	target_row

uint32_t	target_size

Friends
template<RDM_TABLE_ID any_table_id, class ANY_NEXT >
class	join_rows_to_many

template<RDM_TABLE_ID any_table_id, class ANY_NEXT >
class	join_rows_to_one

Detailed Description

template<RDM_TABLE_ID table_id>
class RDM::DB::read_row< table_id >

Template Class for reading a row.

Template class for reading rows from a table specifed by the template parameter table_id.

Initialize the class by calling init() with a valid database handle. Bind an application row buffer using bind_row(). A set of rows from the table specified by the template parameter

Template Parameters

table_id with a given order can be associated by calling any of the following methods: get_rows_by_key(), TBD.

The application row buffer will be populated when any of the navigational fetch methods are called such as fetch_first(), fetch_prev(), fetch_next(), or fetch_last().

This class can be used in a chain of template classes for doing a join or a series of nested joins where this class is the last class in the chain. When this class is used in a chain of classes the navigational fetch methods for this class should normally not be called directly. The application should instead call the navigational fetch methods of thse first class the chain. The other classes in the chain will fetch from its next class when additional rows are needed. See RaimaDB Database Query APIs for details.

Template Parameters

table_id The ID of the table to read rows from

Constructor & Destructor Documentation

read_row() [1/2]

template<RDM_TABLE_ID table_id>

RDM::DB::read_row< table_id >::read_row ( const read_row< table_id > & r )

inline

 : cursor (NULL), target_row (NULL)
 {
 }

read_row() [2/2]

template<RDM_TABLE_ID table_id>

RDM::DB::read_row< table_id >::read_row ( )

inline

 : cursor (NULL), target_row (NULL)
 {
 }

~read_row()

template<RDM_TABLE_ID table_id>

RDM::DB::read_row< table_id >::~read_row ( )

inline

 {
if (cursor)
 {
rdm_cursorFree (cursor);
 }
 }

References RDM::DB::read_row< table_id >::cursor, and rdm_cursorFree().

Here is the call graph for this function:

Member Function Documentation

bind_row()

template<RDM_TABLE_ID table_id>

template<class TARGET_ROW_T >

RDM_RETCODE RDM::DB::read_row< table_id >::bind_row ( TARGET_ROW_T * target_row )

inline

Bind a row.

Bind an application target row. For each row that is fetched one actual row in that set will be populated into the buffers specified here.

Only one buffer is provided here as opposed to other classes.

Template Parameters

TARGET_ROW_T The type for the application target row struct definition

Return values

sOKAY Normal, successful return.

Parameters

[in] target_row The target the rows are fetched into

 {
read_row::target_row = target_row;
target_size = sizeof (TARGET_ROW_T);

return sOKAY;
 }

References sOKAY, RDM::DB::read_row< table_id >::target_row, and RDM::DB::read_row< table_id >::target_size.

fetch()

template<RDM_TABLE_ID table_id>

RDM_RETCODE RDM::DB::read_row< table_id >::fetch	(	direction	dir,
		bool	first_or_last
	)

inline

Fetch a row.

A generalized fetch which is the actual methode used by other classes when this class is set up in a chain.

Return values

sOKAY	Normal, successful return.
sENDOFCURSOR	Reached the end of the cursor collection.
eINVITERATION	Invalid attempt to move cursor before 'BeforeFirst' or past 'AfterLast'.
eNOSTARTREAD	A read operation was attempted when no rdm_dbStartSnapshot(), rdm_dbStartRead(), or rdm_dbStartUpdate() is active.
eNOTLOCKED	Attempt to access a table for reading or update without proper locks.
eDBNOTOPEN	Database not open.
eCATMISMATCH	Catalog in memory does not match Catalog on disk.
eNOCURRENTROW	The cursor is not positioned to a valid row.
eOWNERDELETED	The owner row for a set cursor has been deleted.
eSINGLETONDELETED	The row for a singleton cursor has been deleted.

Parameters

[in]	dir	The direction we are fetching
[in]	first_or_last	Wheter we are fetching one of the extremes such as the first or the last as opposed to the next or the previous

 {
RDM_RETCODE rc;
if (first_or_last)
 {
if (dir == direction_forward)
 {
 rc = fetch_first ();
 }
else
 {
 rc = fetch_last ();
 }
 }
else
 {
if (dir == direction_forward)
 {
 rc = fetch_next ();
 }
else
 {
 rc = fetch_prev ();
 }
 }

return rc;
 }

References RDM::DB::direction_forward, RDM::DB::read_row< table_id >::fetch_first(), RDM::DB::read_row< table_id >::fetch_last(), RDM::DB::read_row< table_id >::fetch_next(), and RDM::DB::read_row< table_id >::fetch_prev().

Here is the call graph for this function:

fetch_first()

template<RDM_TABLE_ID table_id>

RDM_RETCODE RDM::DB::read_row< table_id >::fetch_first ( void )

inline

Fetch the first row.

Fetch the first row from the actual table. This navigation is done independent of any previously set position. A new position will be establshed for a successfull return.

If a row has been bound using bind_row() the row will be read and poputated into the buffers provided.

Return values

sOKAY	Normal, successful return.
sENDOFCURSOR	Reached the end of the cursor collection.
eINVITERATION	Invalid attempt to move cursor before 'BeforeFirst' or past 'AfterLast'.
eNOSTARTREAD	A read operation was attempted when no rdm_dbStartSnapshot(), rdm_dbStartRead(), or rdm_dbStartUpdate() is active.
eNOTLOCKED	Attempt to access a table for reading or update without proper locks.
eDBNOTOPEN	Database not open.
eCATMISMATCH	Catalog in memory does not match Catalog on disk.
eNOCURRENTROW	The cursor is not positioned to a valid row.
eOWNERDELETED	The owner row for a set cursor has been deleted.
eSINGLETONDELETED	The row for a singleton cursor has been deleted.

 {
RDM_RETCODE rc = rdm_cursorMoveToFirst (cursor);
if (rc == sOKAY && this->target_row)
 {
 rc = rdm_cursorReadRow (cursor, this->target_row, target_size, NULL);
 }

return rc;
 }

References RDM::DB::read_row< table_id >::cursor, rdm_cursorMoveToFirst(), rdm_cursorReadRow(), sOKAY, and RDM::DB::read_row< table_id >::target_size.

Referenced by RDM::DB::read_row< table_id >::fetch().

Here is the call graph for this function:

Here is the caller graph for this function:

fetch_last()

template<RDM_TABLE_ID table_id>

RDM_RETCODE RDM::DB::read_row< table_id >::fetch_last ( void )

inline

Fetch the first row.

Fetch the first row from the actual table. This navigation is done independent of any previously set position. A new position will be establshed for a successfull return.

If a row has been bound using bind_row() the row will be read and poputated into the buffers provided.

Return values

sOKAY	Normal, successful return.
sENDOFCURSOR	Reached the end of the cursor collection.
eINVITERATION	Invalid attempt to move cursor before 'BeforeFirst' or past 'AfterLast'.
eNOSTARTREAD	A read operation was attempted when no rdm_dbStartSnapshot(), rdm_dbStartRead(), or rdm_dbStartUpdate() is active.
eNOTLOCKED	Attempt to access a table for reading or update without proper locks.
eDBNOTOPEN	Database not open.
eCATMISMATCH	Catalog in memory does not match Catalog on disk.
eNOCURRENTROW	The cursor is not positioned to a valid row.
eOWNERDELETED	The owner row for a set cursor has been deleted.
eSINGLETONDELETED	The row for a singleton cursor has been deleted.

 {
RDM_RETCODE rc = rdm_cursorMoveToLast (cursor);
if (rc == sOKAY && this->target_row)
 {
 rc = rdm_cursorReadRow (cursor, this->target_row, target_size, NULL);
 }

return rc;
 }

References RDM::DB::read_row< table_id >::cursor, rdm_cursorMoveToLast(), rdm_cursorReadRow(), sOKAY, and RDM::DB::read_row< table_id >::target_size.

Referenced by RDM::DB::read_row< table_id >::fetch().

Here is the call graph for this function:

Here is the caller graph for this function:

fetch_next()

template<RDM_TABLE_ID table_id>

RDM_RETCODE RDM::DB::read_row< table_id >::fetch_next ( void )

inline

Fetch the next row.

Fetch the next row from the actual table. This navigation is done based on a previously set position and a new position will be establshed for a successfull return.

If a row has been bound using bind_row() the row will be read and poputated into the buffers provided.

Return values

sOKAY	Normal, successful return.
sENDOFCURSOR	Reached the end of the cursor collection.
eINVITERATION	Invalid attempt to move cursor before 'BeforeFirst' or past 'AfterLast'.
eNOSTARTREAD	A read operation was attempted when no rdm_dbStartSnapshot(), rdm_dbStartRead(), or rdm_dbStartUpdate() is active.
eNOTLOCKED	Attempt to access a table for reading or update without proper locks.
eDBNOTOPEN	Database not open.
eCATMISMATCH	Catalog in memory does not match Catalog on disk.
eNOCURRENTROW	The cursor is not positioned to a valid row.
eOWNERDELETED	The owner row for a set cursor has been deleted.
eSINGLETONDELETED	The row for a singleton cursor has been deleted.

 {
RDM_RETCODE rc = rdm_cursorMoveToNext (cursor);
if (rc == sOKAY && this->target_row)
 {
 rc = rdm_cursorReadRow (cursor, this->target_row, target_size, NULL);
 }

return rc;
 }

References RDM::DB::read_row< table_id >::cursor, rdm_cursorMoveToNext(), rdm_cursorReadRow(), sOKAY, and RDM::DB::read_row< table_id >::target_size.

Referenced by RDM::DB::read_row< table_id >::fetch().

Here is the call graph for this function:

Here is the caller graph for this function:

fetch_prev()

template<RDM_TABLE_ID table_id>

RDM_RETCODE RDM::DB::read_row< table_id >::fetch_prev ( void )

inline

Fetch the previouse row.

Fetch the previous row from the actual table. This navigation is done based on a previously set position and a new position will be establshed for a successfull return.

If a row has been bound using bind_row() the row will be read and poputated into the buffers provided.

Return values

sOKAY	Normal, successful return.
sENDOFCURSOR	Reached the end of the cursor collection.
eINVITERATION	Invalid attempt to move cursor before 'BeforeFirst' or past 'AfterLast'.
eNOSTARTREAD	A read operation was attempted when no rdm_dbStartSnapshot(), rdm_dbStartRead(), or rdm_dbStartUpdate() is active.
eNOTLOCKED	Attempt to access a table for reading or update without proper locks.
eDBNOTOPEN	Database not open.
eCATMISMATCH	Catalog in memory does not match Catalog on disk.
eNOCURRENTROW	The cursor is not positioned to a valid row.
eOWNERDELETED	The owner row for a set cursor has been deleted.
eSINGLETONDELETED	The row for a singleton cursor has been deleted.

 {
RDM_RETCODE rc = rdm_cursorMoveToPrevious (cursor);

if (rc == sOKAY && this->target_row)
 {
 rc = rdm_cursorReadRow (cursor, this->target_row, target_size, NULL);
 }

return rc;
 }

References RDM::DB::read_row< table_id >::cursor, rdm_cursorMoveToPrevious(), rdm_cursorReadRow(), sOKAY, and RDM::DB::read_row< table_id >::target_size.

Referenced by RDM::DB::read_row< table_id >::fetch().

Here is the call graph for this function:

Here is the caller graph for this function:

get_rows()

template<RDM_TABLE_ID table_id>

RDM_RETCODE RDM::DB::read_row< table_id >::get_rows ( void )

inline

Get rows.

Set up this class to get the rows from a give table.

Return values

sOKAY	Normal, successful return.
eINVTABID	Invalid table id.
eDBNOTOPEN	Database not open.
ePRECOMMITTED	A precommitted transaction must be committed or rolled back before further operations on this database are allowed.

 {
RDM_RETCODE rc = rdm_dbGetRows (db, table_id, &cursor);
return rc;
 }

References RDM::DB::read_row< table_id >::cursor, RDM::DB::read_row< table_id >::db, and rdm_dbGetRows().

Here is the call graph for this function:

get_rows_by_key() [1/7]

template<RDM_TABLE_ID table_id>

RDM_RETCODE RDM::DB::read_row< table_id >::get_rows_by_key ( RDM_KEY_ID key_id )

inline

Get rows by key.

Set up this class to get the rows in key order.

Return values

sOKAY	Normal, successful return.
eDBNOTOPEN	Database not open.
eINVKEYID	Invalid key id.
eISRTREE	The key specified is an rtree index.
ePRECOMMITTED	A precommitted transaction must be committed or rolled back before further operations on this database are allowed.

Parameters

[in] key_id The key ID for which key to order the rows

 {
RDM_RETCODE rc = rdm_dbGetRowsByKey (db, key_id, &cursor);
return rc;
 }

References RDM::DB::read_row< table_id >::cursor, RDM::DB::read_row< table_id >::db, and rdm_dbGetRowsByKey().

Here is the call graph for this function:

get_rows_by_key() [2/7]

template<RDM_TABLE_ID table_id>

template<class KEY_T >

RDM_RETCODE RDM::DB::read_row< table_id >::get_rows_by_key	(	RDM_KEY_ID	key_id,
		const KEY_T *	startValue,
		const KEY_T *	endValue
	)

inline

Get rows by key within a key range.

Set up this class to get the rows in key order.

Return values

sOKAY	Normal, successful return.
eDBNOTOPEN	Database not open.
eINVKEYID	Invalid key id.
eISRTREE	The key specified is an rtree index.
ePRECOMMITTED	A precommitted transaction must be committed or rolled back before further operations on this database are allowed.

Template Parameters

KEY_T The key type for the key values provided

Parameters

[in]	key_id	The key ID for which key to order the rows
[in]	startValue	The value for the start of the range
[in]	endValue	The value for the end of the range

 {
RDM_RETCODE rc = rdm_dbGetRowsByKeyInKeyRange (db, key_id, startValue, sizeof(KEY_T), endValue, sizeof (KEY_T), &cursor);
return rc;
 }

References RDM::DB::read_row< table_id >::cursor, RDM::DB::read_row< table_id >::db, and rdm_dbGetRowsByKeyInKeyRange().

Here is the call graph for this function:

get_rows_by_key() [3/7]

template<RDM_TABLE_ID table_id>

template<class KEY_T >

RDM_RETCODE RDM::DB::read_row< table_id >::get_rows_by_key	(	RDM_KEY_ID	key_id,
		const KEY_T *	value
	)

inline

Get rows by key for a give key value.

Set up this class to get the rows in key order.

Return values

sOKAY	Normal, successful return.
eDBNOTOPEN	Database not open.
eINVKEYID	Invalid key id.
eISRTREE	The key specified is an rtree index.
ePRECOMMITTED	A precommitted transaction must be committed or rolled back before further operations on this database are allowed.

Template Parameters

KEY_T The key type for the key value provided

Parameters

[in]	key_id	The key ID for which key to order the rows
[in]	value	The value to select

 {
RDM_RETCODE rc = rdm_dbGetRowsByKeyInKeyRange (db, key_id, value, sizeof(KEY_T), value, sizeof (KEY_T), &cursor);
return rc;
 }

References RDM::DB::read_row< table_id >::cursor, RDM::DB::read_row< table_id >::db, and rdm_dbGetRowsByKeyInKeyRange().

Here is the call graph for this function:

get_rows_by_key() [4/7]

template<RDM_TABLE_ID table_id>

RDM_RETCODE RDM::DB::read_row< table_id >::get_rows_by_key	(	RDM_KEY_ID	key_id,
		const RDM_RANGE_KEY *	startValue,
		const RDM_RANGE_KEY *	endValue
	)

inline

Get rows by key within a key range.

Set up this class to get the rows in key order.

Return values

sOKAY	Normal, successful return.
eDBNOTOPEN	Database not open.
eINVKEYID	Invalid key id.
eISRTREE	The key specified is an rtree index.
ePRECOMMITTED	A precommitted transaction must be committed or rolled back before further operations on this database are allowed.

Parameters

[in]	key_id	The key ID for which key to order the rows
[in]	startValue	The value for the start of the range
[in]	endValue	The value for the end of the range

 {
RDM_RETCODE rc = rdm_dbGetRowsByKeyInRangeKeyRange (db, key_id, startValue, endValue, &cursor);
return rc;
 }

References RDM::DB::read_row< table_id >::cursor, RDM::DB::read_row< table_id >::db, and rdm_dbGetRowsByKeyInRangeKeyRange().

Here is the call graph for this function:

get_rows_by_key() [5/7]

template<RDM_TABLE_ID table_id>

RDM_RETCODE RDM::DB::read_row< table_id >::get_rows_by_key	(	RDM_KEY_ID	key_id,
		const RDM_RANGE_KEY *	value
	)

inline

Get rows by key for a give key value.

Set up this class to get the rows in key order.

Return values

sOKAY	Normal, successful return.
eDBNOTOPEN	Database not open.
eINVKEYID	Invalid key id.
eISRTREE	The key specified is an rtree index.
ePRECOMMITTED	A precommitted transaction must be committed or rolled back before further operations on this database are allowed.

Parameters

[in]	key_id	The key ID for which key to order the rows
[in]	value	The value to select

 {
RDM_RETCODE rc = rdm_dbGetRowsByKeyInRangeKeyRange (db, key_id, value, value, &cursor);
return rc;
 }

References RDM::DB::read_row< table_id >::cursor, RDM::DB::read_row< table_id >::db, and rdm_dbGetRowsByKeyInRangeKeyRange().

Here is the call graph for this function:

get_rows_by_key() [6/7]

template<RDM_TABLE_ID table_id>

RDM_RETCODE RDM::DB::read_row< table_id >::get_rows_by_key	(	RDM_KEY_ID	key_id,
		const RDM_SEARCH_KEY *	startValue,
		const RDM_SEARCH_KEY *	endValue
	)

inline

Get rows by key within a key range.

Set up this class to get the rows in key order.

Return values

sOKAY	Normal, successful return.
eDBNOTOPEN	Database not open.
eINVKEYID	Invalid key id.
eISRTREE	The key specified is an rtree index.
ePRECOMMITTED	A precommitted transaction must be committed or rolled back before further operations on this database are allowed.

Parameters

[in]	key_id	The key ID for which key to order the rows
[in]	startValue	The value for the start of the range
[in]	endValue	The value for the end of the range

 {
RDM_RETCODE rc = rdm_dbGetRowsByKeyInSearchKeyRange (db, key_id, startValue, endValue, &cursor);
return rc;
 }

References RDM::DB::read_row< table_id >::cursor, RDM::DB::read_row< table_id >::db, and rdm_dbGetRowsByKeyInSearchKeyRange().

Here is the call graph for this function:

get_rows_by_key() [7/7]

template<RDM_TABLE_ID table_id>

RDM_RETCODE RDM::DB::read_row< table_id >::get_rows_by_key	(	RDM_KEY_ID	key_id,
		const RDM_SEARCH_KEY *	value
	)

inline

Get rows by key for a give key value.

Set up this class to get the rows in key order.

Return values

sOKAY	Normal, successful return.
eDBNOTOPEN	Database not open.
eINVKEYID	Invalid key id.
eISRTREE	The key specified is an rtree index.
ePRECOMMITTED	A precommitted transaction must be committed or rolled back before further operations on this database are allowed.

Parameters

[in]	key_id	The key ID for which key to order the rows
[in]	value	The value to select

 {
RDM_RETCODE rc = rdm_dbGetRowsByKeyInSearchKeyRange (db, key_id, value, value, &cursor);
return rc;
 }

References RDM::DB::read_row< table_id >::cursor, RDM::DB::read_row< table_id >::db, and rdm_dbGetRowsByKeyInSearchKeyRange().

Here is the call graph for this function:

get_rows_by_rtree_key()

template<RDM_TABLE_ID table_id>

RDM_RETCODE RDM::DB::read_row< table_id >::get_rows_by_rtree_key	(	RDM_KEY_ID	key_id,
		const RDM_RTREE_KEY *	value
	)

inline

Get rows by an R-tree key.

Set up this class to get the rows in key order.

Return values

sOKAY	Normal, successful return.
eDBNOTOPEN	Database not open.
eINVKEYID	Invalid key id.
eNOTRTREE	The key specified is not an rtree index.
ePRECOMMITTED	A precommitted transaction must be committed or rolled back before further operations on this database are allowed.

Parameters

[in]	key_id	The key ID for which key to order the rows
[in]	value	The value for the end of the range

 {
RDM_RETCODE rc = rdm_dbGetRowsByKeyInRtreeKeyRange (db, key_id, value, &cursor);
return rc;
 }

References RDM::DB::read_row< table_id >::cursor, RDM::DB::read_row< table_id >::db, and rdm_dbGetRowsByKeyInRtreeKeyRange().

Here is the call graph for this function:

get_rows_from_key() [1/3]

template<RDM_TABLE_ID table_id>

template<class KEY_T >

RDM_RETCODE RDM::DB::read_row< table_id >::get_rows_from_key	(	RDM_KEY_ID	key_id,
		const KEY_T *	startValue
	)

inline

Get rows by key within a key range that is open at the end.

Set up this class to get the rows in key order.

Return values

sOKAY	Normal, successful return.
eDBNOTOPEN	Database not open.
eINVKEYID	Invalid key id.
eISRTREE	The key specified is an rtree index.
ePRECOMMITTED	A precommitted transaction must be committed or rolled back before further operations on this database are allowed.

Template Parameters

KEY_T The key type for the key value provided

Parameters

[in]	key_id	The key ID for which key to order the rows
[in]	startValue	The value for the start of the range

 {
RDM_RETCODE rc = rdm_dbGetRowsByKeyInKeyRange (db, key_id, startValue, sizeof(KEY_T), NULL, 0, &cursor);
return rc;
 }

References RDM::DB::read_row< table_id >::cursor, RDM::DB::read_row< table_id >::db, and rdm_dbGetRowsByKeyInKeyRange().

Here is the call graph for this function:

get_rows_from_key() [2/3]

template<RDM_TABLE_ID table_id>

RDM_RETCODE RDM::DB::read_row< table_id >::get_rows_from_key	(	RDM_KEY_ID	key_id,
		const RDM_RANGE_KEY *	startValue
	)

inline

Get rows by key within a key range that is open at the end.

Set up this class to get the rows in key order.

Return values

sOKAY	Normal, successful return.
eDBNOTOPEN	Database not open.
eINVKEYID	Invalid key id.
eISRTREE	The key specified is an rtree index.
ePRECOMMITTED	A precommitted transaction must be committed or rolled back before further operations on this database are allowed.

Parameters

[in]	key_id	The key ID for which key to order the rows
[in]	startValue	The value for the start of the range

 {
RDM_RETCODE rc = rdm_dbGetRowsByKeyInRangeKeyRange (db, key_id, startValue, NULL, &cursor);
return rc;
 }

References RDM::DB::read_row< table_id >::cursor, RDM::DB::read_row< table_id >::db, and rdm_dbGetRowsByKeyInRangeKeyRange().

Here is the call graph for this function:

get_rows_from_key() [3/3]

template<RDM_TABLE_ID table_id>

RDM_RETCODE RDM::DB::read_row< table_id >::get_rows_from_key	(	RDM_KEY_ID	key_id,
		const RDM_SEARCH_KEY *	startValue
	)

inline

Get rows by key within a key range that is open at the end.

Set up this class to get the rows in key order.

Return values

sOKAY	Normal, successful return.
eDBNOTOPEN	Database not open.
eINVKEYID	Invalid key id.
eISRTREE	The key specified is an rtree index.
ePRECOMMITTED	A precommitted transaction must be committed or rolled back before further operations on this database are allowed.

Parameters

[in]	key_id	The key ID for which key to order the rows
[in]	startValue	The value for the start of the range

 {
RDM_RETCODE rc = rdm_dbGetRowsByKeyInSearchKeyRange (db, key_id, startValue, NULL, &cursor);
return rc;
 }

References RDM::DB::read_row< table_id >::cursor, RDM::DB::read_row< table_id >::db, and rdm_dbGetRowsByKeyInSearchKeyRange().

Here is the call graph for this function:

get_rows_to_key() [1/3]

template<RDM_TABLE_ID table_id>

template<class KEY_T >

RDM_RETCODE RDM::DB::read_row< table_id >::get_rows_to_key	(	RDM_KEY_ID	key_id,
		const KEY_T *	endValue
	)

inline

Get rows by key within a key range that is open at the beginning.

Set up this class to get the rows in key order.

Return values

sOKAY	Normal, successful return.
eDBNOTOPEN	Database not open.
eINVKEYID	Invalid key id.
eISRTREE	The key specified is an rtree index.
ePRECOMMITTED	A precommitted transaction must be committed or rolled back before further operations on this database are allowed.

Template Parameters

KEY_T The key type for the key value provided

Parameters

[in]	key_id	The key ID for which key to order the rows
[in]	endValue	The value for the end of the range

 {
RDM_RETCODE rc = rdm_dbGetRowsByKeyInKeyRange (db, key_id, NULL, 0, endValue, sizeof (KEY_T), &cursor);
return rc;
 }

References RDM::DB::read_row< table_id >::cursor, RDM::DB::read_row< table_id >::db, and rdm_dbGetRowsByKeyInKeyRange().

Here is the call graph for this function:

get_rows_to_key() [2/3]

template<RDM_TABLE_ID table_id>

RDM_RETCODE RDM::DB::read_row< table_id >::get_rows_to_key	(	RDM_KEY_ID	key_id,
		const RDM_RANGE_KEY *	endValue
	)

inline

Get rows by key within a key range that is open at the beginning.

Set up this class to get the rows in key order.

Return values

sOKAY	Normal, successful return.
eDBNOTOPEN	Database not open.
eINVKEYID	Invalid key id.
eISRTREE	The key specified is an rtree index.
ePRECOMMITTED	A precommitted transaction must be committed or rolled back before further operations on this database are allowed.

Parameters

[in]	key_id	The key ID for which key to order the rows
[in]	endValue	The value for the end of the range

 {
RDM_RETCODE rc = rdm_dbGetRowsByKeyInRangeKeyRange (db, key_id, NULL, endValue, &cursor);
return rc;
 }

References RDM::DB::read_row< table_id >::cursor, RDM::DB::read_row< table_id >::db, and rdm_dbGetRowsByKeyInRangeKeyRange().

Here is the call graph for this function:

get_rows_to_key() [3/3]

template<RDM_TABLE_ID table_id>

RDM_RETCODE RDM::DB::read_row< table_id >::get_rows_to_key	(	RDM_KEY_ID	key_id,
		const RDM_SEARCH_KEY *	endValue
	)

inline

Get rows by key within a key range that is open at the beginning.

Set up this class to get the rows in key order.

Return values

sOKAY	Normal, successful return.
eDBNOTOPEN	Database not open.
eINVKEYID	Invalid key id.
eISRTREE	The key specified is an rtree index.
ePRECOMMITTED	A precommitted transaction must be committed or rolled back before further operations on this database are allowed.

Parameters

[in]	key_id	The key ID for which key to order the rows
[in]	endValue	The value for the end of the range

 {
RDM_RETCODE rc = rdm_dbGetRowsByKeyInSearchKeyRange (db, key_id, NULL, endValue, &cursor);
return rc;
 }

References RDM::DB::read_row< table_id >::cursor, RDM::DB::read_row< table_id >::db, and rdm_dbGetRowsByKeyInSearchKeyRange().

Here is the call graph for this function:

get_serialize_size()

template<RDM_TABLE_ID table_id>

constexpr static int RDM::DB::read_row< table_id >::get_serialize_size ( void )

inlinestaticconstexpr

Get the size of a buffer for serialization to hold its state.

Get the size needed for a buffer to hold the state of this object.

 {
return 0;
 }

init()

template<RDM_TABLE_ID table_id>

RDM_RETCODE RDM::DB::read_row< table_id >::init ( RDM_DB p_db )

inline

Initialize this object.

Call this method before sending it any data values, ranges, or statistics.

Return values

sOKAY Normal, successful return.

Parameters

p_db	[IN] Use this database for chained classes that need to insert rows

 {
read_row::db = p_db;
return sOKAY;
 }

References RDM::DB::read_row< table_id >::db, and sOKAY.

init_tables_to_read_lock()

template<RDM_TABLE_ID table_id>

uint32_t RDM::DB::read_row< table_id >::init_tables_to_read_lock ( RDM_TABLE_ID * tables )

inline

IDs of the tables where rows are read.

Use this method to initialize an array of table IDs. This array can then be used to start a transaction where those tables are specified.

 {
 *tables = table_id;;
return 1;
 }

init_tables_to_write_lock()

template<RDM_TABLE_ID table_id>

uint32_t RDM::DB::read_row< table_id >::init_tables_to_write_lock ( RDM_TABLE_ID * )

inline

IDs of the tables where rows are inserted.

Use this method to initialize an array of table IDs. This array can then be used to start a transaction where those tables are specified.

 {
return 0;
 }

number_of_tables_to_read_lock()

template<RDM_TABLE_ID table_id>

constexpr static int RDM::DB::read_row< table_id >::number_of_tables_to_read_lock ( void )

inlinestaticconstexpr

Number of tables where rows are read.

Constant expression method used to statically calculate the size of the array needed for table locking.

 {
return 1;
 }

number_of_tables_to_write_lock()

template<RDM_TABLE_ID table_id>

constexpr static int RDM::DB::read_row< table_id >::number_of_tables_to_write_lock ( void )

inlinestaticconstexpr

Number of tables where rows are inserted.

Constant expression method used to statically calculate the size of the array needed for table locking.

 {
return 0;
 }

operator=()

template<RDM_TABLE_ID table_id>

read_row& RDM::DB::read_row< table_id >::operator= ( const read_row< table_id > & )

inline

 {
return *this;
 }

reset()

template<RDM_TABLE_ID table_id>

void RDM::DB::read_row< table_id >::reset ( void )

inline

Reset this object.

Calling this method to discard all internally kept data values, ranges, and statistics that have not yet been persisted and start over from scratch.

Any alternative implementation of this method in a sub class would call this method to reset the next class.

 {
 (void) rdm_cursorMoveToBeforeFirst (cursor);
 }

References RDM::DB::read_row< table_id >::cursor, and rdm_cursorMoveToBeforeFirst().

Here is the call graph for this function:

serialize()

template<RDM_TABLE_ID table_id>

uint8_t* RDM::DB::read_row< table_id >::serialize ( uint8_t * buffer )

inline

 {
return buffer;
 }

unserialize()

template<RDM_TABLE_ID table_id>

uint8_t* RDM::DB::read_row< table_id >::unserialize ( uint8_t * buffer )

inline

 {
return buffer;
 }

Friends And Related Function Documentation

join_rows_to_many

template<RDM_TABLE_ID table_id>

template<RDM_TABLE_ID any_table_id, class ANY_NEXT >

friend class join_rows_to_many

friend

join_rows_to_one

template<RDM_TABLE_ID table_id>

template<RDM_TABLE_ID any_table_id, class ANY_NEXT >

friend class join_rows_to_one

friend

Field Documentation

cursor

template<RDM_TABLE_ID table_id>

RDM_CURSOR RDM::DB::read_row< table_id >::cursor

The cursor we use for navigating and reading rows

db

template<RDM_TABLE_ID table_id>

RDM_DB RDM::DB::read_row< table_id >::db

The database we use for reading

Referenced by RDM::DB::read_row< table_id >::get_rows(), RDM::DB::read_row< table_id >::get_rows_by_key(), RDM::DB::read_row< table_id >::get_rows_by_rtree_key(), RDM::DB::read_row< table_id >::get_rows_from_key(), RDM::DB::read_row< table_id >::get_rows_to_key(), and RDM::DB::read_row< table_id >::init().

target_row

template<RDM_TABLE_ID table_id>

void* RDM::DB::read_row< table_id >::target_row

The target row we write eche row we read into

Referenced by RDM::DB::read_row< table_id >::bind_row().

target_size

template<RDM_TABLE_ID table_id>

uint32_t RDM::DB::read_row< table_id >::target_size

The size of the target row

Referenced by RDM::DB::read_row< table_id >::bind_row(), RDM::DB::read_row< table_id >::fetch_first(), RDM::DB::read_row< table_id >::fetch_last(), RDM::DB::read_row< table_id >::fetch_next(), and RDM::DB::read_row< table_id >::fetch_prev().

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

rdm_db_read_row.h

Public Member Functions

Static Public Member Functions

Data Fields

Friends

Detailed Description

template<RDM_TABLE_ID table_id> class RDM::DB::read_row< table_id >

Constructor & Destructor Documentation

read_row() [1/2]

read_row() [2/2]

~read_row()

Member Function Documentation

bind_row()

fetch()

fetch_first()

fetch_last()

fetch_next()

fetch_prev()

get_rows()

get_rows_by_key() [1/7]

get_rows_by_key() [2/7]

get_rows_by_key() [3/7]

get_rows_by_key() [4/7]

get_rows_by_key() [5/7]

get_rows_by_key() [6/7]

get_rows_by_key() [7/7]

get_rows_by_rtree_key()

get_rows_from_key() [1/3]

get_rows_from_key() [2/3]

get_rows_from_key() [3/3]

get_rows_to_key() [1/3]

get_rows_to_key() [2/3]

get_rows_to_key() [3/3]

get_serialize_size()

init()

init_tables_to_read_lock()

init_tables_to_write_lock()

number_of_tables_to_read_lock()

number_of_tables_to_write_lock()

operator=()

reset()

serialize()

unserialize()

Friends And Related Function Documentation

join_rows_to_many

join_rows_to_one

Field Documentation

cursor

db

target_row

target_size

template<RDM_TABLE_ID table_id>
class RDM::DB::read_row< table_id >