Library Version 12.1.6.0

Berkeley DB C++ API Reference
|  | Next

# Berkeley DB C++ API Reference

DB C++ API | Description
--- | ---
Db::associate() | Associate a secondary index
Db::associate_foreign() | Associate a foreign index
Db::close() | Close a database
Db::compact() | Compact a database
db_copy | Copy a named database to a target directory
Db | Create a database handle
Db::del() | Delete items from a database
Db::err() | Error message
Db::exists() | Return if an item appears in a database
Db::fd() | Return a file descriptor from a database
Db::get() | Get items from a database
Db::get_byteswapped() | Return if the underlying database is in host order
Db::get_dbname() | Return the file and database name
Db::get_multiple() | Return if the database handle references multiple databases
Db::get_open_flags() | Returns the flags specified to Db::open
Db::get_partition_callback() | Return the database partition callback
Db::get_partition_keys() | Returns the array of keys used for the database partition
Db::get_type() | Return the database type
Db::join() | Perform a database join on cursors
Db::key_range() | Return estimate of key location
Db::open() | Open a database
Db::put() | Store items into a database
Db::remove() | Remove a database
Db::rename() | Rename a database
Db::set_alloc() | Set local space allocation functions
Db::set_append_recno() | Set record append callback
Db::set_bt_compare() | Set a Btree comparison function
Db::set_bt_compress() | Set Btree compression functions
Db::set_bt_minkey(), Db::get_bt_minkey() | Set/get the minimum number of keys per Btree page
Db::set_bt_prefix() | Set a Btree prefix comparison function
Db::set_cachesize(), Db::get_cachesize() | Set/get the database cache size
Db::set_create_dir(), Db::get_create_dir() | Set/get the directory in which a database is placed
Db::set_dup_compare() | Set a duplicate comparison function
Db::set_encrypt(), Db::get_encrypt_flags() | Set/get the database cryptographic key
Db::set_errcall() | Set error message callback
Db::set_errfile(), Db::get_errfile() | Set/get error message FILE
Db::set_error_stream() | Set C++ ostream used for error messages
Db::set_errpfx(), Db::get_errpfx() | Set/get error message prefix
Db::set_feedback() | Set feedback callback
Db::set_flags(), Db::get_flags() | Set/get general database configuration
Db::set_h_compare() | Set a Hash comparison function
Db::set_h_ffactor(), Db::get_h_ffactor() | Set/get the Hash table density
Db::set_h_hash() | Set a hashing function
Db::set_h_nelem(), Db::get_h_nelem() | Set/get the Hash table size
Db::set_heapsize(), Db::get_heapsize() | Set/get the database heap size
Db::set_heap_regionsize(), Db::get_heap_regionsize() | Set/get the database region size
Db::set_lk_exclusive(), Db::get_lk_exclusive() | Set/get exclusive database locking
Db::set_lorder(), Db::get_lorder() | Set/get the database byte order
Db::set_message_stream() | Set C++ ostream used for informational messages
Db::set_msgcall() | Set informational message callback
Db::set_msgfile(), Db::get_msgfile() | Set/get informational message FILE
Db::set_pagesize(), Db::get_pagesize() | Set/get the underlying database page size
Db::set_partition() | Set database partitioning
Db::set_partition_dirs(), Db::get_partition_dirs() | Set/get the directories used for database partitions
Db::set_priority(), Db::get_priority() | Set/get cache page priority
Db::set_q_extentsize(), Db::get_q_extentsize() | Set/get Queue database extent size
Db::set_re_delim(), Db::get_re_delim() | Set/get the variable-length record delimiter
Db::set_re_len(), Db::get_re_len() | Set/get the fixed-length record length
Db::set_re_pad(), Db::get_re_pad() | Set/get the fixed-length record pad byte
Db::set_re_source(), Db::get_re_source() | Set/get the backing Recno text file
Db::sort_multiple() | Sort a set of DBTs
Db::stat() | Database statistics
Db::stat_print() | Display database statistics
Db::sync() | Flush a database to stable storage
Db::truncate() | Empty a database
Db::upgrade() | Upgrade a database
Db::verify() | Verify/salvage a database
DbHeapRecordId |
Db::cursor() | Create a cursor handle
Dbc::close() | Close a cursor handle
Dbc::cmp() | Compare two cursors for equality.
Dbc::count() | Return count of duplicates for current key
Dbc::del() | Delete current key/data pair
Dbc::dup() | Duplicate the cursor handle
Dbc::get() | Retrieve by cursor
Dbc::put() | Store by cursor
Dbc::set_priority(), Dbc::get_priority() | Set/get the cursor's cache priority
DbMultipleIterator | Base class for bulk get retrieval
DbMultipleDataIterator | Bulk retrieval iterator for data items
DbMultipleKeyDataIterator | Bulk retrieval iterator for key/data pairs
DbMultipleRecnoDataIterator | Bulk retrieval iterator for record number / data item pairs
DbMultipleBuilder | Base class for bulk buffer building
DbMultipleDataBuilder | Bulk buffer builder for data items
DbMultipleKeyDataBuilder | Bulk buffer builder for key/data pairs
DbMultipleRecnoDataBuilder | Bulk buffer builder for record number / data pairs
DbEnv::add_data_dir() | add an environment data directory
DbEnv::backup() | Hot back up an entire environment
DbEnv::close() | Close an environment
DbEnv | Create an environment handle
DbEnv::dbbackup() | Hot back up a single environment file
DbEnv::dbremove() | Remove a database
DbEnv::dbrename() | Rename a database
DbEnv::err() | Error message
DbEnv::failchk() | Check for thread failure
DbEnv::fileid_reset() | Reset database file IDs
DbEnv::full_version() | Return full version information
Db::get_env() | Return the Db's underlying DbEnv handle
DbEnv::get_home() | Return environment's home directory
DbEnv::get_open_flags() | Return flags with which the environment was opened
DbEnv::log_verify() | Verify log files of an environment.
DbEnv::lsn_reset() | Reset database file LSNs
DbEnv::open() | Open an environment
DbEnv::remove() | Remove an environment
DbEnv::set_alloc() | Set local space allocation functions
DbEnv::set_app_dispatch() | Configure application recovery callback
DbEnv::set_backup_callbacks(), DbEnv::get_backup_callbacks() | Set/get callbacks used for environment hot backups
DbEnv::set_backup_config(), DbEnv::get_backup_config() | Set/get environment hot backup configuration options
DbEnv::set_data_dir(), DbEnv::get_data_dirs() | Set/get the environment data directory
DbEnv::set_create_dir(), DbEnv::get_create_dir() | add an environment data directory
DbEnv::set_encrypt(), DbEnv::get_encrypt_flags() | Set/get the environment cryptographic key
DbEnv::set_event_notify() | Set event notification callback
DbEnv::set_errcall() | Set error message callbacks
DbEnv::set_errfile(), DbEnv::get_errfile() | Set/get error message FILE
DbEnv::set_error_stream() | Set C++ ostream used for error messages
DbEnv::set_errpfx(), DbEnv::get_errpfx() | Set/get error message prefix
DbEnv::set_feedback() | Set feedback callback
DbEnv::set_flags(), DbEnv::get_flags() | Environment configuration
DbEnv::set_intermediate_dir_mode(), DbEnv::get_intermediate_dir_mode() | Set/get intermediate directory creation mode
DbEnv::set_isalive() | Set thread is-alive callback
DbEnv::set_memory_init(), DbEnv::get_memory_init() | Set/get initial memory allocation
DbEnv::set_memory_max(), DbEnv::get_memory_max() | Set/get maximum memory allocation
DbEnv::set_metadata_dir(), DbEnv::get_metadata_dir() | Set/get the directory containing environment metadata
DbEnv::set_message_stream() | Set C++ ostream used for informational messages
DbEnv::set_msgcall() | Set informational message callback
DbEnv::set_msgfile(), DbEnv::get_msgfile() | Set/get informational message FILE
DbEnv::set_shm_key(), DbEnv::get_shm_key() | Set/get system memory shared segment ID
DbEnv::set_thread_count(), DbEnv::get_thread_count() | Set/get approximate thread count
DbEnv::set_thread_id() | Set thread of control ID function
DbEnv::set_thread_id_string() | Set thread of control ID format function
DbEnv::set_timeout(), DbEnv::get_timeout() | Set/get lock and transaction timeout
DbEnv::set_tmp_dir(), DbEnv::get_tmp_dir() | Set/get the environment temporary file directory
DbEnv::set_verbose(), DbEnv::get_verbose() | Set/get verbose messages
DbEnv::stat_print() | Environment statistics
DbEnv::strerror() | Error strings
DbEnv::version() | Return version information
DbDeadlockException | Exception class for deadlocks
DbLockNotGrantedException | Exception class for lock request failures
DbMemoryException | Exception class for insufficient memory
DbRepHandleDeadException | Exception class for database and cursor handles that are invalidated in a replicated application.
DbRunRecoveryException | Exception class for failures requiring recovery
DbEnv::set_lk_conflicts(), DbEnv::get_lk_conflicts() | Set/get lock conflicts matrix
DbEnv::set_lk_detect(), DbEnv::get_lk_detect() | Set/get automatic deadlock detection
DbEnv::set_lk_max_lockers(), DbEnv::get_lk_max_lockers() | Set/get maximum number of lockers
DbEnv::set_lk_max_locks(), DbEnv::get_lk_max_locks() | Set/get maximum number of locks
DbEnv::set_lk_max_objects(), DbEnv::get_lk_max_objects() | Set/get maximum number of lock objects
DbEnv::set_lk_partitions(), DbEnv::get_lk_partitions() | Set/get number of lock partitions
DbEnv::set_lk_priority(), DbEnv::get_lk_priority() | Set/get a locker's deadlock priority
DbEnv::set_lk_tablesize(), DbEnv::get_lk_tablesize() | Set/get size of the lock object hash table
DbEnv::lock_detect() | Perform deadlock detection
DbEnv::lock_get() | Acquire a lock
DbEnv::lock_id() | Acquire a locker ID
DbEnv::lock_id_free() | Release a locker ID
DbEnv::lock_put() | Release a lock
DbEnv::lock_stat() | Return lock subsystem statistics
DbEnv::lock_stat_print() | Print lock subsystem statistics
DbEnv::lock_vec() | Acquire/release locks
DbEnv::log_archive() | List log and database files
DbEnv::log_cursor() | Create a log cursor handle
DbEnv::log_file() | Map Log Sequence Numbers to log files
DbEnv::log_flush() | Flush log records
DbEnv::log_printf() | Append informational message to the log
DbEnv::log_put() | Write a log record
DbEnv::log_set_config(), DbEnv::log_get_config() | Configure the logging subsystem
DbEnv::log_stat() | Return log subsystem statistics
DbEnv::log_stat_print() | Print log subsystem statistics
DbEnv::set_lg_bsize(), DbEnv::get_lg_bsize() | Set/get log buffer size
DbEnv::set_lg_dir(), DbEnv::get_lg_dir() | Set/get the environment logging directory
DbEnv::set_lg_filemode(), DbEnv::get_lg_filemode() | Set/get log file mode
DbEnv::set_lg_max(), DbEnv::get_lg_max() | Set/get log file size
DbEnv::set_lg_regionmax(), DbEnv::get_lg_regionmax() | Set/get logging region size
The DbLogc Handle | A log cursor handle
DbLogc::close() | Close a log cursor
DbLogc::get() | Retrieve a log record
DbEnv::log_compare() | Compare two Log Sequence Numbers
Db::get_mpf() | Return the DbMpoolFile for a Db
DbEnv::memp_fcreate() | Create a memory pool file handle
DbEnv::memp_register() | Register a custom file type
DbEnv::memp_stat() | Return cache statistics
DbEnv::memp_stat_print() | Print cache statistics
DbEnv::memp_sync() | Flush all pages from the cache
DbEnv::memp_trickle() | Flush some pages from the cache
DbEnv::set_cache_max(), DbEnv::get_cache_max() | Set/get the maximum cache size
DbEnv::set_cachesize(), DbEnv::get_cachesize() | Set/get the environment cache size
DbEnv::set_mp_max_openfd(), DbEnv::get_mp_max_openfd() | Set/get the maximum number of open file descriptors
DbEnv::set_mp_max_write(), DbEnv::get_mp_max_write() | Set/get the maximum number of sequential disk writes
DbEnv::set_mp_mmapsize(), DbEnv::get_mp_mmapsize() | Set/get maximum file size to memory map when opened read-only
DbEnv::set_mp_mtxcount(), DbEnv::get_mp_mtxcount() | Set/get the number of mutexes allocated to the hash table
DbEnv::set_mp_pagesize(), DbEnv::get_mp_pagesize() | Set/get page size to configure the buffer pool
DbEnv::set_mp_tablesize(), DbEnv::get_mp_tablesize() | Set/get the hash table size
DbMpoolFile::close() | Close a file in the cache
DbMpoolFile::get() | Get page from a file in the cache
DbMpoolFile::open() | Open a file in the cache
DbMpoolFile::put() | Return a page to the cache
DbMpoolFile::sync() | Flush pages from a file from the cache
DbMpoolFile::set_clear_len(), DbMpoolFile::get_clear_len() | Set/get number of bytes to clear when creating a new page
DbMpoolFile::set_fileid(), DbMpoolFile::get_fileid() | Set/get file unique identifier
DbMpoolFile::set_flags(), DbMpoolFile::get_flags() | Set/get file options
DbMpoolFile::set_ftype(), DbMpoolFile::get_ftype() | Set/get file type
DbMpoolFile::set_lsn_offset(), DbMpoolFile::get_lsn_offset() | Set/get file log-sequence-number offset
DbMpoolFile::set_maxsize(), DbMpoolFile::get_maxsize() | Set/get maximum file size
DbMpoolFile::set_pgcookie(), DbMpoolFile::get_pgcookie() | Set/get file cookie for pgin/pgout
DbMpoolFile::set_priority(), DbMpoolFile::get_priority() | Set/get cache file priority
DbEnv::mutex_alloc() | Allocate a mutex
DbEnv::mutex_free() | Free a mutex
DbEnv::mutex_lock() | Lock a mutex
DbEnv::mutex_set_align(), DbEnv::mutex_get_align() | Configure mutex alignment
DbEnv::mutex_set_increment(), DbEnv::mutex_get_increment() | Configure number of additional mutexes
DbEnv::mutex_set_init(), DbEnv::mutex_get_init() | Configure initial number of mutexes
DbEnv::mutex_set_max(), DbEnv::mutex_get_max() | Configure total number of mutexes
DbEnv::mutex_set_tas_spins(), DbEnv::mutex_get_tas_spins() | Configure test-and-set mutex spin count
DbEnv::mutex_stat() | Mutex statistics
DbEnv::mutex_stat_print() | Print mutex statistics
DbEnv::mutex_unlock() | Unlock a mutex
DbChannel::close() | Closes a DB_CHANNEL handle
DbChannel::send_msg() | Sends an asynchronous message on a DB_CHANNEL
DbChannel::send_request() | Sends a synchronous message on a DB_CHANNEL
DbChannel::set_timeout() | Sets the default timeout for a DB_CHANNEL
DbSite::get_address() | Returns a site's network address
DbSite::get_eid() | Returns a site's environment ID
DbSite::remove() | Removes the site from the replication group
DbSite::set_config(), DbSite::get_config() | Configure a DB_SITE handle
DbEnv::rep_elect() | Hold a replication election
DbEnv::rep_process_message() | Process a replication message
DbEnv::rep_set_clockskew(), DbEnv::rep_get_clockskew() | Configure master lease clock adjustment
DbEnv::rep_set_config(), DbEnv::rep_get_config() | Configure the replication subsystem
DbEnv::rep_set_limit(), DbEnv::rep_get_limit() | Limit data sent in response to a single message
DbEnv::rep_set_nsites(), DbEnv::rep_get_nsites() | Configure replication group site count
DbEnv::rep_set_priority(), DbEnv::rep_get_priority() | Configure replication site priority
DbEnv::rep_set_request(), DbEnv::rep_get_request() | Configure replication client retransmission requests
DbEnv::rep_set_timeout(), DbEnv::rep_get_timeout() | Configure replication timeouts
DbEnv::rep_set_transport() | Configure replication transport callback
DbEnv::rep_set_view() | Configure the replication view callback
DbEnv::rep_start() | Start replication
DbEnv::rep_stat() | Replication statistics
DbEnv::rep_stat_print() | Print replication statistics
DbEnv::rep_sync() | Replication synchronization
DbEnv::repmgr_channel() | Creates a DB_CHANNEL handle
DbEnv::repmgr_local_site() | Returns a DB_SITE handle for the local site
DbEnv::repmgr_msg_dispatch() | Configures a DB_CHANNEL's message dispatch function
DbEnv::repmgr_set_ack_policy(), DbEnv::repmgr_get_ack_policy() | Specify the Replication Manager's client acknowledgement policy
DbEnv::repmgr_site() | Creates a DB_SITE handle
DbEnv::repmgr_site_by_eid() | Creates a DB_SITE handle given an EID value
DbEnv::repmgr_site_list() | List the sites and their status
DbEnv::repmgr_start() | Start the Replication Manager
DbEnv::repmgr_stat() | Replication Manager statistics
DbEnv::repmgr_stat_print() | Print Replication Manager statistics
DbSite::close() | Closes the DB_SITE handle
DbEnv::txn_applied() | Check if a transaction has been replicated
DbTxn::set_commit_token() | Set a commit token
DbSequence | Create a sequence handle
DbSequence::close() | Close a sequence
DbSequence::get() | Get the next sequence element(s)
DbSequence::get_dbp() | Return a handle for the underlying sequence database
DbSequence::get_key() | Return the key for a sequence
DbSequence::initial_value() | Set the initial value of a sequence
DbSequence::open() | Open a sequence
DbSequence::remove() | Remove a sequence
DbSequence::set_cachesize(), DbSequence::get_cachesize() | Set/get the cache size of a sequence
DbSequence::set_flags(), DbSequence::get_flags() | Set/get the flags for a sequence
DbSequence::set_range(), DbSequence::get_range() | Set/get the range for a sequence
DbSequence::stat() | Return sequence statistics
DbSequence::stat_print() | Print sequence statistics
Db::get_transactional() | Does the Db have transaction support
DbEnv::cdsgroup_begin() | Get a locker ID in Berkeley DB Concurrent Data Store
DbEnv::set_tx_max(), DbEnv::get_tx_max() | Set/get maximum number of transactions
DbEnv::set_tx_timestamp(), DbEnv::get_tx_timestamp() | Set/get recovery timestamp
DbEnv::txn_recover() | Distributed transaction recovery
DbEnv::txn_begin() | Begin a transaction
DbEnv::txn_checkpoint() | Checkpoint the transaction subsystem
DbEnv::txn_stat() | Return transaction subsystem statistics
DbEnv::txn_stat_print() | Print transaction subsystem statistics
DbTxn::abort() | Abort a transaction
DbTxn::commit() | Commit a transaction
DbTxn::discard() | Discard a prepared but not resolved transaction handle
DbTxn::id() | Return a transaction's ID
DbTxn::prepare() | Prepare a transaction for commit
DbTxn::set_name(), DbTxn::get_name() | Associate a string with a transaction
DbTxn::set_priority(), DbTxn::get_priority() | Set/get transaction's priority
DbTxn::set_timeout() | Set transaction timeout
Db::set_blob_dir(), Db::get_blob_dir() | Sets/gets the location where blob data is stored
Db::set_blob_threshold(), Db::get_blob_threshold() | Sets/gets the size when data records are stored as blobs
Dbc::db_stream() | Create a BLOB stream
DbStream::close() | Close a BLOB stream
DbStream::read() | Read a BLOB stream
DbStream::size() | Returns the size of a BLOB
DbStream::write() | Write a BLOB stream
DbEnv::set_blob_dir(), DbEnv::get_blob_dir() | Sets/gets the location where blob data is stored
DbEnv::set_blob_threshold(), DbEnv::get_blob_threshold() | Sets/gets the default size for the environment when BLOBs are used
db_archive | Archival utility
db_checkpoint | Transaction checkpoint utility
db_deadlock | Deadlock detection utility
db_dump | Database dump utility
db_hotbackup | Hot backup utility
db_load | Database load utility
db_log_verify | Log verification utility
db_printlog | Transaction log display utility
db_recover | Recovery utility
db_replicate | Replication utility
db_sql_codegen | SQL schema to Berkeley DB code in C
dbsql | Command line interface to libdb_sql
db_stat | Statistics utility
db_tuner | Suggest a page size for optimal operation in a btree database
db_upgrade | Database upgrade utility
db_verify | Verification utility
sqlite3 | Command line tool for wrapper library libsqlite3
add_data_dir | Sets the mutex alignment.
mutex_set_align | Sets the mutex alignment.
mutex_set_increment | Configures the number of additional mutexes to allocate.
mutex_set_max | Configures the total number of mutexes to allocate.
mutex_set_tas_spins | Specifies the number of times the test-and-set mutexes should spin without blocking.
rep_set_clockskew | Sets the clock skew ratio.
rep_set_config | Configures the Berkeley DB replication subsystem.
rep_set_limit | Sets record transmission throttling.
rep_set_nsites | Specifies the total number of sites in a replication group.
rep_set_priority | Specifies the database environment's priority.
rep_set_request | Sets a threshold before requesting retransmission of a missing message.
rep_set_timeout | Specifies a variety of replication timeout values.
repmgr_set_ack_policy | Specifies how master and client sites will handle acknowledgment.
repmgr_site | Identifies a Replication Manager host.
set_cachesize | Sets the size of the shared memory buffer pool.
set_cache_max | Sets the maximum size for set_cachesize parameter.
set_create_dir | Sets the directory path to create the access method database files.
set_flags | Configures a database environment.
set_intermediate_dir_mode | Configures the directory permissions.
set_lg_bsize | Sets the size of the in-memory log buffer.
set_lg_dir | Sets the path of the directory for logging files.
set_lg_filemode | Sets the absolute file mode for created log files.
set_lg_max | Sets the maximum size of a single file in the log.
set_lg_regionmax | Sets the size of the underlying logging area.
set_lk_detect | Sets the maximum number of locking entities.
set_lk_max_lockers | Sets the maximum number of locking entities.
set_lk_max_locks | Sets the maximum number of locks supported by the Berkeley DB environment.
set_lk_max_objects | Sets the maximum number of locked objects.
set_lk_partitions | Sets the number of lock table partitions in the Berkeley DB environment.
log_set_config | Configures the Berkeley DB logging subsystem.
set_mp_max_openfd | Limits the number of file descriptors the library will open concurrently when flushing dirty pages from the cache.
set_mp_max_write | Limits the number of sequential write operations
set_mp_mmapsize | Sets the maximum file size.
set_open_flags | Initializes specific subsystems of the Berkeley DB environment.
set_shm_key | Configures the database environment's base segment ID.
set_thread_count | Declares an approximate number of threads in the database environment.
set_timeout | Sets timeout values for locks or transactions.
set_tmp_dir | Specifies the directory path of temporary files.
set_tx_max | Configures support of simultaneously active transactions.
set_verbose | Enables/disables the Berkeley DB message output.

Legal Notice

This documentation is distributed under an open source license. You may review the terms of this license at: http://www.oracle.com/technetwork/database/berkeleydb/downloads/oslicense-093458.html

Oracle, Berkeley DB, and Sleepycat are trademarks or registered trademarks of Oracle. All rights to these marks are reserved. No third-party use is permitted without the express prior written consent of Oracle.

Other names may be trademarks of their respective owners.

To obtain a copy of this document's original source code, please submit a request to the Oracle Technology Network forum at: https://forums.oracle.com/forums/forum.jspa?forumID=271

6/25/2013

|  | Next
|  | Preface