Berkeley DB Java Edition
version ${release.version}

Package com.sleepycat.je

Foundation for creating environments, databases and transactions; provides cursor based data access.

See:
          Description

Interface Summary
ExceptionListener A callback to notify the application program when an exception occurs in a JE Daemon thread.
ForeignKeyNullifier The interface implemented for setting single-valued foreign keys to null.
ForeignMultiKeyNullifier The interface implemented for setting multi-valued foreign keys to null.
SecondaryKeyCreator The interface implemented for extracting single-valued secondary keys from primary records.
SecondaryMultiKeyCreator The interface implemented for extracting multi-valued secondary keys from primary records.
 

Class Summary
BtreeStats The BtreeStats object is used to return Btree database statistics.
CheckpointConfig Specifies the attributes of a checkpoint operation invoked from Environment.checkpoint.
Cursor A database cursor.
CursorConfig Specifies the attributes of database cursor.
Database A database handle.
DatabaseConfig Specifies the attributes of a database.
DatabaseEntry Encodes database key and data items as a byte array.
DatabaseStats Statistics for a single database.
Environment A database environment.
EnvironmentConfig Specifies the attributes of an environment.
EnvironmentMutableConfig Specifies the environment attributes that may be changed after the environment has been opened.
EnvironmentStats System wide statistics for a single environment.
ExceptionEvent A class representing an exception event.
ForeignKeyDeleteAction The action taken when a referenced record in the foreign key database is deleted.
JEVersion Berkeley DB Java Edition version information.
JoinConfig The configuration properties of a JoinCursor.
JoinCursor A specialized join cursor for use in performing equality or natural joins on secondary indices.
LockMode Record lock modes for read operations.
LockStats Lock statistics for a database environment.
OperationStatus Status values from database operations.
PreloadConfig Specifies the attributes of an application invoked preload operation.
PreloadStats Statistics returned from Database.preload
PreloadStatus Describes the result of the Database.preload operation.
SecondaryConfig The configuration properties of a SecondaryDatabase extend those of a primary Database.
SecondaryCursor A database cursor for a secondary database.
SecondaryDatabase A secondary database handle.
Sequence A Sequence handle is used to manipulate a sequence record in a database.
SequenceConfig Specifies the attributes of a sequence.
SequenceStats A SequenceStats object is used to return sequence statistics.
StatsConfig Specifies the attributes of a statistics retrieval operation.
Transaction The Transaction object is the handle for a transaction.
TransactionConfig Specifies the attributes of a database environment transaction.
TransactionStats Transaction statistics for a database environment.
TransactionStats.Active The Active class represents an active transaction.
VerifyConfig Specifies the attributes of a verification operation.
XAEnvironment An Environment that implements XAResource.
 

Enum Summary
CacheMode Modes that can be specified for control over caching of records in the JE in-memory cache.
 

Exception Summary
DatabaseException The root of all database exceptions.
DatabaseNotFoundException Thrown when an operation requires a database and that database does not exist.
DeadlockException DeadlockException is thrown to a thread of control when multiple threads competing for a lock are deadlocked or when a lock request would need to block and the transaction has been configured to not wait for locks.
EnvironmentLockedException Thrown by the Environment constructor when an environment cannot be opened for write access because another process has the same environment open for write access.
LockNotGrantedException A LockNotGrantedException is thrown when a non-blocking operation fails to get a lock.
RunRecoveryException Thrown when the JE environment has encountered an exception or a resource shortfall and cannot continue on safely.
 

Package com.sleepycat.je Description

Foundation for creating environments, databases and transactions; provides cursor based data access.

Package Specification

This package constitutes the base public API for Berkeley DB, Java Edition. The classes here are used to create database objects, and insert and retrieve data.

This package provides a key/data pair model of a database record. Databases and database cursors are the key objects used to access data. An alternative collections based API is available through com.sleepycat.collections.

The Environment class embodies the database environment and is the starting point for the application. Databases and transaction objects are created through the Environment class.

Data can be inserted and retrieved directly through the Database object, or through a Cursor obtained from the Database. A database record consist of a key/data pair, where key and data are each individually represented by a DatabaseEntry object. Classes in com.sleepycat.bind provide optional support for mapping a Java object to a DatabaseEntry.

Configuration classes are used to specify the attributes of particular operations. For example the attributes of a database environment are specified in the EnvironmentConfig class. An instance of that class is required for Environment construction. Likewise, the attributes of a database are described in DatabaseConfig, which is a parameter to the Environment.openDatabase() method.

See Also:
[Getting Started Guide]

Berkeley DB Java Edition
version ${release.version}

Copyright (c) 2004,2008 Oracle. All rights reserved.