core36Example_main.c

Hello World example with encryption in C language. This example needs a compiled schema, core36Example.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 "core36Example_structs.h" /* The core01Example database definitions. */
#include "core36Example_cat.h"/* The core01Example database catalog */
#include "rdmstartupapi.h"
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#define DBNAME "core36"
static void cleanup(RDM_TFS tfs)
{
rdm_tfsDropDatabase(tfs, DBNAME);
}
static void testEncryption(RDM_TFS tfs)
{
RDM_DB db; /* Database Handle */
/* Allocate a database hande */
rc = rdm_tfsAllocDatabase(tfs, &db);
if (rc == sOKAY)
{
/* Open the database */
rc = rdm_dbOpen(db, DBNAME, RDM_OPEN_SHARED);
if (rc == eINVENCRYPT)
{
printf("Database IS encrypted\n");
}
else
{
printf("Database IS NOT encrypted\n");
}
}
}
/* Read "helloworld" row to database */
static RDM_RETCODE readARow (RDM_DB db)
{
RDM_TABLE_ID tables[] = {TABLE_INFO};
/* 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 */
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};
/* 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 */
db, TABLE_INFO, &infoInserted, sizeof (infoInserted), NULL);
if (rc == sOKAY)
{
/* Commit a transaction */
rc = rdm_dbEnd (db);
}
else
{
/* Abort the transaction */
}
}
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)
{
/* Allocate an encryption handle */
#if defined(LINK_ENC_SIMPLE)
rc = rdm_tfsAllocEncrypt(tfs, "XOR:ThisIsThePassCode", &enc);
#else
rc = rdm_tfsAllocEncrypt(tfs, "AES256:ThisIsThePassCode", &enc);
#endif
if (rc == sOKAY)
{
RDM_DB db; /* Database Handle */
/* Allocate a database hande */
rc = rdm_tfsAllocDatabase (tfs, &db);
if (rc == sOKAY)
{
/* Associage the encryption context with the database handle */
rc = rdm_dbSetEncrypt (db, enc);
if (rc == sOKAY)
{
/* Associate the catalog with the database handle */
rc = rdm_dbSetCatalog(db, core36Example_cat);
if (rc == sOKAY)
{
/* Open the database */
rc = rdm_dbOpen(db, DBNAME, RDM_OPEN_SHARED);
if (rc != sOKAY)
{
printf("I can't open the core36Example database.\n");
}
else
{
/* Insert "helloworld" row to database */
rc = writeARow(db);
if (rc == sOKAY)
{
/* Read "helloworld" row to database */
rc = readARow(db);
}
}
}
}
}
}
testEncryption(tfs);
cleanup (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)
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.
Header for the native RDM Runtime API.
RDM_RETCODE rdm_rdmAllocTFS(RDM_TFS *phTFS)
Allocate a TFS handle.
@ eINVENCRYPT
Definition: rdmretcodetypes.h:275
struct RDM_ENCRYPT_S * RDM_ENCRYPT
Definition: rdmtypes.h:309
RDM_RETCODE rdm_dbEnd(RDM_DB db)
End a transactional operation.
struct RDM_CURSOR_S * RDM_CURSOR
Definition: rdmtypes.h:306
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.
uint32_t RDM_TABLE_ID
Definition: rdmtypes.h:27
RDM_RETCODE rdm_dbSetEncrypt(RDM_DB db, RDM_ENCRYPT enc)
Associate an encryption context with a database handle.
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:97
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:305
RDM_RETCODE rdm_tfsFree(RDM_TFS hTFS)
Terminate a TFS service.
RDM_RETCODE rdm_tfsAllocEncrypt(RDM_TFS hTFS, const char *passcode, RDM_ENCRYPT *pEnc)
Allocate an encryption context.
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
RDM_RETCODE rdm_encryptFree(RDM_ENCRYPT enc)
Free an encryption context.
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.