c-core/02_core/core02Example_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 "core02_structs.h"
 
/* Generated catalog definition to be used with the RDM rdm_dbSetCatalog() API
 */
#include "core02_cat.h"
 
const char *const description =
    "Demonstrates inserting a row and reading rows from database";
const RDM_CMDLINE_OPT opts[] = {{NULL, NULL, NULL, NULL}};
 
RDM_RETCODE insertOneRow (
    RDM_DB hDB) 
{
    CORE02_RECORD core02_input;
    RDM_RETCODE rc;
 
    rc = rdm_dbStartUpdate (hDB, RDM_LOCK_ALL, 0, NULL, 0, NULL);
    print_error (rc);
    if (rc == sOKAY)
    {
        /* create a record in the new database */
        strncpy (core02_input.message, "Core02", sizeof (core02_input.message));
        rc = rdm_dbInsertRow (
            hDB, TABLE_CORE02_RECORD, &core02_input, sizeof (core02_input),
            NULL);
        print_error (rc);
 
        if (rc == sOKAY)
            rc = rdm_dbEnd (hDB);
        else
            rc = rdm_dbEndRollback (hDB);
 
        print_error (rc);
    }
 
    return rc;
}
 
RDM_RETCODE readAllRows (
    RDM_DB hDB) 
{
    CORE02_RECORD core02_output;
    RDM_CURSOR cursor = NULL;
    RDM_RETCODE rc;
 
    rc = rdm_dbStartRead (hDB, RDM_LOCK_ALL, 0, NULL);
    print_error (rc);
    if (rc == sOKAY)
    {
        /* allocate a cursor resource */
        rc = rdm_dbAllocCursor (hDB, &cursor);
        print_error (rc);
 
        if (rc == sOKAY)
        {
            /* setup the type of cursor navigation to be used */
            rc = rdm_dbGetRows (hDB, TABLE_CORE02_RECORD, &cursor);
            print_error (rc);
        }
 
        if (rc == sOKAY)
        {
            /* scan and read all created records */
            /* one additional record will be created each time you run this
             * example */
            for (rc = rdm_cursorMoveToFirst (cursor); rc == sOKAY;
                 rc = rdm_cursorMoveToNext (cursor))
            {
                /* read the row at the current cursor position */
                rc = rdm_cursorReadRow (
                    cursor, &core02_output, sizeof (core02_output), NULL);
                print_error (rc);
 
                if (rc == sOKAY)
                {
                    printf ("%s\n", core02_output.message);
                }
            }
 
            /* We expect rc to be sENDOFCURSOR when we break out of the loop */
            if (rc == sENDOFCURSOR)
            {
                rc = sOKAY/* change status to sOKAY because sENDOFCURSOR was
                                expected. */
            }
            else
            {
                print_error (rc);
            }
        }
        if (cursor)
        {
            /* free the cursor resource when we're done */
            rdm_cursorFree (cursor);
        }
        rdm_dbEnd (hDB);
    }
    return rc;
}
 
int main_core02 (int argc, const char *const *argv)
{
    RDM_TFS hTFS;
    RDM_DB hDB;
    RDM_RETCODE rc;
 
    rc = rdm_cmdlineInit (&cmd, argc, argv, description, opts);
    if (rc != sCMD_USAGE)
        print_error (rc);
 
    if (rc == sOKAY)
    {
        rc = exampleOpenDatabase (&hTFS, &hDB, "core02", core02_cat);
        if (rc == sOKAY)
        {
            rc = insertOneRow (hDB);
            if (rc == sOKAY)
            {
                rc = readAllRows (hDB);
            }
            exampleCleanup (hTFS, hDB);
        }
    }
 
    return (int) rc;
}
 
RDM_RETCODE rdm_cursorMoveToFirst(RDM_CURSOR cursor)
Position a cursor to the first row in the collection.
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.
The buffer used by the command line parser to hold state information.
Definition: rdmcmdlinetypes.h:85
@ sOKAY
Definition: rdmretcodetypes.h:95
Generic usage function option record.
Definition: rdmcmdlinetypes.h:32
RDM_RETCODE rdm_cursorFree(RDM_CURSOR cursor)
Free an RDM_CURSOR.
#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.
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.
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