Itzam/C++

Main Index

Created by Scott Robert Ladd at Coyote Gulch Productions.

itzam Namespace Reference

Complex database classes. More...

Classes

class ref_list
Reference list. More...
class btree_index_base
B-tree index base class. More...
class btree_index
Unique key index. More...
class btree_index_with_duplicates
Unique key index. More...
class matrix_index
Matrix index class. More...
class database_file
A database supporting multiple indexes of various types. More...
class database_exception
Standard Itzam database exception. More...
class serial_data
Raw information to be written as a raw, unstructured stream to a file. More...
class atomic_record
A simple record and key wrapper. More...
class numeric_key
A numeric key type. More...
class string_key
A string key. More...
class mutex
A mutual exclusion lock. More...
class null_mutex
A NULL mutual exclusion lock. More...
class simple_mutex
A simple mutual exclusion lock. More...
class selector
A selector for choosing record reference by an iterator. More...
class select_all
A selector for all records. More...
class database_object
Common elements of all database types. More...
class simple_database
A simple database. More...
class simple_iterator
Database iterator. More...

Enumerations

enum database_state { ITZAM_DB_BROKEN = -1, ITZAM_DB_UNINIT = 0, ITZAM_DB_OPEN = 1, ITZAM_DB_CLOSED = 2 }
Database state. More...
enum database_error {
  DB_ERROR_NONE, DB_ERROR_OPEN_BROKEN, DB_ERROR_OPEN_FAILED, DB_ERROR_CLOSE_BROKEN,
  DB_ERROR_CLOSE_FAILED, DB_ERROR_WRITE_BROKEN, DB_ERROR_WRITE_CLOSED, DB_ERROR_WRITE_DUPE,
  DB_ERROR_WRITE_FAILED, DB_ERROR_READ_BROKEN, DB_ERROR_READ_CLOSED, DB_ERROR_READ_NOT_FOUND,
  DB_ERROR_READ_FAILED, DB_ERROR_EXISTS_BROKEN, DB_ERROR_EXISTS_CLOSED, DB_ERROR_REMOVE_BROKEN,
  DB_ERROR_REMOVE_CLOSED, DB_ERROR_REMOVE_NOT_FOUND, DB_ERROR_REMOVE_FAILED, DB_ERROR_REFLIST_MISSING,
  DB_ERROR_COUNT
}
Database error. More...

Detailed Description

These classes define a complex database that supports one or more indexes.

If you don't need this level of complexity, use the simple database class template.

Enumeration Type Documentation

enum itzam::database_error

Code to identify a database error condition. A "broken" database is one in which a prior error has occurred, rendering its condition questionable.
Enumerator:

DB_ERROR_NONE there is no error (or spoon)

DB_ERROR_OPEN_BROKEN can not open a broken database

DB_ERROR_OPEN_FAILED can not open database

DB_ERROR_CLOSE_BROKEN can not close a broken database

DB_ERROR_CLOSE_FAILED can not close database

DB_ERROR_WRITE_BROKEN can not write to a broken database

DB_ERROR_WRITE_CLOSED can not write to a closed database

DB_ERROR_WRITE_DUPE can not write duplicate key

DB_ERROR_WRITE_FAILED write failed (system error)

DB_ERROR_READ_BROKEN can not read from a broken database

DB_ERROR_READ_CLOSED can not read from a closed database

DB_ERROR_READ_NOT_FOUND can not read record, it was not found

DB_ERROR_READ_FAILED read failed (system error)

DB_ERROR_EXISTS_BROKEN can not check key existence in broken database

DB_ERROR_EXISTS_CLOSED can not check key existence in closed database

DB_ERROR_REMOVE_BROKEN can not remove record from broken database

DB_ERROR_REMOVE_CLOSED can not remove record from closed database

DB_ERROR_REMOVE_NOT_FOUND can not remove record, it was not found

DB_ERROR_REMOVE_FAILED remove failed (system error)

DB_ERROR_REFLIST_MISSING could not find reference list associated with key

DB_ERROR_COUNT number of error states

enum itzam::database_state

The state of a database, such as whether it is open or closed.
Enumerator:

ITZAM_DB_BROKEN Something is wrong with this database object, and it should not be used in its current state.

ITZAM_DB_UNINIT This state only exists between the time the database constructor is called and the open is accomplished.

ITZAM_DB_OPEN The database is open and available for operations.

ITZAM_DB_CLOSED The database is closed, and must be opened before use.