core09Example_main.c

Multiple databases opened in a union. Demonstrate key scan through the union. This example needs a compiled schema, core09.sdl.

/*
* 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.
*/
/* \file
* \brief Source code for the RDM core09 example
*/
#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 "core09_structs.h"
/* Generated catalog definition to be used with the RDM rdm_dbSetCatalog() API
*/
#include "core09_cat.h"
RDM_CMDLINE cmd;
const char *const description = "Demonstrates database union read";
const RDM_CMDLINE_OPT opts[] = {{NULL, NULL, NULL, NULL}};
/*
* \mainpage Core09 Popcorn Example
*
* Each time you run this example:
* \li The database is initialized (all existing contents removed)
* \li Several new offices are added to the NA database
* \li Several new offices are added to the EMEA database
* \li Data is queried from the NA office
* \li Data is queried from the EMEA office
* \li Data is queried from from both databases as a union (unified view
* of two identically structured databases)
*
* \par Table of Contents
*
* - \subpage hDB
* - \subpage hPGMfunc
*
* For additional information, please refer to the product documentation at
* http://docs.raima.com/.
*
* \page hDB Database Schema
*
* \par Database Schema Definition
*
* The DDL (Database Definition Language) specification for the database used
* in this example is located in the file \c core09.sdl.
*
* \include core09.sdl
*
* The schema was compiled using the RDM rdm-compile utility with the -s option
* to generate C-structures for interfacing with the database.
*
* \code rdm-compile -s core09.sdl \endcode
*
* Each of these functions returns an integer status code, where the
* value sOKAY indicates a successful call.
*
* The actual databases will be stored in a directories named 'na_sales_db' and
* 'emea_sales_db' in the project directory.
*
* \page hPGMfunc Program Functions
*
* For simplicity, this example does not check all return codes, but good
* programming practices would dictate that they are checked after each
* RDM call.
*
* \li display_offices() - \copybrief display_offices
* \li main() - \copybrief main
*/
/* \brief Display the contents of the database
*
* This function displays the contents of the database.
* Exclusve mode does not require database locks or transactions.
*
* @return Returns RDM_RETCODE status code (sOKAY if successful)
*/
RDM_RETCODE display_offices (RDM_DB hDB) /*< [in] Database handle to be used */
{
RDM_RETCODE rc;
OFFICE office_rec;
RDM_CURSOR cursor = NULL;
rc = rdm_dbStartRead (hDB, RDM_LOCK_ALL, 0, NULL);
print_error (rc);
if (rc == sOKAY)
{
/* The following cursor association call will allocate the cursor
* if the cursor is set to NULL. This short-cut can eliminate the
* requirement to call rdm_dbAllocCursor() before using the cursor
* in this function */
rc = rdm_dbGetRowsByKey (hDB, KEY_OFFICE_NAME, &cursor);
print_error (rc);
for (rc = rdm_cursorMoveToFirst (cursor); rc == sOKAY;
rc = rdm_cursorMoveToNext (cursor))
{
/* Read and display the current person record */
rc = rdm_cursorReadRow (
cursor, &office_rec, sizeof (office_rec), NULL);
print_error (rc);
printf ("%s\n", office_rec.name);
}
/* free the cursor if it was allocated */
if (cursor)
rdm_cursorFree (cursor);
/* Expect rc to be S_NOTFOUND when we exit the loop */
if (rc == sENDOFCURSOR)
{
rc = sOKAY;
}
rdm_dbEnd (hDB);
}
return rc;
}
RDM_RETCODE insertOffices (RDM_DB hDB, const char **officeList, size_t listSize)
{
RDM_RETCODE rc;
OFFICE office_rec;
rc = rdm_dbStartUpdate (hDB, RDM_LOCK_ALL, 0, NULL, 0, NULL);
print_error (rc);
if (rc == sOKAY)
{
int ii;
for (ii = 0; ii < (int) listSize; ii++)
{
strncpy (office_rec.name, officeList[ii], sizeof (office_rec.name));
rc = rdm_dbInsertRow (
hDB, TABLE_OFFICE, &office_rec, sizeof (office_rec), NULL);
print_error (rc);
}
if (rc == sOKAY)
rc = rdm_dbEnd (hDB);
else
rc = rdm_dbEndRollback (hDB);
print_error (rc);
}
return rc;
}
static const char *na_office_names[] = {"Seattle", "Boise", "San Francisco",
"Dallas"};
static const char *emea_office_names[] = {"Paris", "London", "Dublin", "Zurich",
"Madrid"};
RDM_RETCODE loadDatabase (RDM_TFS hTFS)
{
RDM_RETCODE rc;
RDM_DB hDB;
rc = exampleOpenNextEmptyDatabase (hTFS, &hDB, "core09NA", core09_cat);
if (rc == sOKAY)
{
/* create records in the NA database */
rc = insertOffices (hDB, na_office_names, RLEN (na_office_names));
rdm_dbFree (hDB);
}
rc = exampleOpenNextEmptyDatabase (hTFS, &hDB, "core09EMEA", core09_cat);
if (rc == sOKAY)
{
/* create records in the NA database */
rc = insertOffices (hDB, emea_office_names, RLEN (emea_office_names));
rdm_dbFree (hDB);
}
return rc;
}
/* \brief Main function for core09 example
*
* The function initializes the RDM environment and runs the create, read
* operations.
*
* @return Returns the RDM_RETCODE on exit.
*/
int main_core09 (int argc, const char *const *argv)
{
RDM_RETCODE rc;
RDM_TFS hTFS;
RDM_DB hDB;
rc = rdm_cmdlineInit (&cmd, argc, argv, description, opts);
if (rc != sCMD_USAGE)
print_error (rc);
if (rc == sOKAY)
{
rc = exampleAllocTFS (&hTFS);
if (rc == sOKAY)
{
rc = loadDatabase (hTFS);
}
if (rc == sOKAY)
{
rc = rdm_tfsAllocDatabase (hTFS, &hDB);
print_error (rc);
}
if (rc == sOKAY)
{
/* Read from both databases (union read) */
rc = rdm_dbOpen (hDB, "core09NA|core09EMEA", RDM_OPEN_READONLY);
print_error (rc);
if (rc == sOKAY)
{
/* Display all offices */
printf ("\nAll Worldwide Offices\n");
display_offices (hDB);
}
rdm_dbFree (hDB);
}
rdm_tfsFree (hTFS);
}
return (int) rc;
}
RDM_STARTUP_EXAMPLE (core09)
rdm_cursorMoveToFirst
RDM_RETCODE rdm_cursorMoveToFirst(RDM_CURSOR cursor)
Position a cursor to the first row in the collection.
rdm_cursorMoveToNext
RDM_RETCODE rdm_cursorMoveToNext(RDM_CURSOR cursor)
Position a cursor to the next row in the collection.
rdm.h
Header for the native RDM Runtime API.
rdm_dbEnd
RDM_RETCODE rdm_dbEnd(RDM_DB db)
End a transactional operation.
sCMD_USAGE
@ sCMD_USAGE
Definition: rdmretcodetypes.h:72
RDM_CURSOR
struct RDM_CURSOR_S * RDM_CURSOR
Definition: rdmtypes.h:306
exampleAllocTFS
RDM_RETCODE exampleAllocTFS(RDM_TFS *pTFS)
rdm_dbStartRead
RDM_RETCODE rdm_dbStartRead(RDM_DB db, const RDM_TABLE_ID *tableIds, uint32_t numTableIds, RDM_TRANS *pTrans)
Get read locks.
rdm_cursorReadRow
RDM_RETCODE rdm_cursorReadRow(RDM_CURSOR cursor, void *colValues, size_t bytesIn, size_t *bytesOut)
Read all columns from a row.
RDM_CMDLINE
The buffer used by the command line parser to hold state information.
Definition: rdmcmdlinetypes.h:85
exampleOpenNextEmptyDatabase
#define exampleOpenNextEmptyDatabase(tfs, db, name, catalog)
Definition: example_fcns.h:45
rdm_dbGetRowsByKey
RDM_RETCODE rdm_dbGetRowsByKey(RDM_DB db, RDM_KEY_ID keyId, RDM_CURSOR *pCursor)
Associate an RDM_CURSOR with a row set based on a key.
rdm_dbFree
RDM_RETCODE rdm_dbFree(RDM_DB db)
Free a database handle.
rdm_dbOpen
RDM_RETCODE rdm_dbOpen(RDM_DB db, const char *dbNameSpec, RDM_OPEN_MODE mode)
Open an existing RDM database using the specified database handle.
print_error
#define print_error(rc)
Definition: example_fcns.h:34
sOKAY
@ sOKAY
Definition: rdmretcodetypes.h:96
RDM_CMDLINE_OPT
Generic usage function option record.
Definition: rdmcmdlinetypes.h:32
rdm_cursorFree
RDM_RETCODE rdm_cursorFree(RDM_CURSOR cursor)
Free an RDM_CURSOR.
RDM_OPEN_READONLY
@ RDM_OPEN_READONLY
Definition: rdmtypes.h:255
rdm_tfsAllocDatabase
RDM_RETCODE rdm_tfsAllocDatabase(RDM_TFS tfs, RDM_DB *pDb)
Allocate memory for a new RDM db.
RDM_STARTUP_EXAMPLE
#define RDM_STARTUP_EXAMPLE(name)
Definition: rdmstartuptypes.h:73
rdm_dbEndRollback
RDM_RETCODE rdm_dbEndRollback(RDM_DB db)
End and rollback a transactional operation.
RLEN
#define RLEN(x)
Definition: example_fcns.h:51
rdm_dbInsertRow
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_TFS
struct RDM_TFS_S * RDM_TFS
RDM TFS Handle.
Definition: rdmtfstypes.h:21
rdm_cmdlineInit
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.
RDM_DB
struct RDM_DB_S * RDM_DB
Definition: rdmtypes.h:305
rdm_tfsFree
RDM_RETCODE rdm_tfsFree(RDM_TFS hTFS)
Terminate a TFS service.
RDM_LOCK_ALL
#define RDM_LOCK_ALL
Definition: rdmtypes.h:170
rdm_dbStartUpdate
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
@ sENDOFCURSOR
Definition: rdmretcodetypes.h:59
rdmstartupapi.h
Internal RDM Startup API used by startup macros.
RDM_RETCODE
RDM_RETCODE
RDM status and error return codes.
Definition: rdmretcodetypes.h:44