c-core/32_core/core32Example_main.c
/*
 * TRANSACTIONS
 * ------------
 *
 * This document describes the process to create a simple database
 * that stores data using transactions. We'll insert a hundred records
 * in the table, and verify by counting the number of records stored
 * in the database.
 *
 */
 
#include "rdm.h" /* The RDM API.                   */
#include "rdmapi.h"
#include "rdmtfsapi.h"
#include "transactions_structs.h" /* The transaction database definitions.   */
#include "transactions_cat.h"
#include "rdmstartupapi.h"
 
#include <stdio.h>
#include <stdlib.h>
 
int32_t main_transactionsTutorial (int32_t argc, const char *const *argv)
{
    RDM_RETCODE rc; /*lint -esym(850,iStatus) */
    RDM_TFS tfs;
 
    RDM_UNREF (argc);
    RDM_UNREF (argv);
 
    /* Allocate a TFS Handle */
    rc = rdm_rdmAllocTFS (&tfs);
    if (rc == sOKAY)
    {
        rc = rdm_tfsInitialize (tfs);
 
    /* Allocate a database hande */
        if (rc == sOKAY)
        {
            RDM_DB db;
            rc = rdm_tfsAllocDatabase (tfs, &db);
            if (rc == sOKAY)
            {
                /* Override default DURABLE setting to CONSISTENT */
                rc = rdm_dbSetOptions (db, "durability=consistent");
            }
            if (rc == sOKAY)
            {
                RDM_TABLE_ID tables[] = {TABLE_INFO};
                int32_t iTrans;
                int32_t iCnt;
 
                rc = rdm_dbSetCatalog (db, transactions_cat);
 
                if (rc == sOKAY)
                {
                    /* Open the database. */
                    rc = rdm_dbOpen (db, "transactions"RDM_OPEN_SHARED);
                    if (rc != sOKAY)
                    {
                        printf ("Can't open the transaction database.");
                    }
                }
                if (rc == sOKAY)
                {
                    /* Start an update transaction and lock the table */
                    rc = rdm_dbStartUpdate (
                        db, tables, RDM_LEN (tables), NULL, 0, NULL);
                }
                if (rc == sOKAY)
                {
                    /* Remove all of the rows from the database */
                    rc = rdm_dbDeleteAllRowsFromDatabase (db);
 
                    if (rc == sOKAY)
                    {
                        /* Commit a transaction */
                        rc = rdm_dbEnd (db);
                    }
                    else
                    {
                        /* Abort the transaction */
                        rdm_dbEndRollback (db);
                    }
                }
 
                /* Loop to group 10 records into 10 different transactions. */
                for (iTrans = 0; iTrans < 10 && rc == sOKAY; iTrans++)
                {
                    /* Start a transaction. */
                    rc = rdm_dbStartUpdate (
                        db, tables, RDM_LEN (tables), NULL, 0, NULL);
                    if (rc == sOKAY)
                    {
                        for (iCnt = 0; iCnt < 10 && rc == sOKAY; iCnt++)
                        {
                            INFO sInfo;
 
                            /* Insert a new row into the INFO table */
                            sprintf (
                                sInfo.mystr, "Inserted %d Transaction %d", iCnt,
                                iTrans);
                            sInfo._mystr_has_value = RDM_COL_HAS_VALUE;
                            rc = rdm_dbInsertRow (
                                db, TABLE_INFO, &sInfo, sizeof (sInfo), NULL);
                        }
 
                        if (rc == sOKAY)
                        {
                            /* Commit the transaction */
                            rc = rdm_dbEnd (db);
                        }
                        else
                        {
                            /* Something is wrong, rollback the transaction */
                            rdm_dbEndRollback (db);
                        }
                    }
                }
 
                if (rc == sOKAY)
                {
                    /* Start a transaction on the */
                    rc = rdm_dbStartRead (db, tables, RDM_LEN (tables), NULL);
                }
                if (rc == sOKAY)
                {
                    RDM_CURSOR cursor = NULL;
                    iCnt = 0;
 
                    /* Get a cursor containing all the rows in the INFO table */
                    rc = rdm_dbGetRows (db, TABLE_INFO, &cursor);
 
                    if (rc == sOKAY)
                    {
                        for (rc = rdm_cursorMoveToFirst (cursor); rc == sOKAY;
                             rc = rdm_cursorMoveToNext (cursor))
                        {
                            INFO sInfo;
 
                            /* Read and print the INFO record. */
                            rc = rdm_cursorReadRow (
                                cursor, &sInfo, sizeof (sInfo), NULL);
                            if (rc == sOKAY)
                            {
                                printf ("%s\n", sInfo.mystr);
                            }
 
                            iCnt++;
                        }
 
                        /* We expect to break out of the loop with a return code
                         * of sENDOFCURSOR */
                        if (rc == sENDOFCURSOR)
                        {
                            rc = sOKAY;
                        }
 
                        /* Free the cursor allocated by rdm_dbGetRows */
                        rdm_cursorFree (cursor);
                    }
 
                    /* Free the read lock */
                    rdm_dbEnd (db);
                }
                printf ("\n");
                if (rc == sOKAY)
                {
                    printf ("I found %d INFO records in the database\n", iCnt);
                }
                rdm_dbFree (db);
            }
        }
        rdm_tfsFree (tfs);
    }
 
    if (rc != sOKAY)
    {
        printf (
            "There was an error in this Tutorial (%s - %s)\n",
            rdm_retcodeGetName (rc), rdm_retcodeGetDescription (rc));
        return EXIT_FAILURE;
    }
 
    return EXIT_SUCCESS;
}
 
RDM_STARTUP_EXAMPLE (transactionsTutorial)
RDM_RETCODE rdm_cursorMoveToFirst(RDM_CURSOR cursor)
Position a cursor to the first row in the collection.
const char * rdm_retcodeGetName(RDM_RETCODE retcode)
Get the mnemonic name for an error or status code.
RDM_RETCODE rdm_cursorMoveToNext(RDM_CURSOR cursor)
Position a cursor to the next row in the collection.
RDM_RETCODE rdm_dbSetOptions(RDM_DB db, const char *optString)
Set RDM options.
Header for the native RDM Runtime API.
RDM_RETCODE rdm_rdmAllocTFS(RDM_TFS *phTFS)
Allocate a TFS handle.
Header for the RDM Core API.
RDM_RETCODE rdm_dbEnd(RDM_DB db)
End a transactional operation.
RDM_RETCODE rdm_dbDeleteAllRowsFromDatabase(RDM_DB db)
Remove all rows from a database.
struct RDM_CURSOR_S * RDM_CURSOR
Definition: rdmtypes.h:304
RDM_RETCODE rdm_dbStartRead(RDM_DB db, const RDM_TABLE_ID *tableIds, uint32_t numTableIds, RDM_TRANS *pTrans)
Get read locks.
RDM_RETCODE rdm_cursorReadRow(RDM_CURSOR cursor, void *colValues, size_t bytesIn, size_t *bytesOut)
Read all columns from a row.
RDM_RETCODE rdm_dbSetCatalog(RDM_DB db, const char *catalog)
Associate a catalog with an allocated database.
uint32_t RDM_TABLE_ID
Definition: rdmtypes.h:27
RDM_RETCODE rdm_dbFree(RDM_DB db)
Free a database handle.
RDM_RETCODE rdm_dbOpen(RDM_DB db, const char *dbNameSpec, RDM_OPEN_MODE mode)
Open an existing RDM database using the specified database handle.
@ sOKAY
Definition: rdmretcodetypes.h:95
RDM_RETCODE rdm_cursorFree(RDM_CURSOR cursor)
Free an RDM_CURSOR.
RDM_RETCODE rdm_tfsAllocDatabase(RDM_TFS tfs, RDM_DB *pDb)
Allocate memory for a new RDM db.
Header for the Transactional File Server (TFS) API.
#define RDM_STARTUP_EXAMPLE(name)
Definition: rdmstartuptypes.h:73
RDM_RETCODE rdm_dbGetRows(RDM_DB db, RDM_TABLE_ID tableId, RDM_CURSOR *pCursor)
Associate an RDM_CURSOR with rows based on a table id.
const char * rdm_retcodeGetDescription(RDM_RETCODE retcode)
Invoke RDM error handler.
RDM_RETCODE rdm_dbEndRollback(RDM_DB db)
End and rollback a transactional operation.
#define RDM_UNREF(a)
Definition: psptypes.h:45
@ RDM_OPEN_SHARED
Definition: rdmtypes.h:253
RDM_RETCODE rdm_dbInsertRow(RDM_DB db, RDM_TABLE_ID tableId, const void *colValues, size_t bytesIn, RDM_CURSOR *pCursor)
Insert a new row into a table at the specified rowId.
struct RDM_TFS_S * RDM_TFS
RDM TFS Handle.
Definition: rdmtfstypes.h:21
struct RDM_DB_S * RDM_DB
Definition: rdmtypes.h:303
RDM_RETCODE rdm_tfsFree(RDM_TFS hTFS)
Terminate a TFS service.
RDM_RETCODE rdm_dbStartUpdate(RDM_DB db, const RDM_TABLE_ID *writeTableIds, uint32_t numWriteTableIds, const RDM_TABLE_ID *readTableIds, uint32_t numReadTableIds, RDM_TRANS *pTrans)
Get write locks.
#define RDM_COL_HAS_VALUE
Definition: rdmtypes.h:189
#define RDM_LEN(x)
Definition: psptypes.h:78
@ sENDOFCURSOR
Definition: rdmretcodetypes.h:58
Internal RDM Startup API used by startup macros.
RDM_RETCODE
RDM status and error return codes.
Definition: rdmretcodetypes.h:43
RDM_RETCODE rdm_tfsInitialize(RDM_TFS tfs)
Initialize a RDM_TFS instance.