Reference Guide Table of Contents

  1. Introduction
    1. An introduction to data management
    2. Mapping the terrain: theory and practice
    3. What is Berkeley DB?
    4. What is Berkeley DB not?
    5. Do you need Berkeley DB?
    6. What other services does Berkeley DB provide?
    7. What does the Berkeley DB distribution include?
    8. Where does Berkeley DB run?
    9. Sleepycat Software's Berkeley DB products
  2. Getting Started: A Simple Tutorial
    1. Introduction
    2. Key/data pairs
    3. Object handles
    4. Error returns
    5. Opening a database
    6. Adding elements to a database
    7. Retrieving elements from a database
    8. Removing elements from a database
    9. Closing a database
  3. Access Method Configuration
    1. What are the available access methods?
    2. Selecting an access method
    3. Logical record numbers
    4. General access method configuration
      1. Selecting a page size
      2. Selecting a cache size
      3. Selecting a byte order
      4. Duplicate data items
      5. Non-local memory allocation
    5. Btree access method specific configuration
      1. Btree comparison
      2. Btree prefix comparison
      3. Minimum keys per page
      4. Retrieving Btree records by logical record number
    6. Hash access method specific configuration
      1. Page fill factor
      2. Specifying a database hash
      3. Hash table size
    7. Queue and Recno access method specific configuration
      1. Managing record-based databases
      2. Selecting a Queue extent size
      3. Flat-text backing files
      4. Logically renumbering records
  4. Access Method Operations
    1. Access method operations
    2. Opening a database
    3. Opening multiple databases in a single file
    4. Upgrading databases
    5. Retrieving records
    6. Storing records
    7. Deleting records
    8. Flushing the database cache
    9. Database statistics
    10. Closing a database
    11. Database cursors
      1. Retrieving records with a cursor
      2. Storing records with a cursor
      3. Deleting records with a cursor
      4. Duplicating a cursor
      5. Logical join
      6. Data item count
      7. Closing a cursor
      8. Cursor stability
    12. Partial record storage and retrieval
    13. Database verification and salvage
    14. Error support
  5. Berkeley DB Architecture
    1. The big picture
    2. Programming model
    3. Programmatic APIs
    4. Scripting languages
    5. Supporting utilities
  6. The Berkeley DB Environment
    1. Introduction
    2. Creating an environment
    3. File naming
    4. Security
    5. Shared memory regions
    6. Remote filesystems
    7. Opening databases within the environment
    8. Error support
  7. Berkeley DB Concurrent Data Store Applications
    1. Building Berkeley DB Concurrent Data Store applications
  8. Berkeley DB Transactional Data Store Applications
    1. Building Berkeley DB Transactional Data Store applications
    2. Why transactions?
    3. Terminology
    4. Application structure
    5. Opening the environment
    6. Opening the databases
    7. Recoverability and deadlock avoidance
    8. Atomicity
    9. Repeatable reads
    10. Transactional cursors
    11. Environment infrastructure
    12. Deadlock detection
    13. Checkpoints
    14. Database and log file archival
    15. Log file removal
    16. Recovery procedures
    17. Recovery and filesystem operations
    18. Berkeley DB recoverability
    19. Transaction throughput
  9. XA Resource Manager
    1. Introduction
    2. Configuring Berkeley DB with The Tuxedo System
    3. Frequently Asked Questions
  10. Programmer Notes
    1. Application signal handling
    2. Error returns to applications
    3. Environmental variables
    4. Building multi-threaded applications
    5. Berkeley DB handles
    6. Name spaces
    7. Copying databases
    8. Library version information
    9. Database limits
    10. Byte ordering
    11. Disk space requirements
    12. Compatibility with historic interfaces
    13. Recovery implementation
    14. Application-specific logging and recovery
    15. Run-time configuration
  11. The Locking Subsystem
    1. Berkeley DB and locking
    2. Page locks
      1. Standard lock modes
      2. Locking without transactions
      3. Locking with transactions: two-phase locking
    3. Access method locking conventions
    4. Berkeley DB Concurrent Data Store locking conventions
    5. Deadlocks and deadlock avoidance
    6. Configuring locking
    7. Configuring locking: sizing the system
    8. Locking and non-Berkeley DB applications
  12. The Logging Subsystem
    1. Berkeley DB and logging
    2. Configuring logging
    3. Log file limits
  13. The Memory Pool Subsystem
    1. Berkeley DB and the memory pool
    2. Configuring the memory pool
  14. The Transaction Subsystem
    1. Berkeley DB and transactions
    2. Nested transactions
    3. Transaction limits
    4. Configuring transactions
    5. Transactions and non-Berkeley DB applications
  15. RPC Client/Server
    1. Introduction
    2. Client program
    3. Server program
  16. Java API
    1. Configuration
    2. Compatibility
    3. Programming notes
    4. Java FAQ
  17. Perl API
    1. Using Berkeley DB with Perl
  18. Tcl API
    1. Loading Berkeley DB with Tcl
    2. Using Berkeley DB with Tcl
    3. Tcl API programming notes
    4. Tcl error handling
    5. Tcl FAQ
  19. Sendmail
    1. Using Berkeley DB with Sendmail
  20. Dumping and Reloading Databases
    1. The db_dump and db_load utilities
    2. Dump output formats
    3. Loading text into databases
  21. System Installation Notes
    1. File utility /etc/magic information
  22. Debugging Applications
    1. Introduction
    2. Compile-time configuration
    3. Run-time error information
    4. Reviewing Berkeley DB log files
    5. Common errors
  23. Building Berkeley DB for UNIX and QNX systems
    1. Building for UNIX
    2. Configuring Berkeley DB
    3. Changing compile or load options
    4. Installing Berkeley DB
    5. Dynamic shared libraries
    6. Running the test suite under UNIX
    7. Architecture independent FAQ
    8. Architecture specific FAQs
      1. AIX
      2. FreeBSD
      3. HP-UX
      4. IRIX
      5. Linux
      6. OSF/1
      7. QNX
      8. SCO
      9. Solaris
      10. SunOS
      11. Ultrix
  24. Building Berkeley DB for Win32 platforms
    1. Building for Win32
    2. Running the test suite under Windows
    3. Windows notes
    4. Windows FAQ
  25. Building Berkeley DB for VxWorks systems
    1. Building for VxWorks
    2. VxWorks notes
    3. VxWorks FAQ
  26. Upgrading Berkeley DB Applications
    1. Upgrading Berkeley DB installations
    2. Upgrading Berkeley DB 1.XX applications to Berkeley DB 2.0
    3. Upgrading Berkeley DB 2.X.X applications to Berkeley DB 3.0
    4. Upgrading Berkeley DB 3.0.X applications to Berkeley DB 3.1
    5. Upgrading Berkeley DB 3.1.X applications to Berkeley DB 3.2
  27. Test Suite
    1. Running the test suite
    2. Test suite FAQ
  28. Distribution
    1. Source code layout
  29. Additional References
    1. Additional references

Copyright Sleepycat Software