c-core/01_helloworld_c/core01Example_main.c
/*
 * HELLO WORLD
 * -----------
 *
 * This document describes the process to create a simple database,
 * insert a record containing a text field, read the text field from
 * database and print it out.
 */
 
#include "rdm.h"                 /* The RDM API. */
#include "hello_world_structs.h" /* The hello_world database definitions. */
#include "hello_world_cat.h"     /* The hello_world database catalog */
#include "rdmstartupapi.h"
 
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
 
/* Read "helloworld" row to database */
static RDM_RETCODE readARow (RDM_DB db)
{
    RDM_TABLE_ID tables[] = {TABLE_INFO};
    RDM_RETCODE rc;
 
    /* Start an update transaction and lock the table */
    rc = rdm_dbStartRead (db, tables, RDM_LEN (tables), NULL);
    if (rc == sOKAY)
    {
        RDM_CURSOR cursor;
 
        rc = rdm_dbAllocCursor (db, &cursor);
        if (rc == sOKAY)
        {
            /* Fill a cursor with all the rows in a table */
            rc = rdm_dbGetRows (db, TABLE_INFO, &cursor);
            if (rc == sOKAY)
            {
                /* Move to the first row in the info table */
                rc = rdm_cursorMoveToFirst (cursor);
            }
            if (rc == sOKAY)
            {
                INFO infoRead; /* Row buffer */
 
                /* Read the full content of the current record */
                rc = rdm_cursorReadRow (
                    cursor, &infoRead, sizeof (infoRead), NULL);
                if (rc == sOKAY)
                {
                    printf ("%s\n", infoRead.mychar);
                }
            }
            /* Free the cursor */
            rdm_cursorFree (cursor);
        }
        /* Free the read lock on the table */
        rdm_dbEnd (db);
    }
    return rc;
}
 
/* Insert "helloworld" row to database */
static RDM_RETCODE writeARow (RDM_DB db)
{
    RDM_TABLE_ID tables[] = {TABLE_INFO};
    RDM_RETCODE rc;
 
    /* Start an update transaction and lock the table */
    rc = rdm_dbStartUpdate (db, tables, RDM_LEN (tables), NULL, 0, NULL);
    if (rc == sOKAY)
    {
        INFO infoInserted; /* Row buffer */
 
        /* Populate the mychar column in the Row buffer */
        strcpy (infoInserted.mychar, "Hello World! - using the embedded TFS");
 
        /* Insert a row into the table */
        rc = rdm_dbInsertRow (
            db, TABLE_INFO, &infoInserted, sizeof (infoInserted), NULL);
        if (rc == sOKAY)
        {
            /* Commit a transaction */
            rc = rdm_dbEnd (db);
        }
        else
        {
            /* Abort the transaction */
            rdm_dbEndRollback (db);
        }
    }
    return rc;
}
 
int32_t main_hello_worldTutorial (int32_t argc, const char *const *argv)
{
    RDM_RETCODE rc; /* Status/Error Return Code */
    RDM_TFS tfs;    /* TFS Handle */
 
    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; /* Database Handle */
            rc = rdm_tfsDropDatabase (tfs, "hello_world");
            if (rc == sNODB)
            {
                /* It is okay if there wasn't a database to drop */
                rc = sOKAY;
            }
            if (rc == sOKAY)
            {
                /* 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)
            {
                /* Associate the catalog with the database handle */
                rc = rdm_dbSetCatalog (db, hello_world_cat);
 
                if (rc == sOKAY)
                {
                    /* Open the database */
                    rc = rdm_dbOpen (db, "hello_world"RDM_OPEN_SHARED);
                    if (rc != sOKAY)
                    {
                        printf ("I can't open the hello_world database.\n");
                    }
                }
                if (rc == sOKAY)
                {
                    /* Insert "helloworld" row to database */
                    rc = writeARow (db);
                    if (rc == sOKAY)
                    {
                        /* Read "helloworld" row to database */
                        rc = readARow (db);
                    }
                    rdm_dbClose (db);
                }
                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 (hello_worldTutorial)
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_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.
RDM_RETCODE rdm_dbEnd(RDM_DB db)
End a transactional operation.
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.
@ sNODB
Definition: rdmretcodetypes.h:82
RDM_RETCODE rdm_dbClose(RDM_DB db)
Close the database associated with a database handle.
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.
#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.
RDM_RETCODE rdm_dbAllocCursor(RDM_DB db, RDM_CURSOR *pCursor)
Allocate a cursor.
#define RDM_UNREF(a)
Definition: psptypes.h:45
@ RDM_OPEN_SHARED
Definition: rdmtypes.h:253
RDM_RETCODE rdm_tfsDropDatabase(RDM_TFS tfs, const char *dbNameSpec)
Drop the specified database.
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_LEN(x)
Definition: psptypes.h:78
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.