Getting Started with Berkeley DB Java Edition

Legal Notice

Copyright © 2002 - 2017 Oracle and/or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

Berkeley DB, Berkeley DB Java Edition 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.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.


Table of Contents

Conventions Used in this Book
For More Information
Contact Us
1. Introduction to Berkeley DB Java Edition
DPL Features
Base API Features
Which API Should You Use?
The JE Application
Database Environments
Key-Data Pairs
Storing Data
Duplicate Data
Replacing and Deleting Entries
Secondary Keys
JE Resources
Application Considerations
JE Backup and Restore
JCA Support
JConsole and JMX Support
Getting and Using JE
JE Exceptions
Six Things Everyone Should Know about JE Log Files
2. Database Environments
Opening Database Environments
Multiple Environments
Multiple Environment Subdirectories
Configuring a Shared Cache for Multiple Environments
Closing Database Environments
Environment Properties
The EnvironmentConfig Class
Environment Statistics
Database Environment Management Example
I. Programming with the Direct Persistence Layer
3. Direct Persistence Layer First Steps
Entity Stores
Opening and Closing Environments and Stores
Persistent Objects
Saving and Retrieving Data
4. Working with Indices
Accessing Indexes
Accessing Primary Indices
Accessing Secondary Indices
Creating Indexes
Declaring Primary Indexes
Declaring Secondary Indexes
Foreign Key Constraints
5. Saving and Retrieving Objects
A Simple Entity Class
Placing Objects in an Entity Store
Retrieving Objects from an Entity Store
Retrieving Multiple Objects
Cursor Initialization
Working with Duplicate Keys
Key Ranges
Join Cursors
Deleting Entity Objects
Replacing Entity Objects
6. A DPL Example
II. Programming with the Base API
7. Databases
Opening Databases
Deferred Write Databases
Temporary Databases
Closing Databases
Database Properties
Administrative Methods
Database Example
8. Database Records
Using Database Records
Reading and Writing Database Records
Writing Records to the Database
Getting Records from the Database
Deleting Records
Data Persistence
Using Time to Live
Specifying a TTL Value
Updating a TTL Value
Deleting TTL Expiration
Using the BIND APIs
Numerical and String Objects
Serializable Complex Objects
Custom Tuple Bindings
Using Comparators
Writing Comparators
Setting Comparators
Database Record Example
9. Using Cursors
Opening and Closing Cursors
Getting Records Using the Cursor
Disk Ordered Cursors
Searching for Records
Working with Duplicate Records
Putting Records Using Cursors
Deleting Records Using Cursors
Replacing Records Using Cursors
Cursor Example
10. Secondary Databases
Opening and Closing Secondary Databases
Implementing Key Creators
Secondary Database Properties
Reading Secondary Databases
Deleting Secondary Database Records
Using Secondary Cursors
Database Joins
Using Join Cursors
JoinCursor Properties
Secondary Database Example
Opening Secondary Databases with MyDbEnv
Using Secondary Databases with ExampleInventoryRead
III. Administering JE Applications
11. Backing up and Restoring Berkeley DB Java Edition Applications
Databases and Log Files
Log File Overview
Cleaning the Log Files
The BTree
Database Modifications and Syncs
Normal Recovery
Performing Backups
Performing a Hot Backup
Performing an Offline Backup
Using the DbBackup Helper Class
Performing Catastrophic Recovery
Hot Standby
12. Administering Berkeley DB Java Edition Applications
The JE Properties File
Managing the Background Threads
The Cleaner Thread
The Checkpointer Thread
Sizing the Cache
Setting Disk Thresholds
The Command Line Tools
Managing Logging Levels
Managing Handler Levels
A. Concurrent Processing in Berkeley DB Java Edition
Multithreaded Applications
Multiprocess Applications

List of Examples

2.1. Database Environment Management Class
7.1. Database Management with MyDbEnv
8.4. Stored Class Catalog Management with MyDbEnv
10.2. SecondaryDatabase Management with MyDbEnv
10.3. SecondaryDatabase usage with ExampleInventoryRead