Berkeley DB: Berkeley DB: C Interface
Description: Berkeley DB: An embedded database programmatic toolkit.
Keywords: embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++

# Berkeley DB: C Interface

Section | Method | Description
--- | --- | ---
Database Environment | db_env_create | Create an environment handle
| DB_ENV->close | Close an environment
| DB_ENV->dbremove | Remove a database
| DB_ENV->dbrename | Rename a database
| DB_ENV->err | Error message with error string
| DB_ENV->errx | Error message
| DB_ENV->open | Open an environment
| DB_ENV->remove | Remove an environment
| db_strerror | Error strings
| db_version | Return version information
Environment Configuration | DB_ENV->set_app_dispatch | Configure application recovery interface
| DB_ENV->set_alloc | Set local space allocation functions
| DB_ENV->set_data_dir | Set the environment data directory
| DB_ENV->set_encrypt | Set the environment cryptographic key
| DB_ENV->set_errcall | Set error message callback
| DB_ENV->set_errfile | Set error message FILE
| DB_ENV->set_errpfx | Set error message prefix
| DB_ENV->set_feedback | Set feedback callback
| DB_ENV->set_flags | Environment configuration
| DB_ENV->set_paniccall | Set panic callback
| DB_ENV->set_rpc_server | Establish an RPC server connection
| DB_ENV->set_shm_key | Set system memory shared segment ID
| DB_ENV->set_tas_spins | Set the number of test-and-set spins
| DB_ENV->set_timeout | Set lock and transaction timeout
| DB_ENV->set_tmp_dir | Set the environment temporary file directory
| DB_ENV->set_verbose | Set verbose messages
Database Operations | db_create | Create a database handle
| DB->associate | Associate a secondary index
| DB->close | Close a database
| DB->del | Delete items from a database
| DB->err | Error message with error string
| DB->errx | Error message
| DB->fd | Return a file descriptor from a database
| DB->get, DB->pget | Get items from a database
| DB->get_byteswapped | Return if the underlying database is in host order
| 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->stat | Return 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
Database Configuration | DB->set_alloc | Set local space allocation functions
| DB->set_cache_priority | Set the database cache priority
| DB->set_cachesize | Set the database cache size
| DB->set_dup_compare | Set a duplicate comparison function
| DB->set_encrypt | Set the database cryptographic key
| DB->set_errcall | Set error message callback
| DB->set_errfile | Set error message FILE
| DB->set_errpfx | Set error message prefix
| DB->set_feedback | Set feedback callback
| DB->set_flags | General database configuration
| DB->set_lorder | Set the database byte order
| DB->set_pagesize | Set the underlying database page size
| DB->set_paniccall | Set panic callback
Btree/Recno Configuration | DB->set_append_recno | Set record append callback
| DB->set_bt_compare | Set a Btree comparison function
| DB->set_bt_minkey | Set the minimum number of keys per Btree page
| DB->set_bt_prefix | Set a Btree prefix comparison function
| DB->set_re_delim | Set the variable-length record delimiter
| DB->set_re_len | Set the fixed-length record length
| DB->set_re_pad | Set the fixed-length record pad byte
| DB->set_re_source | Set the backing Recno text file
Hash Configuration | DB->set_h_ffactor | Set the Hash table density
| DB->set_h_hash | Set a hashing function
| DB->set_h_nelem | Set the Hash table size
Queue Configuration | DB->set_q_extentsize | Set Queue database extent size
Database Cursor Operations | DB->cursor | Create a cursor handle
| DBcursor->c_close | Close a cursor
| DBcursor->c_count | Return count of duplicates
| DBcursor->c_del | Delete by cursor
| DBcursor->c_dup | Duplicate a cursor
| DBcursor->c_get, DBcursor->c_pget | Retrieve by cursor
| DBcursor->c_put | Store by cursor
Key/Data Pairs | DBT |
Bulk Retrieval | DB_MULTIPLE_INIT |
Lock Subsystem | DB_ENV->set_lk_conflicts | Set lock conflicts matrix
| DB_ENV->set_lk_detect | Set automatic deadlock detection
| DB_ENV->set_lk_max_lockers | Set maximum number of lockers
| DB_ENV->set_lk_max_locks | Set maximum number of locks
| DB_ENV->set_lk_max_objects | Set maximum number of lock objects
| DB_ENV->lock_detect | Perform deadlock detection
| DB_ENV->lock_get | Acquire a lock
| DB_ENV->lock_id | Acquire a locker ID
| DB_ENV->lock_id_free | Release a locker ID
| DB_ENV->lock_put | Release a lock
| DB_ENV->lock_stat | Return lock subsystem statistics
| DB_ENV->lock_vec | Acquire/release locks
Log Subsystem | DB_ENV->set_lg_bsize | Set log buffer size
| DB_ENV->set_lg_dir | Set the environment logging directory
| DB_ENV->set_lg_max | Set log file size
| DB_ENV->set_lg_regionmax | Set logging region size
| DB_ENV->log_archive | List log and database files
| DB_ENV->log_file | Map Log Sequence Numbers to log files
| DB_ENV->log_flush | Flush log records
| DB_ENV->log_put | Write a log record
| DB_ENV->log_stat | Return log subsystem statistics
Log Cursor Operations | DB_ENV->log_cursor | Create a log cursor handle
| DB_LOGC->close | Close a log cursor
| DB_LOGC->get | Retrieve a log record
Log Sequence Numbers | DB_LSN |
| log_compare | Compare two Log Sequence Numbers
Memory Pool Subsystem | DB_ENV->set_cachesize | Set the environment cache size
| DB_ENV->set_mp_mmapsize | Set maximum mapped-in database file size
| DB_ENV->memp_register | Register input/output functions for a file in a memory pool
| DB_ENV->memp_stat | Return memory pool statistics
| DB_ENV->memp_sync | Flush pages from a memory pool
| DB_ENV->memp_trickle | Trickle flush pages from a memory pool
Memory Pool Files | DB_ENV->memp_fcreate | Open a file in a memory pool
| DB_MPOOLFILE->close | Close a file in a memory pool
| DB_MPOOLFILE->get | Get page from a file in a memory pool
| DB_MPOOLFILE->open | Open a file in a memory pool
| DB_MPOOLFILE->put | Return a page to a memory pool
| DB_MPOOLFILE->set | Set memory pool page status
| DB_MPOOLFILE->sync | Flush pages from a file in a memory pool
| DB_MPOOLFILE->set_clear_len | Set file page bytes to be cleared
| DB_MPOOLFILE->set_fileid | Set file unique identifier
| DB_MPOOLFILE->set_ftype | Set file type
| DB_MPOOLFILE->set_lsn_offset | Set file log-sequence-number offset
| DB_MPOOLFILE->set_pgcookie | Set file cookie for pgin/pgout
Transaction Subsystem | DB_ENV->set_tx_max | Set maximum number of transactions
| DB_ENV->set_tx_timestamp | Set recovery timestamp
| DB_ENV->txn_checkpoint | Checkpoint the transaction subsystem
| DB_ENV->txn_recover | Distributed transaction recovery
| DB_ENV->txn_stat | Return transaction subsystem statistics
Transactions | DB_ENV->txn_begin | Begin a transaction
| DB_TXN->abort | Abort a transaction
| DB_TXN->commit | Commit a transaction
| DB_TXN->discard | Discard a prepared but not resolved transaction handle
| DB_TXN->id | Return a transaction's ID
| DB_TXN->prepare | Prepare a transaction for commit
| DB_TXN->set_timeout | Set transaction timeout
Replication | DB_ENV->set_rep_transport | Configure replication transport
| DB_ENV->rep_elect | Hold a replication election
| DB_ENV->set_rep_limit | Limit data sent in response to a single message
| DB_ENV->rep_process_message | Process a replication message
| DB_ENV->rep_start | Configure an environment for replication
| DB_ENV->rep_stat | Replication statistics
Historic Interfaces | dbm | UNIX Dbm/Ndbm Interfaces
| hsearch | UNIX Hsearch Interfaces
System Configuration | Run-time configuration | Replace underlying Berkeley DB system interfaces

Copyright Sleepycat Software