c-core/13_core/core13Example_main.c
/*
 * Raima Database Manager
 *
 * Copyright (c) 2019 Raima Inc.,  All rights reserved.
 *
 * Use of this software, whether in source code format, or in executable,
 * binary object code form, is governed by the Raima LICENSE which
 * is fully described in the LICENSE.TXT file, included within this
 * distribution of files.
 */
 
#include <stdio.h>
#include <string.h>
#include "example_fcns.h"
#include "rdm.h"
#include "rdmstartupapi.h"
 
/* Generated \c struct and \c typedef definitions to be used with the RDM APIs
 */
#include "core13_structs.h"
 
/* Generated catalog definition to be used with the RDM rdm_dbSetCatalog() API
 */
#include "core13_cat.h"
 
const char *const description = "Demonstrates using an index for ordering";
const RDM_CMDLINE_OPT opts[] = {{NULL, NULL, NULL, NULL}};
 
RDM_RETCODE display_offices (RDM_DB hDB) 
{
    RDM_RETCODE rc;
    OFFICE office_rec;
    RDM_CURSOR cursor = NULL;
    RDM_TRANS hTRN;
 
    rc = rdm_dbStartRead (hDB, RDM_LOCK_ALL, 0, &hTRN);
    if (rc == eUNAVAIL)
    {
        puts("The OFFICE table is not available for READ because of a WRITE lock.");
    }
    else
    {
        print_error(rc);
    }
 
    if (rc == sOKAY)
    {
        /* The following cursor association call will allocate the cursor
         *  if the cursor is set to NULL. This short-cut can eliminate the
         *  requirement to call rdm_dbAllocCursor() before using the cursor
         *  in this function */
        rc = rdm_dbGetRowsByKey (hDB, KEY_OFFICE_NAME, &cursor);
        print_error (rc);
 
        for (rc = rdm_cursorMoveToFirst (cursor); rc == sOKAY;
             rc = rdm_cursorMoveToNext (cursor))
        {
            /* Read and display the current person record */
            rc = rdm_cursorReadRow (
                cursor, &office_rec, sizeof (office_rec), NULL);
            print_error (rc);
            printf ("%s\n", office_rec.name);
        }
 
        /* free the cursor if it was allocated */
        if (cursor)
            rdm_cursorFree (cursor);
 
        /* Expect rc to be sENDOFCURSOR when we exit the loop */
        if (rc == sENDOFCURSOR)
        {
            rc = sOKAY;
        }
        rdm_transEnd (hTRN);
    }
    return rc;
}
 
RDM_RETCODE insertOffices (RDM_DB hDB, const char **officeList, size_t listSize)
{
    RDM_RETCODE rc = sOKAY;
    OFFICE office_rec;
    int ii;
 
    for (ii = 0; ii < (int) listSize; ii++)
    {
        strncpy (office_rec.name, officeList[ii], sizeof (office_rec.name));
        rc = rdm_dbInsertRow (
            hDB, TABLE_OFFICE, &office_rec, sizeof (office_rec), NULL);
        print_error (rc);
    }
    return rc;
}
 
static const char *office_names[] = {"Seattle""Boise""San Francisco",
                                     "Dallas"};
 
#define RLEN(x) (sizeof (x) / sizeof (x[0]))
 
int main_core13 (int argc, const char *const *argv)
{
    RDM_RETCODE rc;
    RDM_TFS hTFS;
    RDM_DB hDB1;
    RDM_DB hDB2;
 
    rc = rdm_cmdlineInit (&cmd, argc, argv, description, opts);
    if (rc != sCMD_USAGE)
        print_error (rc);
 
    if (rc == sOKAY)
    {
        /* create records in the database */
        rc = exampleOpenEmptyDatabase (&hTFS, &hDB1, "core13", core13_cat);
        if (rc == sOKAY)
        {
            rc = exampleOpenNextDatabase (hTFS, &hDB2, "core13", core13_cat);
            if (rc == sOKAY)
            {
                /* set timeout to 1 second so we do not need to wait 10s for
                 * error */
                rc = rdm_dbSetOption (hDB2, "timeout""1");
                print_error (rc);
            }
        }
 
        if (rc == sOKAY)
        {
            rc = rdm_dbStartUpdate (hDB1, RDM_LOCK_ALL, 0, NULL, 0, NULL);
            print_error (rc);
 
            if (rc == sOKAY)
            {
                rc = insertOffices (hDB1, office_names, RLEN (office_names));
                if (rc == sOKAY)
                {
                    printf ("\nDisplaying Offices using database handle #1.\n");
                    rc = display_offices (hDB1);
                }
                /* Display all offices using handle 2 (should fail because we
                 * will not be able to get a read lock */
                printf ("\nDisplaying Offices using database handle #2.\n");
                rc = display_offices (hDB2);
 
                rc = rdm_dbEnd (hDB1);
                print_error (rc);
 
                if (rc == sOKAY)
                {
                    /* Display all offices */
                    printf ("\nDisplaying Offices using database handle #2.\n");
                    rc = display_offices (hDB2);
                }
            }
            exampleCleanup2 (hTFS, hDB1, hDB2);
        }
    }
    return rc;
}
 
RDM_RETCODE rdm_cursorMoveToFirst(RDM_CURSOR cursor)
Position a cursor to the first row in the collection.
RDM_RETCODE rdm_transEnd(RDM_TRANS trans)
End a transactional operation.
RDM_RETCODE rdm_cursorMoveToNext(RDM_CURSOR cursor)
Position a cursor to the next row in the collection.
Header for the native RDM Runtime API.
RDM_RETCODE rdm_dbEnd(RDM_DB db)
End a transactional operation.
@ sCMD_USAGE
Definition: rdmretcodetypes.h:71
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.
@ eUNAVAIL
Definition: rdmretcodetypes.h:191
The buffer used by the command line parser to hold state information.
Definition: rdmcmdlinetypes.h:85
RDM_RETCODE rdm_dbGetRowsByKey(RDM_DB db, RDM_KEY_ID keyId, RDM_CURSOR *pCursor)
Associate an RDM_CURSOR with a row set based on a key.
@ sOKAY
Definition: rdmretcodetypes.h:95
struct RDM_TRANS_S * RDM_TRANS
Definition: rdmtypes.h:305
Generic usage function option record.
Definition: rdmcmdlinetypes.h:32
RDM_RETCODE rdm_cursorFree(RDM_CURSOR cursor)
Free an RDM_CURSOR.
RDM_RETCODE rdm_dbSetOption(RDM_DB db, const char *keyword, const char *strValue)
Set a single RDM option from a string.
#define RDM_STARTUP_EXAMPLE(name)
Definition: rdmstartuptypes.h:73
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
RDM_RETCODE rdm_cmdlineInit(RDM_CMDLINE *cmd, int32_t argc, const char *const argv[], const char *description, const RDM_CMDLINE_OPT *opts)
Initialize an RDM_CMDLINE buffer and validate the command line.
struct RDM_DB_S * RDM_DB
Definition: rdmtypes.h:303
#define RDM_LOCK_ALL
Definition: rdmtypes.h:170
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.
@ 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