Embedded C/C++ Application (Windows/CMake)

Introduction

Now that you've gotten comfortable with creating a database in the How to Create a Schema section, lets build an application that will allow you to read and write to a database.

We recommend getting familiar with some of the concepts and tools that you will be using in this tutorial. We will be covering: interacting with the Transaction File Server (TFS), inserting a row with the function call rdm_dbInsertRow(), and reading rows with the function call rdm_cursorReadRow(). You may also find it useful to read about the DOCROOT as well.

• The TFS is responsible for safely storing and retrieving objects. It is like a key/value store, but very fast and transactionally safe. The TFS owns and is co-located with the database files.
• In this example rdm_dbInsertRow() will be used to insert a new row into two of our tables: AUTHOR and BOOK.
• rdm_cursorReadRow() reads all columns from a row specified by the RDM_CURSOR and places the contents inside of the designated buffer.
• The DOCROOT is a directory which is designated for holding databases available to a Transaction File Server (TFS). The concept is similar to a web server document root for storing web pages

Prerequisites:

• Create bookStore Database rdm-create
• Have bookStore_structs.h header file created rdm-compile

Steps: 

1. First create a new project folder
   $> mkdir App
2. Change directories into your project 
   $> cd App
3. Create a new file and name it bookStore_main.c 
4. Change bookStore_main.c to look like this:

#include <stdio.h>;

int main(void)
{
    char name[20];
    printf("Hello. What's your name?\n");
    fgets(name, 20, stdin);
    printf("Hi there, %s", name);
    return 0;
}

5. CMake requires a CMakeLists.txt file to know how to build the executable, lets go ahead and build that now. Inside of your CMakeLists.txt file add the following (Remember that some of the paths might need to be changed depending on where you installed Raima):

# required for all CMakeLists files
cmake_minimum_required(VERSION 3.10)

# set the project name
project(bookStoreApp VERSION 1.0)

# include the header files
include_directories (
    C:/Raima/RDM/15.2/include
)

# add the executable
add_executable (bookStoreApp bookStore_main.c)

set_target_properties  (bookStoreApp PROPERTIES FOLDER examples)

# set the needed libraries (path varies depending on installation)
target_link_libraries (bookStoreApp
    C:/Raima/RDM/15.2/lib/rdmtx-15.lib
    C:/Raima/RDM/15.2/lib/rdmbase-15.lib
    C:/Raima/RDM/15.2/lib/rdmtfs-15.lib
    C:/Raima/RDM/15.2/lib/rdmrdm-15.lib
)

# install the app
install (TARGETS
    bookStoreApp
    RUNTIME DESTINATION bin COMPONENT Runtime
)

We've created the CMakeLists.txt file, now we need to add our header files to the project.

6. In this project directory (App), create an includes directory: $> mkdir includes
7. Move your generated header file into the includes directory: bookStore_structs.h
8. From the command line, run CMake ./ inside of the project directory
9. Open the bookStoreApp.vcxproj file with devenv.exe
10. Right click on the bookStoreApp executable and under debug click start new instance

At this point the program should have ran and asked you for your name. Now we will begin building the application.

11. Add these includes to the top of bookStore_main.c:

#include "rdm.h"
#include "bookStore_structs.h"

12. In the bookStore_main.c file, change the main function to look like this:

#include <stdio.h>
#include <stdlib.h>

#include "rdmapi.h"
#include "bookStore_structs.h"

int main (int argc, const char* const* argv)
{
    RDM_RETCODE rc; /* Status/Error Return Code */
    RDM_TFS tfs;    /* TFS Handle */
    RDM_DB  db;     /* Database Handle */

    /* Allocate a TFS Handle */
    rc = rdm_rdmAllocTFS (&tfs);
    if (rc == sOKAY)
    {
        rc = rdm_tfsInitialize (tfs);
        if (rc == sOKAY)
        {
            /* Allocate a database handle */
            rc = rdm_tfsAllocDatabase (tfs, &db);
            if (rc == sOKAY)
            {
                /* Open the database */
                rc = rdm_dbOpen (db, "bookStore", RDM_OPEN_SHARED);
                if (rc == sOKAY)
                {
                    /* Insert a row to database */
                    rc = writeARow (db);
                    if (rc == sOKAY)
                    {
                        /* Read the rows */
                        rc = readRows (db);
                    }
                    rdm_dbClose (db);
                }
                else
                {
                    fprintf (stderr, "\nSorry, can't open bookStore database.\n");
                    fprintf (stderr, "Error: %s (%d): %s\n", rdm_retcodeGetName (rc), rc, rdm_retcodeGetDescription (rc));
                }
            }
            rdm_dbFree (db);
        }
        rdm_tfsFree (tfs);
    }

    return rc == sOKAY ? EXIT_SUCCESS : EXIT_FAILURE;
}

Your program won't do much at this point, but it should compile and run. I would recommend reading through the code and comments to understand how things are set up. Go ahead and run it to make sure everything is working.

13. Next, lets add some functionality. We will add a function that takes user input from the command line and adds a book and author into our corresponding tables (Don't forget to uncomment the writeARow function call inside of the main function shown on line 23 in the code snippet above).

/* Write a row to from author and book tables */
RDM_RETCODE writeARow (RDM_DB db)
{
    RDM_RETCODE rc;
    RDM_TABLE_ID tables[] = {TABLE_BOOK, TABLE_AUTHOR};

    char last_name[13];
    char full_name[35];
    char bookid[14];
    char title[105];
    char price[10];
    RDM_BCD_T dPrice;
    char *inputs[5] = {last_name, full_name, bookid, title, price};
    unsigned int len;
    int ii = 0;

    printf ("ADDING AUTHOR TO DATABASE\nAuthor Last Name:\n");
    fgets (last_name, 13, stdin);
    printf ("Author Full Name:\n");
    fgets (full_name, 35, stdin);
    printf ("ADDING BOOK TO DATABASE\nTitle of Book:\n");
    fgets (title, 105, stdin);
    printf ("Enter id located on book:\n");
    fgets (bookid, 14, stdin);
    printf ("Price:\n");
    fgets (price, 10, stdin);

    /* Remove newline character from fgets */
    while (ii < (sizeof (inputs) / sizeof (inputs[0])))
    {
        len = strlen (inputs[ii]);
        if (inputs[ii][len - 1] == '\n')
        {
            inputs[ii][len - 1] = '\0';
        }
        ii++;
    }

    /* Start an update transaction and lock the table */
    rc = rdm_dbStartUpdate (db, tables, RDM_LEN(tables), NULL, 0, NULL);
    if (rc == sOKAY)
    {
        AUTHOR authInsert; /* Row buffer */
        BOOK bookInsert;   /* Row buffer */

        /* Populate the columns in the AUTHOR Row buffer */
        strcpy (authInsert.LAST_NAME, last_name);
        strcpy (authInsert.FULL_NAME, full_name);
        authInsert._FULL_NAME_has_value = RDM_COL_HAS_VALUE;

        /* Insert a row into the table */
        rc = rdm_dbInsertRow (db, TABLE_AUTHOR, &authInsert, sizeof (authInsert), NULL);

        if (rc == sOKAY)
        {
            /* Convert the string to a binary-coded decimal */
            rdm_bcdFromString (price, &dPrice);

            /* Populate the columns in the BOOK Row buffer */
            strcpy (bookInsert.TITLE, title);
            bookInsert._TITLE_has_value = RDM_COL_HAS_VALUE;
            strcpy (bookInsert.BOOKID, bookid);
            bookInsert.PRICE = dPrice;
            bookInsert._PRICE_has_value = RDM_COL_HAS_VALUE;

            /* Insert a row into the table */
            rc = rdm_dbInsertRow (db, TABLE_BOOK, &bookInsert, sizeof (bookInsert), NULL);
        }
        if (rc == sOKAY)
        {
            /* Commit a transaction */
            printf ("The book %s by %s at a price of $%s was added to the database successfully.\n",
                    title, full_name, price);
            rc = rdm_dbEnd (db);
        }
        else
        {
            /* Abort the transaction */
            fprintf (stderr, "A problem occurred when adding data to the database.\n");
            fprintf (stderr, "Error: %s (%d): %s\n", rdm_retcodeGetName (rc), rc, rdm_retcodeGetDescription (rc));
            (void) rdm_dbEndRollback (db);
        }
    }
    return rc;
}

14. Now run the program again and make sure you are able to add authors and books to the database.
15. Finally, we will add a readRows function to our program that will allow us to see what we have added (Don't forget to uncomment the readRows function call inside of the main function shown on line 27 in the code snippet above):

/* Read rows from author table */
RDM_RETCODE readRows (RDM_DB db)
{
    RDM_RETCODE rc;
    RDM_TABLE_ID tables[] = {TABLE_AUTHOR};
    AUTHOR authRead;
    RDM_CURSOR cursor = NULL;

    rc = rdm_dbStartRead (db, tables, RDM_LEN(tables), NULL);
    if (rc == sOKAY)
    {
        rc = rdm_dbGetRows (db, TABLE_AUTHOR, &cursor);
        if (rc == sOKAY)
        {
            /* Navigate to the first row in the cursor */
            printf ("Displaying all of the authors in the author table\n");
            rc = rdm_cursorMoveToFirst (cursor);
            while (rc == sOKAY)
            {
                /* Read the row column values */
                rc = rdm_cursorReadRow (cursor, &authRead, sizeof (authRead), NULL);
                if (rc == sOKAY)
                {
                    printf ("%s", authRead.LAST_NAME);

                    /* Move to the next row in the cursor */
                    rc = rdm_cursorMoveToNext (cursor);
                }
            }

            /* We expect to break out of the loop with a sENDOFCURSOR code*/
            if (rc == sENDOFCURSOR)
            {
                rc = sOKAY;
            }

            /* Free the cursor allocated in rdm_dbGetRows */
            rdm_cursorFree (cursor);
        }

        /* release the read locks */
        (void) rdm_dbEnd (db);
    }
    return rc;
}

Conclusion

Your program should be fully functional at this point. You set up an Embedded TFS which is used when you are interacting with a database that is not shared with other processes, and you wrote and read rows from the database by interacting with the TFS.

Next, you might want to add some more functionality by deleting a row with rdm_cursorDeleteRow() or update a row with rdm_cursorUpdateRow(). Some other concepts to look over might be:

• Remote TFS
• Defining a Schema
• Configuration Options

The full source file can be found here: learn/bookStore_embed.c