Berkeley DB: C++ API

SectionClass/MethodDescription
Database EnvironmentDbEnvCreate an environment handle

DbEnv::closeClose an environment

DbEnv::dbremoveRemove a database

DbEnv::dbrenameRename a database

DbEnv::errError message with error string

DbEnv::errxError message

DbEnv::openOpen an environment

DbEnv::removeRemove an environment

DbEnv::strerrorError strings

DbEnv::versionReturn version information
Environment ConfigurationDbEnv::set_app_dispatchConfigure application recovery

DbEnv::set_allocSet local space allocation functions

DbEnv::set_data_dirSet the environment data directory

DbEnv::set_encryptSet the environment cryptographic key

DbEnv::set_errcallSet error message callback

DbEnv::set_errfileSet error message FILE

DbEnv::set_error_streamSet error message output stream

DbEnv::set_errpfxSet error message prefix

DbEnv::set_feedbackSet feedback callback

DbEnv::set_flagsEnvironment configuration

DbEnv::set_paniccallSet panic callback

DbEnv::set_rpc_serverEstablish an RPC server connection

DbEnv::set_shm_keySet system memory shared segment ID

DbEnv::set_tas_spinsSet the number of test-and-set spins

DbEnv::set_timeoutSet lock and transaction timeout

DbEnv::set_tmp_dirSet the environment temporary file directory

DbEnv::set_verboseSet verbose messages
Database OperationsDbCreate a database handle

Db::associateAssociate a secondary index

Db::closeClose a database

Db::delDelete items from a database

Db::errError message with error string

Db::errxError message

Db::fdReturn a file descriptor from a database

Db::get, Db::pgetGet items from a database

Db::get_byteswappedReturn if the underlying database is in host order

Db::getenvReturn a handle for the underlying database environment

Db::get_typeReturn the database type

Db::joinPerform a database join on cursors

Db::key_rangeReturn estimate of key location

Db::openOpen a database

Db::putStore items into a database

Db::removeRemove a database

Db::renameRename a database

Db::statReturn database statistics

Db::syncFlush a database to stable storage

Db::truncateEmpty a database

Db::upgradeUpgrade a database

Db::verifyVerify/salvage a database
Database ConfigurationDb::set_allocSet local space allocation functions

Db::set_cachesizeSet the database cache size

Db::set_dup_compareSet a duplicate comparison function

Db::set_encryptSet the database cryptographic key

Db::set_errcallSet error message callback

Db::set_errfileSet error message FILE

Db::set_error_streamSet error message output stream

Db::set_errpfxSet error message prefix

Db::set_feedbackSet feedback callback

Db::set_flagsGeneral database configuration

Db::set_lorderSet the database byte order

Db::set_pagesizeSet the underlying database page size

Db::set_paniccallSet panic callback
Btree/Recno ConfigurationDb::set_append_recnoSet record append callback

Db::set_bt_compareSet a Btree comparison function

Db::set_bt_minkeySet the minimum number of keys per Btree page

Db::set_bt_prefixSet a Btree prefix comparison function

Db::set_re_delimSet the variable-length record delimiter

Db::set_re_lenSet the fixed-length record length

Db::set_re_padSet the fixed-length record pad byte

Db::set_re_sourceSet the backing Recno text file
Hash ConfigurationDb::set_h_ffactorSet the Hash table density

Db::set_h_hashSet a hashing function

Db::set_h_nelemSet the Hash table size
Queue ConfigurationDb::set_q_extentsizeSet Queue database extent size
Database Cursor OperationsDbcCursor class

Db::cursorCreate a cursor handle

Dbc::closeClose a cursor

Dbc::countReturn count of duplicates

Dbc::delDelete by cursor

Dbc::dupDuplicate a cursor

Dbc::get, Dbc::pgetRetrieve by cursor

Dbc::putStore by cursor
Key/Data PairsDbt
Bulk RetrievalDbMultipleDataIterator

DbMultipleKeyDataIterator

DbMultipleRecnoDataIterator
Lock SubsystemDbEnv::set_lk_conflictsSet lock conflicts matrix

DbEnv::set_lk_detectSet automatic deadlock detection

DbEnv::set_lk_max_lockersSet maximum number of lockers

DbEnv::set_lk_max_locksSet maximum number of locks

DbEnv::set_lk_max_objectsSet maximum number of lock objects

DbEnv::lock_detectPerform deadlock detection

DbEnv::lock_getAcquire a lock

DbEnv::lock_idAcquire a locker ID

DbEnv::lock_id_freeRelease a locker ID

DbEnv::lock_putRelease a lock

DbEnv::lock_statReturn lock subsystem statistics

DbEnv::lock_vecAcquire/release locks
Log SubsystemDbEnv::set_lg_bsizeSet log buffer size

DbEnv::set_lg_dirSet the environment logging directory

DbEnv::set_lg_maxSet log file size

DbEnv::set_lg_regionmaxSet logging region size

DbEnv::log_archiveList log and database files

DbEnv::log_fileMap Log Sequence Numbers to log files

DbEnv::log_flushFlush log records

DbEnv::log_putWrite a log record

DbEnv::log_statReturn log subsystem statistics
Log Cursor OperationsDbLogcLog cursor class

DbEnv::log_cursorCreate a log cursor handle

DbLogc::closeClose a log cursor

DbLogc::getRetrieve a log record
Log Sequence NumbersDbLsn

DbEnv::log_compareCompare two Log Sequence Numbers
Memory Pool SubsystemDb::get_mpfReturn the database's memory pool handle

DbEnv::set_cachesizeSet the environment cache size

DbEnv::set_mp_mmapsizeSet maximum mapped-in database file size

DbEnv::memp_registerRegister input/output functions for a file in a memory pool

DbEnv::memp_statReturn memory pool statistics

DbEnv::memp_syncFlush pages from a memory pool

DbEnv::memp_trickleTrickle flush pages from a memory pool
Memory Pool FilesDbMpoolFileMemory Pool File class

DbEnv::memp_fcreateCreate a memory pool file handle

DbMpoolFile::closeClose a file in a memory pool

DbMpoolFile::getGet page from a file in a memory pool

DbMpoolFile::openOpen a file in a memory pool

DbMpoolFile::putReturn a page to a memory pool

DbMpoolFile::setSet memory pool page status

DbMpoolFile::syncFlush pages from a file in a memory pool

DbMpoolFile::set_clear_lenSet file page bytes to be cleared

DbMpoolFile::set_fileidSet file unique identifier

DbMpoolFile::set_flagsGeneral memory pool file configuration

DbMpoolFile::set_ftypeSet file type

DbMpoolFile::set_lsn_offsetSet file log-sequence-number offset

DbMpoolFile::set_maxsizeSet the maximum file size

DbMpoolFile::set_pgcookieSet file cookie for pgin/pgout

DbMpoolFile::set_prioritySet the file priority
Transaction SubsystemDbEnv::set_tx_maxSet maximum number of transactions

DbEnv::set_tx_timestampSet recovery timestamp

DbEnv::txn_checkpointCheckpoint the transaction subsystem

DbEnv::txn_recoverDistributed transaction recovery

DbEnv::txn_statReturn transaction subsystem statistics
TransactionsDbTxnTransaction class

DbEnv::txn_beginBegin a transaction

DbTxn::abortAbort a transaction

DbTxn::commitCommit a transaction

DbTxn::discardDiscard a prepared but not resolved transaction handle

DbTxn::idReturn a transaction's ID

DbTxn::preparePrepare a transaction for commit

DbTxn::set_timeoutSet transaction timeout
ReplicationDbEnv::set_rep_transportConfigure replication transport

DbEnv::rep_electHold a replication election

DbEnv::set_rep_limitLimit data sent in response to a single message

DbEnv::rep_process_messageProcess a replication message

DbEnv::rep_startConfigure an environment for replication

DbEnv::rep_statReplication statistics
ExceptionsDbExceptionException Class for Berkeley DB Activity

DbDeadlockExceptionException Class for deadlocks

DbLockNotGrantedExceptionException Class for lock request failures

DbMemoryExceptionException Class for insufficient memory

DbRunRecoveryExceptionException Class for failures requiring recovery

Copyright (c) 1996-2003 Sleepycat Software, Inc. - All rights reserved.