core32Example_main.c
Basic tutorial in C where a simple database is used to store data using transactions. This example needs a compiled schema, core32Example.sdl.
/*
* TRANSACTIONS
* ------------
*
* This document describes the process to create a simple database
* that stores data using transactions. We'll insert a hundred records
* in the table, and verify by counting the number of records stored
* in the database.
*
*/
#include "rdm.h" /* The RDM API. */
#include "rdmapi.h"
#include "rdmtfsapi.h"
#include "core32Example_structs.h" /* The transaction database definitions. */
#include "core32Example_cat.h"
#include "rdmstartupapi.h"
#include <stdio.h>
#include <stdlib.h>
int32_t main_transactionsTutorial (int32_t argc, const char *const *argv)
{
RDM_RETCODE rc; /*lint -esym(850,iStatus) */
RDM_TFS tfs;
RDM_UNREF (argc);
RDM_UNREF (argv);
/* Allocate a TFS Handle */
rc = rdm_rdmAllocTFS (&tfs);
{
rc = rdm_tfsInitialize (tfs);
/* Allocate a database hande */
if (rc == sOKAY)
{
RDM_DB db;
rc = rdm_tfsAllocDatabase (tfs, &db);
if (rc == sOKAY)
{
/* Override default DURABLE setting to CONSISTENT */
}
if (rc == sOKAY)
{
RDM_TABLE_ID tables[] = {TABLE_INFO};
int32_t iTrans;
int32_t iCnt;
rc = rdm_dbSetCatalog (db, core32Example_cat);
if (rc == sOKAY)
{
/* Open the database. */
if (rc != sOKAY)
{
printf ("Can't open the transaction database.");
}
}
if (rc == sOKAY)
{
/* Start an update transaction and lock the table */
rc = rdm_dbStartUpdate (
db, tables, RDM_LEN (tables), NULL, 0, NULL);
}
if (rc == sOKAY)
{
/* Remove all of the rows from the database */
rc = rdm_dbDeleteAllRowsFromDatabase (db);
if (rc == sOKAY)
{
/* Commit a transaction */
rc = rdm_dbEnd (db);
}
else
{
/* Abort the transaction */
rdm_dbEndRollback (db);
}
}
/* Loop to group 10 records into 10 different transactions. */
for (iTrans = 0; iTrans < 10 && rc == sOKAY; iTrans++)
{
/* Start a transaction. */
rc = rdm_dbStartUpdate (
db, tables, RDM_LEN (tables), NULL, 0, NULL);
if (rc == sOKAY)
{
for (iCnt = 0; iCnt < 10 && rc == sOKAY; iCnt++)
{
INFO sInfo;
/* Insert a new row into the INFO table */
sprintf (
sInfo.mystr, "Inserted %d Transaction %d", iCnt,
iTrans);
sInfo._mystr_has_value = RDM_COL_HAS_VALUE;
rc = rdm_dbInsertRow (
db, TABLE_INFO, &sInfo, sizeof (sInfo), NULL);
}
if (rc == sOKAY)
{
/* Commit the transaction */
rc = rdm_dbEnd (db);
}
else
{
/* Something is wrong, rollback the transaction */
rdm_dbEndRollback (db);
}
}
}
if (rc == sOKAY)
{
/* Start a transaction on the */
}
if (rc == sOKAY)
{
RDM_CURSOR cursor = NULL;
iCnt = 0;
/* Get a cursor containing all the rows in the INFO table */
rc = rdm_dbGetRows (db, TABLE_INFO, &cursor);
if (rc == sOKAY)
{
rc = rdm_cursorMoveToNext (cursor))
{
INFO sInfo;
/* Read and print the INFO record. */
rc = rdm_cursorReadRow (
cursor, &sInfo, sizeof (sInfo), NULL);
if (rc == sOKAY)
{
printf ("%s\n", sInfo.mystr);
}
iCnt++;
}
/* We expect to break out of the loop with a return code
* of sENDOFCURSOR */
{
rc = sOKAY;
}
/* Free the cursor allocated by rdm_dbGetRows */
rdm_cursorFree (cursor);
}
/* Free the read lock */
rdm_dbEnd (db);
}
printf ("\n");
if (rc == sOKAY)
{
printf ("I found %d INFO records in the database\n", iCnt);
}
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 (transactionsTutorial)
const char * rdm_retcodeGetName(RDM_RETCODE retcode)
Get the mnemonic name for an error or status code.
Header for the native RDM Runtime API.
Header for the RDM Core API.
RDM_RETCODE rdm_dbDeleteAllRowsFromDatabase(RDM_DB db)
Remove all rows from a database.
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_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.
Header for the Transactional File Server (TFS) API.
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_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.