Berkeley DB

The Official Berkeley DB Documentation from the creators, Sleepycat Software!

I. REFERENCE GUIDE.
1. Introduction.

Mapping the Terrain: Theory and Practice. What Is Berkeley DB? What Is Berkeley DB Not? Do You Need Berkeley DB? What Other Services Does Berkeley DB Provide? What Does the Berkeley DB Distribution Include? Where Does Berkeley DB Run? Sleepycat Software's Berkeley DB Products. 2. Getting Started: A Simple Tutorial.

Key/Data Pairs. Object Handles. Error Returns. Opening a Database. Adding Elements to a Database. Retrieving Elements from a Database. Removing Elements from a Database. Closing a Database. 3. Access Method Configuration.

Selecting an Access Method. Logical Record Numbers. Selecting a Page Size. Selecting a Cache Size. Selecting a Byte Order. Non-Local Memory Allocation. Btree Comparison. Btree Prefix Comparison. Minimum Keys Per Page. Retrieving Btree Records by Number. Page Fill Factor. Specifying a Database Hash. Hash Table Size. Managing Record-Based Databases. Selecting a Queue Extent Size. Flat-Text Backing Files. Logically Renumbering Records. Opening a Database. 4. Access Method Operations.

Opening Multiple Databases in a Single File. Upgrading Databases. Retrieving Records. Storing Records. Deleting Records. Flushing the Database Cache. Database Statistics. Closing a Database. Database Cursors. Retrieving Records with a Cursor. Storing Records with a Cursor. Deleting Records with a Cursor. Duplicating a Cursor. Logical Join. Data Item Count. Closing a Cursor. Cursor Stability. Database Verification and Salvage. Retrieved Key/Data Permanence for C/C++. Error Support. 5. Access Method Wrap-Up.

Database Limits. Disk Space Requirements. Partial Record Storage and Retrieval. 6. Berkeley DB Architecture.

Programming Model. Programmatic APIs. Scripting Languages. Supporting Utilities. 7. Berkeley DB Environment.

Creating a Database Environment. File Naming. Filename Resolution in Berkeley DB. Security. Shared Memory Regions. Remote Filesystems. Opening Databases Within the Environment. Error Support. 8. Berkeley DB Concurrent Data Store Applications.
9. Berkeley DB Transactional Data Store Applications.

Why Transactions? Terminology. Application Structure. Opening the Environment. Opening the Databases. Recoverability and Deadlock Avoidance. Atomicity. Repeatable Reads. Transactional Cursors. Nested Transactions. Environment Infrastructure. Deadlock Detection. Performing Checkpoints. Database and Log File Archival Procedures. Log File Removal. Recovery Procedures. Recovery and Filesystem Operations. Berkeley DB Recoverability. Transaction Throughput. 10. XA Resource Manager.

Configuring Berkeley DB with the Tuxedo System. Frequently Asked Questions. 11. Programmer Notes.

Error Returns to Applications. Environmental Variables. Building Multithreaded Applications. Berkeley DB Handles. Name Spaces. Library Version Information. Compatibility with Historic UNIX Interfaces. Recovery Implementation. Application-Specific Logging and Recovery. Run-Time Configuration. 12. The Locking Subsystem.

Page Locks. Standard Lock Modes. Locking Without Transactions. Locking with Transactions: Two-Phase Locking. Access Method Locking Conventions. Berkeley DB Concurrent Data Store Locking Conventions. Deadlocks and Deadlock Avoidance. Configuring Locking. Locking and Non-Berkeley DB Applications. 13. The Logging Subsystem.

Configuring Logging. Log File Limits. 14. The Memory Pool Subsystem.

Configuring the Memory Pool. 15. The Transaction Subsystem.

Transaction Limits. Configuring Transactions. Transactions and Non-Berkeley DB Applications. 16. RPC/Client Server.

Client Program. Server Program. 17. Java API.

Compatibility. Java Programming Notes. Java FAQ. Loading Berkeley DB with Tcl. 18. Tcl API.

Using Berkeley DB with Tcl. Tcl API Programming Notes. Tcl Error Handling. Tcl FAQ. The db_dump and db_load Utilities. 19. Dumping and Reloading Databases.

Dump Output Formats. Loading Text into Databases. 20. Debugging Applications.

Compile- time Configuration. Run-time Error Information. Reviewing Berkeley DB Log Files. Common Errors. Building for UNIX. 21. Building Berkeley DB for UNIX and QNX Systems.

Configuring Berkeley DB. Changing Compile or Load Options. Installing Berkeley DB. Dynamic Shared Libraries. Running the Test Suite Under UNIX. Architecture-Independent FAQs. AIX. FreeBSD. HP-UX. IRIX. Linux. OSF/1. SCO. Solaris. SunOS. Ultrix. Building for Win32. 22. Building Berkeley DB for Win32 Platforms.

Running the Test Suite Under Windows. Windows Notes. Windows FAQ. 23. Building Berkeley DB for VxWorks Systems.

VxWorks Notes. VxWorks FAQ. Upgrading Berkeley DB Installations. 24. Upgrading Berkeley DB Applications.

Running the Test Suite. 25. Test Suite.

Test Suite FAQ. 26. Distribution.

Technical Papers on Berkeley DB. 27. Additional References.

Background on Berkeley DB Features. Database Systems Theory. II. API MANUAL.
28. C API.
29. C++ API.
30. Java API.
31. Tcl API.
32. Supporting Utilities.