RDM Database APIs

Collaboration diagram for RDM Database APIs:

Modules
	RDM Database Query APIs

Data Structures
class	RDM::DB::insert_row< table_id >
	Template Class for inserting a row. More...
class	RDM::DB::read_row< table_id >
	Template Class for reading a row. More...
class	RDM::DB::transaction< NEXT >
	Template Class for doing transactions. More...

Enumerations
enum	RDM::DB::direction { RDM::DB::direction_forward = 1, RDM::DB::direction_backward = -1 }
	The direction for a fetch. More...
enum	RDM::DB::TRANSACTIONAL_T { RDM::DB::TRANSACTIONAL, RDM::DB::NOT_TRANSACTIONAL }
	Whether the operation is required to be transactional. More...

Detailed Description

The RDM Database API contains a set of (template) classes used for transaction handling for RDM, inserting data into RDM, and reading and querying data from RDM.

Enumeration Type Documentation

direction

enum RDM::DB::direction

#include <rdm_db.h>

The direction for a fetch.

Enumerator
direction_forward	The direction for a fetch is forward, meaning that first or next is fetched
direction_backward	The direction for a fetch is backward, meaning that last or prev is fetched

                      {
direction_forward = 1, 
direction_backward = -1, 
         } direction;

TRANSACTIONAL_T

enum RDM::DB::TRANSACTIONAL_T

#include <rdm_db_transaction.h>

Whether the operation is required to be transactional.

An operation is either transactional or not. In other words, either everything was done successfully, or nothing if an error occurred.

Enumerator
TRANSACTIONAL	The operation is transactional
NOT_TRANSACTIONAL	The operation is not transactional

         {
TRANSACTIONAL, 
NOT_TRANSACTIONAL 
         } TRANSACTIONAL_T;