core01Example_main.c
Hello World example in C language. This example needs a compiled schema, core01Example.sdl.
/*
* 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 "core01Example_structs.h" /* The core01Example database definitions. */
#include "core01Example_cat.h" /* The core01Example database catalog */
#include "rdmstartupapi.h"
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
/* Read "helloworld" row to database */
{
RDM_TABLE_ID tables[] = {TABLE_INFO};
RDM_RETCODE rc;
/* Start an update transaction and lock the table */
{
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 */
{
RDM_TABLE_ID tables[] = {TABLE_INFO};
RDM_RETCODE rc;
/* Start an update transaction and lock the table */
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 */
{
/* 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 */
}
if (rc == sOKAY)
{
/* Associate the catalog with the database handle */
rc = rdm_dbSetCatalog (db, core01Example_cat);
if (rc == sOKAY)
{
/* Open the database */
if (rc != sOKAY)
{
printf ("I can't open the core01Example 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",
return EXIT_FAILURE;
}
return EXIT_SUCCESS;
}
RDM_STARTUP_EXAMPLE (hello_worldTutorial)
const char * rdm_retcodeGetName(RDM_RETCODE retcode)
Get the mnemonic name for an error or status code.
Header for the native RDM Runtime API.
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_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.
RDM_RETCODE rdm_dbOpen(RDM_DB db, const char *dbNameSpec, RDM_OPEN_MODE mode)
Open an existing RDM database using the specified database handle.
RDM_RETCODE rdm_tfsAllocDatabase(RDM_TFS tfs, RDM_DB *pDb)
Allocate memory for a new RDM db.
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_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.
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.
Internal RDM Startup API used by startup macros.