c-core/15_core/core15Example_main.c
/*
 * CIRCULAR TABLE
 * --------------
 * This document describes the process to create a circular record in a
 * database, insert a circular record, and read data from this database.
 */
 
#include "rdm.h" /* The RDM API.                 */
#include "rdmapi.h"
#include "rdmtfsapi.h"
#include "circular_table_structs.h" /* The one_to_many database definitions. */
#include "circular_table_cat.h"
#include "rdmstartupapi.h"
 
#include <stdio.h>
#include <stdlib.h>
 
static const ALBUM albums[] = {{"Eric Dolphy"RDM_COL_HAS_VALUE},
                               {"Miles Davis"RDM_COL_HAS_VALUE},
                               {"Charles Mingus"RDM_COL_HAS_VALUE},
                               {"Chico Hamilton"RDM_COL_HAS_VALUE},
                               {"John Coltrane"RDM_COL_HAS_VALUE}};
 
int32_t main_circular_tableTutorial (int32_t argc, const char *const *argv)
{
    RDM_RETCODE rc;
    RDM_TFS tfs;
 
    RDM_UNREF (argc);
    RDM_UNREF (argv);
 
    /* Allocate a TFS Handle */
    rc = rdm_rdmAllocTFS (&tfs);
    if (rc == sOKAY)
    {
        rc = rdm_tfsInitialize (tfs);
        if (rc == sOKAY)
        {
            RDM_DB db;
            /* Allocate a database hande */
            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_ALBUM};
                uint32_t ii;
 
                rc = rdm_dbSetCatalog (db, circular_table_cat);
                if (rc == sOKAY)
                {
                    /* Open the database. */
                    rc = rdm_dbOpen (db, "circular_table"RDM_OPEN_SHARED);
                    if (rc != sOKAY)
                    {
                        printf ("I can't open the circular_table 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);
                    }
                }
 
                /* Insert rows into the circular table */
                for (ii = 0; ii < RDM_LEN (albums) && rc == sOKAY; ii++)
                {
                    RDM_CURSOR cursor = NULL;
 
                    /* Start an update transaction and lock the table */
                    rc = rdm_dbStartUpdate (
                        db, tables, RDM_LEN (tables), NULL, 0, NULL);
                    if (rc == sOKAY)
                    {
                        rc = rdm_dbInsertRow (
                            db, TABLE_ALBUM, &albums[ii], sizeof (albums[ii]),
                            NULL);
 
                        if (rc == sOKAY)
                        {
                            /* Commit a transaction */
                            rc = rdm_dbEnd (db);
                        }
                        else
                        {
                            /* Abort the transaction */
                            rdm_dbEndRollback (db);
                        }
                    }
 
                    /* Read and dump all album records. */
                    if (rc == sOKAY)
                    {
                        printf ("\nDUMPING ALL ROWS\n");
                        rc = rdm_dbGetRows (db, TABLE_ALBUM, &cursor);
                    }
                    if (rc == sOKAY)
                    {
                        /* Lock the table for reading */
                        rc = rdm_dbStartRead (
                            db, tables, RDM_LEN (tables), NULL);
                        if (rc == sOKAY)
                        {
                            for (rc = rdm_cursorMoveToFirst (cursor);
                                 rc == sOKAY;
                                 rc = rdm_cursorMoveToNext (cursor))
                            {
                                ALBUM sAlbum;
                                rc = rdm_cursorReadRow (
                                    cursor, &sAlbum, sizeof (sAlbum), NULL);
                                if (rc == sOKAY)
                                {
                                    printf ("   %s\n", sAlbum.artist);
                                }
                            }
                            /* Reset the rc value, the for loop will end with a
                             * sENDOFCURSOR when there are no more rows. */
                            if (rc == sENDOFCURSOR/*lint !e850 */
                            {
                                rc = sOKAY;
                            }
 
                            /* Free the read locks */
                            rdm_dbEnd (db);
                        }
 
                        /* Free the cursor */
                        rdm_cursorFree (cursor);
                    }
                }
                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 (circular_tableTutorial)
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.