Header for the native RDM Runtime types. More...

#include "psptypes.h"
#include "rdmretcodetypes.h"

Include dependency graph for rdmtypes.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	RDM_SEARCH_KEY
	The RDM Partial Key data structure. More...

union	RDM_RTREE_FILTER

struct	RDM_RTREE_KEY
	The RDM R-tree Key data structure. More...

struct	RDM_RANGE_KEY
	The RDM Range Key data structure. More...

struct	RDM_ROW_STATUS_INFO
	RDM Rows status info. More...

Macros
#define	RDM_IDENTIFIER_LEN 127

#define	RDM_CATALOG_EMPTY_SCHEMA
	A catalog with an empty schema. More...

#define	RDM_LOCK_NONE (const RDM_TABLE_ID *) (-1)

#define	RDM_LOCK_ALL (const RDM_TABLE_ID *) (-2)

#define	RDM_LOCK_SCHEMA (const RDM_TABLE_ID *) (-3)

#define	RDM_LOCK_DB_OPEN (RDM_TABLE_ID) (-4)

#define	TABLE_SCHEMA (RDM_TABLE_ID) (0x10002)

#define	REF_CURSOR ((RDM_REF_ID) 0)

#define	RDM_COL_HAS_VALUE ((RDM_HAS_VALUE_T) 1)

#define	RDM_COL_IS_NULL ((RDM_HAS_VALUE_T) 0)

#define	RDM_ALL_DATA ((size_t) -1)

#define	RDM_COLUMN_SIZE(table, column) sizeof (((table *) 0)->column)
	Macro for getting the size of a column in the struct definition. More...

Typedefs
typedef uint32_t	RDM_TABLE_ID

typedef uint32_t	RDM_COLUMN_ID

typedef uint32_t	RDM_KEY_ID

typedef uint32_t	RDM_REF_ID

typedef uint64_t	RDM_TX

typedef RDM_RETCODE()	RDM_REBUILD_INDEX_REPORT_FCN(const char table, const char indexes, uint64_t current, uint64_t total)
	Callback function signature to report status on an ID-index rebuild. More...

typedef uint8_t	RDM_HAS_VALUE_T

typedef struct RDM_DB_S *	RDM_DB

typedef struct RDM_CURSOR_S *	RDM_CURSOR

typedef struct RDM_TRANS_S *	RDM_TRANS

typedef struct RDM_ENCRYPT_S *	RDM_ENCRYPT

typedef const struct RDM_ENCRYPT_S *	RDM_ENCRYPT_C

typedef void(*	RDM_ERROR_FCN) (RDM_DB, RDM_RETCODE, const char , void )

typedef void(*	RDM_ERROR_A_FCN) (RDM_DB, RDM_RETCODE, const char , void )

typedef void(*	RDM_ERROR_W_FCN) (RDM_DB, RDM_RETCODE, const wchar_t , void )

Enumerations
enum	RDM_RTREE_TYPE { RDM_RTREE_ALL, RDM_RTREE_EXACT, RDM_RTREE_OVERLAP, RDM_RTREE_CONTAINS, RDM_RTREE_NEAREST, RDM_RTREE_RADIUS_OVERLAP, RDM_RTREE_RADIUS_CONTAINS, RDM_RTREE_POLYGON_OVERLAP, RDM_RTREE_POLYGON_CONTAINS }
	Query types for an R-tree index. More...

enum	RDM_RANGE { RDM_RANGE_OPEN = 0, RDM_RANGE_CLOSED }
	The range include or exclude enumeration. More...

enum	RDM_TRANS_STATUS { RDM_TRANS_READ = 1, RDM_TRANS_UPDATE, RDM_TRANS_SNAPSHOT, RDM_TRANS_NONE }
	The RDM transaction status identifiers. More...

enum	RDM_TRANS_PRECOMMIT_STATUS { RDM_TRANS_NOT_PRECOMMITTED = 0, RDM_TRANS_PRECOMMITTED, RDM_TRANS_PRECOMMITTED_NO_UPDATES }
	The RDM transaction status identifiers. More...

enum	RDM_USER_STATUS { RDM_U_EMPTY = 0, RDM_U_LIVE }
	The RDM user status. More...

enum	RDM_LOCK_STATUS { RDM_LOCK_FREE = 0x0000, RDM_LOCK_READ = 0x0001, RDM_LOCK_WRITE = 0x0003, RDM_LOCK_SNAPSHOT = 0x0005, RDM_LOCK_CATALOG = 0x0310 }
	Enumeration for RDM table lock status. More...

enum	RDM_CURSOR_STATUS { CURSOR_NOT_AT_ROW = 0, CURSOR_AT_ROW, CURSOR_BETWEEN, CURSOR_BEFORE_FIRST, CURSOR_AFTER_LAST, CURSOR_DELETED, CURSOR_CHANGED, CURSOR_UNLINKED, CURSOR_ROW_GONE, CURSOR_SET_GONE, CURSOR_DROPPED }
	Enumeration for RDM cursor positions / statuses. More...

enum	RDM_CURSOR_COMPARE { CURSOR_BEFORE, CURSOR_EQUAL = RDM_EQ, CURSOR_AFTER }
	Enumeration for RDM cursor comparisons. More...

enum	RDM_OPEN_MODE { RDM_OPEN_SHARED = 0x0000, RDM_OPEN_EXCLUSIVE = 0x0001, RDM_OPEN_READONLY = 0x0002 }
	Enumeration for open modes. More...

enum	RDM_CURSOR_TYPE { CURSOR_TYPE_BEFORE_FIRST = 1, CURSOR_TYPE_AFTER_LAST, CURSOR_TYPE_REC_SCAN, CURSOR_TYPE_KEY_SCAN, CURSOR_TYPE_RTREE_SCAN, CURSOR_TYPE_SET_SCAN, CURSOR_TYPE_SINGLETON, CURSOR_TYPE_REC_RANGE, CURSOR_TYPE_STATUS, CURSOR_TYPE_SYSCOLUMN, CURSOR_TYPE_ALLOCATED }
	Enumeration for cursor types. More...

enum	RDM_ENC_TYPE { RDM_ENC_NONE, RDM_ENC_XOR, RDM_ENC_AES128, RDM_ENC_AES192, RDM_ENC_AES256, RDM_ENC_DEFAULT }

enum	RDM_TRIGGERS_STATUS { RDM_TRIGGERS_ON = 1, RDM_TRIGGERS_OFF = -1, RDM_TRIGGERS_UNDEFINED = 0 }
	Triggers status values. More...

Detailed Description

Header for the native RDM Runtime types.

Macro Definition Documentation

◆ RDM_ALL_DATA

#define RDM_ALL_DATA ((size_t) -1)

◆ RDM_CATALOG_EMPTY_SCHEMA

#define RDM_CATALOG_EMPTY_SCHEMA

Value:

"{\n"                                                                      \
    "  \"database\":{\n"                                                       \
    "    \"catver\":142,\n"                                                    \
    "    \"dbver\":1,\n"                                                       \
    "    \"encryption\":\"none\",\n"                                           \
    "    \"maxdrawers\":0,\n"                                                  \
    "    \"nodrawers\":0,\n"                                                   \
    "    \"nextdrawer\":0,\n"                                                  \
    "    \"nodoms\":0,\n"                                                      \
    "    \"maxdoms\":0,\n"                                                     \
    "    \"maxtabs\":32768,\n"                                                 \
    "    \"notabs\":1,\n"                                                      \
    "    \"nexttab\":1,\n"                                                     \
    "    \"drawers\":[\n"                                                      \
    "    ],\n"                                                                 \
    "    \"tables\":[\n"                                                       \
    "    ]\n"                                                                  \
    "  }\n"                                                                    \
    "}\n"

A catalog with an empty schema.

Use this string as a parameter to rdm_dbLoadCatalog() to set an empty schema

◆ RDM_COL_HAS_VALUE

#define RDM_COL_HAS_VALUE ((RDM_HAS_VALUE_T) 1)

Column has a value

Examples: c-core/14_core/core14Example_main.c, c-core/15_core/core15Example_main.c, c-core/16_core/core16Example_main.c, c-core/17_core/core17Example_main.c, c-core/19_core/core19Example_main.c, c-core/31_core/core31Example_main.c, c-core/32_core/core32Example_main.c, and c-core/33_core/core33Example_main.c.

◆ RDM_COL_IS_NULL

#define RDM_COL_IS_NULL ((RDM_HAS_VALUE_T) 0)

Coulumn is null

Examples: c-core/16_core/core16Example_main.c, and c-core/31_core/core31Example_main.c.

◆ RDM_COLUMN_SIZE

#define RDM_COLUMN_SIZE	(	table,
		column
	)	sizeof (((table *) 0)->column)

Macro for getting the size of a column in the struct definition.

Examples: c-core/03_core/core03Example_main.c, c-core/04_core/core04Example_main.c, c-core/06_core/core06Example_main.c, and c-core/10_core/core10Example_main.c.

◆ RDM_IDENTIFIER_LEN

#define RDM_IDENTIFIER_LEN 127

The maximum identifier length measured in characters not including a null terminator

◆ RDM_LOCK_ALL

#define RDM_LOCK_ALL (const RDM_TABLE_ID *) (-2)

Lock all of the tables in the database

Examples: c-core/02_core/core02Example_main.c, c-core/03_core/core03Example_main.c, c-core/04_core/core04Example_main.c, c-core/05_core/core05Example_main.c, c-core/06_core/core06Example_main.c, c-core/07_core/core07Example_main.c, c-core/08_core/core08Example_main.c, c-core/09_core/core09Example_main.c, c-core/10_core/core10Example_main.c, c-core/11_core/core11Example_main.c, c-core/12_core/core12Example_main.c, c-core/13_core/core13Example_main.c, c-core/20_core/core20Example_main.c, c-core/21_core/core21Example_main.c, c-core/22_core/core22Example_main.c, c-core/23_core/core23Example_main.c, c-core/24_core/core24Example_main.c, c-core/25_core/core25Example_main.c, c-core/28_core/core28Example_main.c, c-core/29_core/core29Example_main.c, c-core/30_core/core30Example_main.c, c-core/31_core/core31Example_main.c, c-core/34_core/core34Example_main.c, rtree/deleteZipcode.c, rtree/insertZipcode.c, rtree/retrieveAllZipcode.c, rtree/retrieveContainedZipcode.c, rtree/retrieveExactZipcode.c, rtree/retrieveOverlapZipcode.c, and rtree/updateZipcode.c.

◆ RDM_LOCK_DB_OPEN

#define RDM_LOCK_DB_OPEN (RDM_TABLE_ID) (-4)

Lock for opening a database exclusively

◆ RDM_LOCK_NONE

#define RDM_LOCK_NONE (const RDM_TABLE_ID *) (-1)

Don't lock any tables in the database

◆ RDM_LOCK_SCHEMA

#define RDM_LOCK_SCHEMA (const RDM_TABLE_ID *) (-3)

Lock the schema

◆ REF_CURSOR

#define REF_CURSOR ((RDM_REF_ID) 0)

The default foreign reference ID for the cursor

◆ TABLE_SCHEMA

#define TABLE_SCHEMA (RDM_TABLE_ID) (0x10002)

The table ID for the schema

Typedef Documentation

◆ RDM_COLUMN_ID

typedef uint32_t RDM_COLUMN_ID

The RDM column ID

◆ RDM_CURSOR

typedef struct RDM_CURSOR_S* RDM_CURSOR

RDM cursor handle

◆ RDM_DB

typedef struct RDM_DB_S* RDM_DB

RDM database handle

◆ RDM_ENCRYPT

typedef struct RDM_ENCRYPT_S* RDM_ENCRYPT

RDM encryption handle

◆ RDM_ENCRYPT_C

typedef const struct RDM_ENCRYPT_S* RDM_ENCRYPT_C

const RDM encryption handle

◆ RDM_ERROR_A_FCN

typedef void( * RDM_ERROR_A_FCN) (RDM_DB, RDM_RETCODE, const char *, void *)

◆ RDM_ERROR_FCN

typedef void( * RDM_ERROR_FCN) (RDM_DB, RDM_RETCODE, const char *, void *)

◆ RDM_ERROR_W_FCN

typedef void( * RDM_ERROR_W_FCN) (RDM_DB, RDM_RETCODE, const wchar_t *, void *)

◆ RDM_HAS_VALUE_T

typedef uint8_t RDM_HAS_VALUE_T

RDM Type for whether column has a value or is null

◆ RDM_KEY_ID

typedef uint32_t RDM_KEY_ID

The RDM key ID

◆ RDM_REBUILD_INDEX_REPORT_FCN

typedef RDM_RETCODE() RDM_REBUILD_INDEX_REPORT_FCN(const char *table, const char *indexes, uint64_t current, uint64_t total)

Callback function signature to report status on an ID-index rebuild.

◆ RDM_REF_ID

typedef uint32_t RDM_REF_ID

The RDM foreign reference ID

◆ RDM_TABLE_ID

typedef uint32_t RDM_TABLE_ID

The RDM table ID

◆ RDM_TRANS

typedef struct RDM_TRANS_S* RDM_TRANS

RDM transaction handle handle

◆ RDM_TX

typedef uint64_t RDM_TX

Enumeration Type Documentation

◆ RDM_CURSOR_COMPARE

enum RDM_CURSOR_COMPARE

Enumeration for RDM cursor comparisons.

The enumeration allows for position comparisons between two cursors. A cursor can either be positioned before, after, or equal to the position of another cursor. How positioning is determined is based on the type of cursor being compared.

Enumerator
CURSOR_BEFORE	The cursor is positioned before the position of the other cursor
CURSOR_EQUAL	The cursor is positioned at the same position as the position of the other cursor
CURSOR_AFTER	The cursor is positioned after the position of the other cursor

 {
     CURSOR_BEFORE =
         RDM_LT, 
     CURSOR_EQUAL = RDM_EQ, 
     CURSOR_AFTER =
         RDM_GT 
 } RDM_CURSOR_COMPARE;

◆ RDM_CURSOR_STATUS

enum RDM_CURSOR_STATUS

Enumeration for RDM cursor positions / statuses.

The enumeration identifies the current position for an RDM cursor. A cursor can be positioned at a row, between rows, before all rows, or after all rows

Enumerator
CURSOR_NOT_AT_ROW	A cursor not positioned at a valid row.
CURSOR_AT_ROW	A cursor positioned at a valid row.
CURSOR_BETWEEN	A cursor positioned between rows.
CURSOR_BEFORE_FIRST	A cursor positioned before all rows.
CURSOR_AFTER_LAST	A cursor positioned after all rows.
CURSOR_DELETED	A cursor whose current row has been deleted.
CURSOR_CHANGED	A cursor whose key value has been changed.
CURSOR_UNLINKED	A cursor whose curent row has been unlinked.
CURSOR_ROW_GONE	A singleton cursor that has had it's row deleted.
CURSOR_SET_GONE	A set cursor that has had it's owner deleted.
CURSOR_DROPPED	A cursor that is based on an object that has been dropped.

 {
     CURSOR_NOT_AT_ROW = 0, 
     CURSOR_AT_ROW,         
     CURSOR_BETWEEN,        
     CURSOR_BEFORE_FIRST,   
     CURSOR_AFTER_LAST,     
     CURSOR_DELETED,        
     CURSOR_CHANGED,        
     CURSOR_UNLINKED,       
     CURSOR_ROW_GONE, 
     CURSOR_SET_GONE, 
     CURSOR_DROPPED 
 } RDM_CURSOR_STATUS;

◆ RDM_CURSOR_TYPE

enum RDM_CURSOR_TYPE

Enumeration for cursor types.

The enumeration specifies the type of a cursor

Enumerator
CURSOR_TYPE_BEFORE_FIRST	enum value for a BeforeFirst special cursor
CURSOR_TYPE_AFTER_LAST	enum value for a AfterLast special cursor
CURSOR_TYPE_REC_SCAN	enum value for a record scan cursor
CURSOR_TYPE_KEY_SCAN	enum value for a key scan cursor
CURSOR_TYPE_RTREE_SCAN	enum value for a R-tree scan cursor
CURSOR_TYPE_SET_SCAN	enum value for a set scan cursor
CURSOR_TYPE_SINGLETON	enum value for a singleton cursor
CURSOR_TYPE_REC_RANGE	enum value for a rec range cursor
CURSOR_TYPE_STATUS	enum value for a status cursor
CURSOR_TYPE_SYSCOLUMN	enum value for a syscolumn meta cursor
CURSOR_TYPE_ALLOCATED	enum value for a cursor that has only been allocated

 {
     CURSOR_TYPE_BEFORE_FIRST = 1, 
     CURSOR_TYPE_AFTER_LAST, 
     CURSOR_TYPE_REC_SCAN,   
     CURSOR_TYPE_KEY_SCAN,   
     CURSOR_TYPE_RTREE_SCAN, 
     CURSOR_TYPE_SET_SCAN,   
     CURSOR_TYPE_SINGLETON,  
     CURSOR_TYPE_REC_RANGE,  
     CURSOR_TYPE_STATUS,     
     CURSOR_TYPE_SYSCOLUMN,  
 #if !defined (RDM_DOXYGEN)
     CURSOR_TYPE_SYSTABLE,   
     CURSOR_TYPE_SYSREF,     
     CURSOR_TYPE_SYSKEY,     
     CURSOR_TYPE_SYSDOMAIN,  
     CURSOR_TYPE_SYSSORT,    
     CURSOR_TYPE_SYSELEM,    
     CURSOR_TYPE_SYSDB,      
     CURSOR_TYPE_SYSDRAWER,  
 #endif
     CURSOR_TYPE_ALLOCATED 
 } RDM_CURSOR_TYPE;

◆ RDM_ENC_TYPE

enum RDM_ENC_TYPE

Enumeration for RDM encryption algorithms

The enumeration identifies the supported encryption algorithms.

RDM_ENC_XOR is the only type of encryption that is included in packages without export restrictions.

Enumerator
RDM_ENC_NONE	No encryption
RDM_ENC_XOR	XOR encryption
RDM_ENC_AES128	AES-128 encryption
RDM_ENC_AES192	AES-192 encryption
RDM_ENC_AES256	AES-256 encryption
RDM_ENC_DEFAULT	Default encryption

 {
     RDM_ENC_NONE,   
     RDM_ENC_XOR,    
     RDM_ENC_AES128, 
     RDM_ENC_AES192, 
     RDM_ENC_AES256, 
     RDM_ENC_DEFAULT 
 } RDM_ENC_TYPE;

◆ RDM_LOCK_STATUS

enum RDM_LOCK_STATUS

Enumeration for RDM table lock status.

This enumeration specifies the table lock status for RDM databases

Enumerator
RDM_LOCK_FREE	The table is not locked
RDM_LOCK_READ	The table is locked for reads
RDM_LOCK_WRITE	The table is locked for updates
RDM_LOCK_SNAPSHOT	The table has an active snapshot
RDM_LOCK_CATALOG	The database has the catalog write locked

 {
     RDM_LOCK_FREE = 0x0000,     
     RDM_LOCK_READ = 0x0001,     
     RDM_LOCK_WRITE = 0x0003,    
     RDM_LOCK_SNAPSHOT = 0x0005, 
     RDM_LOCK_CATALOG = 0x0310 
 } RDM_LOCK_STATUS;

◆ RDM_OPEN_MODE

enum RDM_OPEN_MODE

Enumeration for open modes.

The enumeration specifies the open modes. The creat flags always require a catalog set using rdm_dbSetCatalog(). The append modes require any catalog that have been set to match the catalog stored in the database. RDM_OPEN_EXCLUSIVE and RDM_OPEN_SHARED default to create if a catalog have been set and append if it have not been set.

Enumerator
RDM_OPEN_SHARED	Open database in shared mode, requiring locks
RDM_OPEN_EXCLUSIVE	Open database in exclusive mode
RDM_OPEN_READONLY	Open database in readonly mode, requiring locks

 {
     /* GEN_OPEN_MODE_BEGIN */
     RDM_OPEN_SHARED = 0x0000, 
     RDM_OPEN_EXCLUSIVE = 0x0001, 
     RDM_OPEN_READONLY = 0x0002, 
 #if !defined (RDM_DOXYGEN)
     RDM_OPEN_SHARED_APPEND = 0x0010, 
     RDM_OPEN_EXCLUSIVE_APPEND = 0x0011, 
     RDM_OPEN_SHARED_CREAT = 0x0020, 
     RDM_OPEN_EXCLUSIVE_CREAT = 0x0021, 
     RDM_OPEN_SHARED_CREAT_TRUNC =0x0120, 
     RDM_OPEN_EXCLUSIVE_CREAT_TRUNC = 0x0121, 
     RDM_OPEN_SHARED_CREAT_EXCL = 0x0220, 
     RDM_OPEN_EXCLUSIVE_CREAT_EXCL = 0x0221 
 #endif
     /* GEN_OPEN_MODE_END */
 } RDM_OPEN_MODE;

◆ RDM_RANGE

enum RDM_RANGE

The range include or exclude enumeration.

Enumerator
RDM_RANGE_OPEN	The range includes the specified value
RDM_RANGE_CLOSED	The range excludes the specified value

 {
     RDM_RANGE_OPEN = 0, 
     RDM_RANGE_CLOSED    
 } RDM_RANGE;

◆ RDM_RTREE_TYPE

enum RDM_RTREE_TYPE

Query types for an R-tree index.

Enumerator
RDM_RTREE_ALL	Return all entries in the R-tree index
RDM_RTREE_EXACT	Return only an exact match for the query criteria
RDM_RTREE_OVERLAP	Return all rows that overlap the query criteria
RDM_RTREE_CONTAINS	Return all rows that are contained in the query criteria
RDM_RTREE_NEAREST	Return the nearest neighbors to the query criteria.
RDM_RTREE_RADIUS_OVERLAP	Return all rows that overlap the radius query criteria.
RDM_RTREE_RADIUS_CONTAINS	Return all rows that are contained in the radius query criteria.
RDM_RTREE_POLYGON_OVERLAP	Return all rows that overlap the polygon query criteria.
RDM_RTREE_POLYGON_CONTAINS	Return all rows that are contained in the polygon query criteria.

 {
     RDM_RTREE_ALL,     
     RDM_RTREE_EXACT,   
     RDM_RTREE_OVERLAP, 
     RDM_RTREE_CONTAINS, 
     RDM_RTREE_NEAREST, 
     RDM_RTREE_RADIUS_OVERLAP, 
     RDM_RTREE_RADIUS_CONTAINS, 
     RDM_RTREE_POLYGON_OVERLAP, 
     RDM_RTREE_POLYGON_CONTAINS 
 } RDM_RTREE_TYPE;

◆ RDM_TRANS_PRECOMMIT_STATUS

enum RDM_TRANS_PRECOMMIT_STATUS

The RDM transaction status identifiers.

Enumerator
RDM_TRANS_NOT_PRECOMMITTED	A transaction is not precommitted
RDM_TRANS_PRECOMMITTED	A transaction with changes has been precommitted
RDM_TRANS_PRECOMMITTED_NO_UPDATES	A transaction without changes has been precommited

 {
     RDM_TRANS_NOT_PRECOMMITTED = 0, 
     RDM_TRANS_PRECOMMITTED,   
     RDM_TRANS_PRECOMMITTED_NO_UPDATES 
 } RDM_TRANS_PRECOMMIT_STATUS;

◆ RDM_TRANS_STATUS

enum RDM_TRANS_STATUS