core06Example_main.c

Mixed model. Combine set scanning and index look up for navigation of a hierarchy. This example needs a compiled schema, core06.sdl.

#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 "core06_structs.h"
/* Generated catalog definition to be used with the RDM rdm_dbSetCatalog() API
*/
#include "core06_cat.h"
const char *const description = "Demonstrates using an index for ordering";
const RDM_CMDLINE_OPT opts[] = {{NULL, NULL, NULL, NULL}};
/*
* \mainpage Core06 Popcorn Example
*
* Each time you run this example:
* \li The database is initialized (all existing contents removed)
* \li Several new artists are added to the database
* \li For each artist a couple albums are added to the database
* \li For each album a tracks are added to the database
* \li A list of each artist, their albums, and the album's tracks is
* displayed
*
* \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 core06.sdl.
*
* \include core06.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 core06.sdl \endcode
*
* Each of these functions returns an integer status code, where the
* value sOKAY indicates a successful call.
*
* The actual database will be stored in a directory named 'core06.rdm' in the
* project directory.
*
* \page hPGMfunc Program Functions
* \li insertArtist() - \copybrief insertArtist
* \li readAllAlbums() - \copybrief readAllAlbums
* \li main() - \copybrief main
*/
/* \brief Insert an artist
*
* This function adds one more row to the ARTIST table in the core06 database.
*
* @return Returns an RDM_RETCODE code (sOKAY if successful)
*/
RDM_RETCODE insertArtist (
RDM_DB hDB, /*< [in] Database handle to open database */
const char *artistName) /*< [in] Artist name to insert */
{
rc = rdm_dbStartUpdate (hDB, RDM_LOCK_ALL, 0, NULL, 0, NULL);
if (rc == sOKAY)
{
ARTIST artist_rec;
artist_rec.artistid = 0;
strncpy (artist_rec.name, artistName, sizeof (artist_rec.name));
hDB, TABLE_ARTIST, &artist_rec, sizeof (artist_rec), NULL);
if (rc == sOKAY)
rc = rdm_dbEnd (hDB);
else
rc = rdm_dbEndRollback (hDB);
}
return rc;
}
/* \brief Insert all artists
*
* @return Returns an RDM_RETCODE code (sOKAY if successful)
*/
RDM_RETCODE insertAllArtists (
RDM_DB hDB) /*< [in] Database handle to open database */
{
rc = insertArtist (hDB, "The Doors");
if (rc == sOKAY)
{
rc = insertArtist (hDB, "The Rolling Stones");
}
if (rc == sOKAY)
{
rc = insertArtist (hDB, "Nirvana");
}
return rc;
}
/* \brief Insert an artist and all of the albums associated with the artist
*
* This function adds one more row to the ARTIST table in the core03 database
* and one to many rows to the ALBUM table associated with the given artist.
*
* @return Returns an RDM_RETCODE code (sOKAY if successful)
*/
RDM_RETCODE insertAlbum (
RDM_DB hDB, /*< [in] Database handle to open database */
const char *artistName, /*< [in] Name of the artist */
const char *albumTitle, /*< [in] Artist name to insert */
const char **trackList, /*< [in] List of album names for the artist */
size_t listSize) /*< [in] Number of album names in the list */
{
ALBUM album_rec;
RDM_CURSOR albumCursor = NULL;
RDM_CURSOR artistCursor = NULL;
ARTIST_NAME_KEY artistKey;
rc = rdm_dbStartUpdate (hDB, RDM_LOCK_ALL, 0, NULL, 0, NULL);
if (rc == sOKAY)
{
strncpy (artistKey.name, artistName, sizeof (artistKey.name));
hDB, KEY_ARTIST_NAME, &artistKey, sizeof (artistKey),
&artistCursor);
if (rc == sOKAY)
{
strncpy (album_rec.title, albumTitle, sizeof (album_rec.title));
album_rec.albumid = 0;
album_rec._artistid_has_value =
RDM_FALSE; /* Mark the row as unlinked */
hDB, TABLE_ALBUM, &album_rec, sizeof (album_rec), &albumCursor);
}
if (rc == sOKAY)
{
/* associate the added row to the artist */
albumCursor, REF_ALBUM_ARTISTID, artistCursor);
}
if (rc == sOKAY)
{
int ii;
for (ii = 0; ii < (int) listSize; ii++)
{
TRACK track_rec;
RDM_CURSOR trackCursor = NULL;
strncpy (
track_rec.title, trackList[ii], sizeof (track_rec.title));
track_rec._albumid_has_value =
RDM_FALSE; /* Mark the row as unlinked */
hDB, TABLE_TRACK, &track_rec, sizeof (track_rec),
&trackCursor);
if (rc == sOKAY)
{
/* associate the added row to the artist */
trackCursor, REF_TRACK_ALBUMID, albumCursor);
rdm_cursorFree (trackCursor);
}
}
if (albumCursor)
rdm_cursorFree (albumCursor);
}
if (rc == sOKAY)
rc = rdm_dbEnd (hDB);
else
rc = rdm_dbEndRollback (hDB);
}
return rc;
}
/* \brief Read all the artists and the associated albums and tracks
*
* This function reads and displays each row from the ARTIST table in the core06
* database and the ALBUMS and TRACKS associated with the artist.
*
* @return Returns an RDM_RETCODE code (sOKAY if successful)
*/
RDM_RETCODE readAllAlbums (
RDM_DB hDB) /*< [in] Database handle to open database */
{
RDM_CURSOR artistCursor = NULL;
/* Loop through each artist record and diplay the albums/tracks it
is associated with
*/
printf ("\nList all artists and their albums/tracks\n");
rc = rdm_dbStartRead (hDB, RDM_LOCK_ALL, 0, NULL);
if (rc == sOKAY)
{
/* read the ARTIST table in table order */
rc = rdm_dbGetRowsByKey (hDB, KEY_ARTIST_NAME, &artistCursor);
if (rc == sOKAY)
{
for (rc = rdm_cursorMoveToFirst (artistCursor); rc == sOKAY;
rc = rdm_cursorMoveToNext (artistCursor))
{
RDM_CURSOR albumCursor = NULL;
char Artist[RDM_COLUMN_SIZE (ARTIST, name)];
/* We found an artist row, read the contents */
artistCursor, COL_ARTIST_NAME, Artist, sizeof (Artist),
NULL);
if (rc == sOKAY)
{
printf ("\nArtist: %s\n", Artist);
/* read the album rows associated with the artist*/
artistCursor, REF_ALBUM_ARTISTID, &albumCursor);
}
if (rc == sOKAY)
{
for (rc = rdm_cursorMoveToFirst (albumCursor); rc == sOKAY;
rc = rdm_cursorMoveToNext (albumCursor))
{
RDM_CURSOR trackCursor = NULL;
char Title[RDM_COLUMN_SIZE (ALBUM, title)];
/* We found an album row, read the contents*/
albumCursor, COL_ALBUM_TITLE, Title, sizeof (Title),
NULL);
if (rc == sOKAY)
{
printf ("\n\tAlbum: %s\n", Title);
albumCursor, REF_TRACK_ALBUMID, &trackCursor);
}
if (rc == sOKAY)
{
for (rc = rdm_cursorMoveToFirst (trackCursor);
rc == sOKAY;
rc = rdm_cursorMoveToNext (trackCursor))
{
char Track[RDM_COLUMN_SIZE (TRACK, title)];
/* We found an album row, read the
* contents*/
trackCursor, COL_TRACK_TITLE, Track,
sizeof (Track), NULL);
if (rc == sOKAY)
{
printf ("\t\t%s\n", Track);
}
}
rdm_cursorFree (trackCursor);
}
}
if (albumCursor)
rdm_cursorFree (albumCursor);
}
}
if (artistCursor)
rdm_cursorFree (artistCursor);
/* We expect rc to be sENDOFCURSOR when we break out of the loop */
if (rc == sENDOFCURSOR)
{
rc = sOKAY; /* change status to sOKAY because sENDOFCURSOR was
expected. */
}
else
{
}
}
rdm_dbEnd (hDB);
}
return rc;
}
/* Track data to insert */
static const char *the_doors_tracks[] = {"Break on Through (To the Other Side)",
"Soul Kitchen",
"The Crystal Ship",
"Twentieth Century Fox",
"Alabama Song (Whisky Bar)",
"Light My Fire",
"Back Door Man",
"I Looked at You",
"End of the Night",
"Take It as It Comes",
"The End"};
static const char *strange_days_tracks[] = {"Strange Days",
"You're Lost Little Girl",
"Love Me Two Times",
"Unhappy Girl",
"Horse Latitudes",
"Moonlight Drive",
"People Are Strange",
"My Eyes Have Seen You",
"I Can't See Your Face in My Mind",
"When the Music's Over"};
static const char *waiting_tracks[] = {
"Hello, I Love You", "Love Street", "Not to Touch the Earth",
"Summer's Almost Gone", "Wintertime Love", "The Unknown Soldier",
"Spanish Caravan", "My Wild Love", "We Could Be So Good Together",
"Yes, the River Knows", "Five to One"};
static const char *the_rolling_stones_tracks[] = {
"Not Fade Away",
"Route 66",
"I Just Want to Make Love to You",
"Honest I Do",
"Now I've Got a Witness",
"Little by Little",
"I'm a King Bee",
"Carol",
"Tell Me",
"Can I Get a Witness",
"You Can Make It If You Try",
"Walking the Dog"};
static const char *out_of_our_heads_tracks[] = {
"She Said Yeah",
"Mercy, Mercy",
"Hitch Hike",
"That's How Strong My Love Is",
"Good Times",
"Gotta Get Away",
"Talkin' Bout You",
"Cry to Me",
"Oh, Baby (We Got a Good Thing Going)",
"Heart of Stone",
"The Under Assistant West Coast Promotion Man",
"I'm Free"};
static const char *beggars_banquet_tracks[] = {
"Sympathy for the Devil", "No Expectations", "Dear Doctor",
"Parachute Woman", "Jig-Saw Puzzle", "Street Fighting Man",
"Prodigal Son", "Stray Cat Blues", "Factory Girl",
"Salt of the Earth"};
static const char *tattoo_you_tracks[] = {"Start Me Up",
"Hang Fire",
"Slave",
"Little T&A",
"Black Limousine",
"Neighbours",
"Worried About You",
"Tops",
"Heaven"};
static const char *bleach_tracks[] = {
"Blew", "Floyd The Barber", "About a Girl", "School",
"Love Buzz", "Paper Cuts", "Negative Creep", "Scoff",
"Swap Meet", "Mr. Moustache", "Sifting"};
static const char *nevermind_tracks[] = {"Smells Like Teen Spirit",
"In Bloom",
"Come as You Are",
"Breed",
"Lithium",
"Polly",
"Territorial Pissings",
"Drain You",
"Lounge Act",
"Stay Away",
"On a Plain",
"Something in the Way",
"Endless, Nameless"};
static const char *in_utero_tracks[] = {
"Serve the Servants",
"Scentless Apprentice",
"Heart-Shaped Box",
"Rape Me",
"Frances Farmer Will Have Her Revenge on Seattle",
"Dumb",
"Very Ape",
"Milk It",
"Pennyroyal Tea",
"Radio Friendly Unit Shifter",
"tourette's",
"All Apologies"};
/* \brief Macro to determine number of elements in an array of ptrs */
#define RLEN(x) (sizeof (x) / sizeof (x[0]))
/* \brief Insert all albums
*
* @return Returns an RDM_RETCODE code (sOKAY if successful)
*/
RDM_RETCODE insertAllAlbums (
RDM_DB hDB) /*< [in] Database handle to open database */
{
rc = insertAlbum (
hDB, "The Doors", "The Doors", the_doors_tracks,
RLEN (the_doors_tracks));
if (rc == sOKAY)
{
rc = insertAlbum (
hDB, "The Doors", "Strange Days", strange_days_tracks,
RLEN (strange_days_tracks));
}
if (rc == sOKAY)
{
rc = insertAlbum (
hDB, "The Doors", "Waiting for the Sun", waiting_tracks,
RLEN (waiting_tracks));
}
if (rc == sOKAY)
{
rc = insertAlbum (
hDB, "The Rolling Stones", "The Rolling Stones",
the_rolling_stones_tracks, RLEN (the_rolling_stones_tracks));
}
if (rc == sOKAY)
{
rc = insertAlbum (
hDB, "The Rolling Stones", "Out of our Heads",
out_of_our_heads_tracks, RLEN (out_of_our_heads_tracks));
}
if (rc == sOKAY)
{
rc = insertAlbum (
hDB, "The Rolling Stones", "Beggars Banquest",
beggars_banquet_tracks, RLEN (beggars_banquet_tracks));
}
if (rc == sOKAY)
{
rc = insertAlbum (
hDB, "The Rolling Stones", "Tattoo You", tattoo_you_tracks,
RLEN (tattoo_you_tracks));
}
if (rc == sOKAY)
{
rc = insertAlbum (
hDB, "Nirvana", "Bleach", bleach_tracks, RLEN (bleach_tracks));
}
if (rc == sOKAY)
{
rc = insertAlbum (
hDB, "Nirvana", "Nevermind", nevermind_tracks,
RLEN (nevermind_tracks));
}
if (rc == sOKAY)
{
rc = insertAlbum (
hDB, "Nirvana", "In Utero", in_utero_tracks,
RLEN (in_utero_tracks));
}
return rc;
}
/* \brief Main function for core06 example
*
* The function initializes the RDM environment and runs the create, read
* operations.
*
* @return Returns the RDM_RETCODE on exit.
*/
int main_core06 (int argc, const char *const *argv)
{
RDM_TFS hTFS;
RDM_DB hDB;
rc = rdm_cmdlineInit (&cmd, argc, argv, description, opts);
if (rc != sCMD_USAGE)
if (rc == sOKAY)
{
rc = exampleOpenDatabase (&hTFS, &hDB, "core06", core06_cat);
if (rc == sOKAY)
{
rc = insertAllArtists (hDB);
}
if (rc == sOKAY)
{
rc = insertAllAlbums (hDB);
}
rc = readAllAlbums (hDB);
exampleCleanup (hTFS, hDB);
}
return (int) rc;
}
#define RDM_COLUMN_SIZE(table, column)
Macro for getting the size of a column in the struct definition.
Definition: rdmtypes.h:197
RDM_RETCODE rdm_cursorMoveToFirst(RDM_CURSOR cursor)
Position a cursor to the first row in the collection.
RDM_RETCODE rdm_cursorMoveToNext(RDM_CURSOR cursor)
Position a cursor to the next row in the collection.
Header for the native RDM Runtime API.
@ RDM_FALSE
Definition: psptypes.h:59
RDM_RETCODE rdm_dbEnd(RDM_DB db)
End a transactional operation.
@ sCMD_USAGE
Definition: rdmretcodetypes.h:72
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.
#define exampleOpenDatabase(tfs, db, name, catalog)
Definition: example_fcns.h:18
The buffer used by the command line parser to hold state information.
Definition: rdmcmdlinetypes.h:85
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.
#define exampleCleanup(tfs, db)
Definition: example_fcns.h:30
RDM_RETCODE rdm_cursorLinkRow(RDM_CURSOR cursor, RDM_REF_ID refId, RDM_CURSOR cursorOwner)
Link a row to an owner.
#define print_error(rc)
Definition: example_fcns.h:17
@ sOKAY
Definition: rdmretcodetypes.h:98
RDM_RETCODE rdm_dbGetRowsByKeyAtKey(RDM_DB db, RDM_KEY_ID keyId, const void *keyValue, size_t len, RDM_CURSOR *pCursor)
Associate an RDM_CURSOR with a row set that is ordered by key value and is initially positioned at th...
Generic usage function option record.
Definition: rdmcmdlinetypes.h:32
RDM_RETCODE rdm_cursorFree(RDM_CURSOR cursor)
Free an RDM_CURSOR.
#define RDM_STARTUP_EXAMPLE(name)
Definition: rdmstartuptypes.h:73
RDM_RETCODE rdm_dbEndRollback(RDM_DB db)
End and rollback a transactional operation.
#define RLEN(x)
Definition: example_fcns.h:34
RDM_RETCODE rdm_cursorGetMemberRows(RDM_CURSOR ownerCursor, RDM_REF_ID refId, RDM_CURSOR *pCursor)
Associate an RDM_CURSOR with members.
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_cursorReadColumn(RDM_CURSOR cursor, RDM_COLUMN_ID columnId, void *columnValue, size_t bytesIn, size_t *bytesOut)
Read a single column from a table row.
struct RDM_TFS_S * RDM_TFS
RDM TFS Handle.
Definition: rdmtfstypes.h:21
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.
struct RDM_DB_S * RDM_DB
Definition: rdmtypes.h:305
#define RDM_LOCK_ALL
Definition: rdmtypes.h:170
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
Definition: rdmretcodetypes.h:59
Internal RDM Startup API used by startup macros.
RDM_RETCODE
RDM status and error return codes.
Definition: rdmretcodetypes.h:44