Uses of Class com.sleepycat.db.Database (Oracle - Berkeley DB Java API)
Date: 2020-06-01

## Uses of Class
com.sleepycat.db.Database

- Packages that use Database
  Package | Description
  --- | ---
  com.sleepycat.bind.serial | Bindings that use Java serialization.
  com.sleepycat.collections | Data access based on the standard Java collections API.
  com.sleepycat.db | Berkeley DB Java API [reference guide] [Java programming notes].
  com.sleepycat.persist | The Direct Persistence Layer (DPL) adds a persistent object model to the Berkeley DB transactional engine.

- - ### Uses of Database in com.sleepycat.bind.serial

    Constructors in com.sleepycat.bind.serial with parameters of type Database
    Constructor | Description
    --- | ---
    `StoredClassCatalog​(Database database)` | Creates a catalog based on a given database.

  - ### Uses of Database in com.sleepycat.collections

    Methods in com.sleepycat.collections with parameters of type Database
    Modifier and Type | Method | Description
    --- | --- | ---
    `<K,​V extends MarshalledTupleKeyEntity> StoredMap<K,​V>` | TupleSerialFactory.`newMap​(Database db, java.lang.Class<K> keyClass, java.lang.Class<V> valueBaseClass, boolean writeAllowed)` | Creates a map from a previously opened Database object.
    `<K,​V extends MarshalledTupleKeyEntity> StoredSortedMap<K,​V>` | TupleSerialFactory.`newSortedMap​(Database db, java.lang.Class<K> keyClass, java.lang.Class<V> valueBaseClass, boolean writeAllowed)` | Creates a sorted map from a previously opened Database object.

    Constructors in com.sleepycat.collections with parameters of type Database
    Constructor | Description
    --- | ---
    `StoredKeySet​(Database database, EntryBinding<K> keyBinding, boolean writeAllowed)` | Creates a key set view of a `Database`.
    `StoredList​(Database database, EntityBinding<E> valueEntityBinding, boolean writeAllowed)` | Creates a list entity view of a `Database`.
    `StoredList​(Database database, EntityBinding<E> valueEntityBinding, PrimaryKeyAssigner keyAssigner)` | Creates a list entity view of a `Database` with a `PrimaryKeyAssigner`.
    `StoredList​(Database database, EntryBinding<E> valueBinding, boolean writeAllowed)` | Creates a list view of a `Database`.
    `StoredList​(Database database, EntryBinding<E> valueBinding, PrimaryKeyAssigner keyAssigner)` | Creates a list view of a `Database` with a `PrimaryKeyAssigner`.
    `StoredMap​(Database database, EntryBinding<K> keyBinding, EntityBinding<V> valueEntityBinding, boolean writeAllowed)` | Creates a map entity view of a `Database`.
    `StoredMap​(Database database, EntryBinding<K> keyBinding, EntityBinding<V> valueEntityBinding, PrimaryKeyAssigner keyAssigner)` | Creates a map entity view of a `Database` with a `PrimaryKeyAssigner`.
    `StoredMap​(Database database, EntryBinding<K> keyBinding, EntryBinding<V> valueBinding, boolean writeAllowed)` | Creates a map view of a `Database`.
    `StoredMap​(Database database, EntryBinding<K> keyBinding, EntryBinding<V> valueBinding, PrimaryKeyAssigner keyAssigner)` | Creates a map view of a `Database` with a `PrimaryKeyAssigner`.
    `StoredSortedKeySet​(Database database, EntryBinding<K> keyBinding, boolean writeAllowed)` | Creates a sorted key set view of a `Database`.
    `StoredSortedMap​(Database database, EntryBinding<K> keyBinding, EntityBinding<V> valueEntityBinding, boolean writeAllowed)` | Creates a sorted map entity view of a `Database`.
    `StoredSortedMap​(Database database, EntryBinding<K> keyBinding, EntityBinding<V> valueEntityBinding, PrimaryKeyAssigner keyAssigner)` | Creates a sorted map entity view of a `Database` with a `PrimaryKeyAssigner`.
    `StoredSortedMap​(Database database, EntryBinding<K> keyBinding, EntryBinding<V> valueBinding, boolean writeAllowed)` | Creates a sorted map view of a `Database`.
    `StoredSortedMap​(Database database, EntryBinding<K> keyBinding, EntryBinding<V> valueBinding, PrimaryKeyAssigner keyAssigner)` | Creates a sorted map view of a `Database` with a `PrimaryKeyAssigner`.
    `StoredSortedValueSet​(Database database, EntityBinding<E> valueEntityBinding, boolean writeAllowed)` | Creates a sorted value set entity view of a `Database`.
    `StoredValueSet​(Database database, EntityBinding<E> valueEntityBinding, boolean writeAllowed)` | Creates a value set entity view of a `Database`.
    `StoredValueSet​(Database database, EntryBinding<E> valueBinding, boolean writeAllowed)` | Creates a value set view of a `Database`.

  - ### Uses of Database in com.sleepycat.db

    Subclasses of Database in com.sleepycat.db
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `SecondaryDatabase` | A secondary database handle.

    Methods in com.sleepycat.db that return Database
    Modifier and Type | Method | Description
    --- | --- | ---
    `Database` | Cursor.`getDatabase()` | Return the Database handle associated with this Cursor.
    `Database` | JoinCursor.`getDatabase()` | Returns the primary database handle associated with this cursor.
    `Database` | Sequence.`getDatabase()` | Return the Database handle associated with this sequence.
    `Database` | SecondaryDatabase.`getPrimaryDatabase()` | Returns the primary database associated with this secondary database.
    `Database[]` | Database.`getSlices()` | Get the Database handles of the underlying slices of the database.
    `Database` | Environment.`openDatabase​(Transaction txn, java.lang.String fileName, java.lang.String databaseName, DatabaseConfig config)` | Open a database.
    `Database` | Database.`sliceLookup​(DatabaseEntry key)` | Get the Database handle of the slice that contains the given key.

    Methods in com.sleepycat.db with parameters of type Database
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | RecordNumberAppender.`appendRecordNumber​(Database db, DatabaseEntry data, int recno)` | A callback function to modify the stored database based on the generated key.
    `boolean` | BtreeCompressor.`compress​(Database db, DatabaseEntry prevKey, DatabaseEntry prevData, DatabaseEntry key, DatabaseEntry data, DatabaseEntry dest)` | The application-specific Btree compress callback.
    `boolean` | BtreeCompressor.`decompress​(Database db, DatabaseEntry prevKey, DatabaseEntry prevData, DatabaseEntry compressed, DatabaseEntry key, DatabaseEntry data)` | The application-specific Btree decompress callback.
    `int` | Hasher.`hash​(Database db, byte[] data, int len)` | An application-specified, database-specific hash function.
    `SecondaryDatabase` | Environment.`openSecondaryDatabase​(Transaction txn, java.lang.String fileName, java.lang.String databaseName, Database primaryDatabase, SecondaryConfig config)` | Open a database.
    `int` | PartitionHandler.`partition​(Database db, DatabaseEntry key)` | The application-specific database partitioning callback.
    `int` | BtreePrefixCalculator.`prefix​(Database db, DatabaseEntry dbt1, DatabaseEntry dbt2)` | The application-specific Btree prefix callback.
    `void` | SecondaryConfig.`setForeignKeyDatabase​(Database foreignDb)` | Defines a foreign key integrity constraint for a given foreign key database.
    `boolean` | Slice.`slice​(Database db, DatabaseEntry key, DatabaseEntry sliceKey)` | The application-specific database slice callback.
    `void` | FeedbackHandler.`upgradeFeedback​(Database database, int percent)` | A function called with progress information when the database is being upgraded.
    `void` | FeedbackHandler.`verifyFeedback​(Database database, int percent)` | A function called with progress information when the database is being verified.

    Constructors in com.sleepycat.db with parameters of type Database
    Constructor | Description
    --- | ---
    `Cursor​(Database database, CursorConfig config)` |
    `SecondaryDatabase​(java.lang.String fileName, java.lang.String databaseName, Database primaryDatabase, SecondaryConfig config)` | Open a database.

  - ### Uses of Database in com.sleepycat.persist

    Methods in com.sleepycat.persist that return Database
    Modifier and Type | Method | Description
    --- | --- | ---
    `Database` | EntityIndex.`getDatabase()` | Returns the underlying database for this index.
    `Database` | SecondaryIndex.`getKeysDatabase()` | Returns the underlying secondary database that is not associated with the primary database and is used for the `SecondaryIndex.keysIndex`.

    Constructors in com.sleepycat.persist with parameters of type Database
    Constructor | Description
    --- | ---
    `PrimaryIndex​(Database database, java.lang.Class<PK> keyClass, EntryBinding<PK> keyBinding, java.lang.Class<E> entityClass, EntityBinding<E> entityBinding)` | Creates a primary index without using an `EntityStore`.
    `SecondaryIndex​(SecondaryDatabase database, Database keysDatabase, PrimaryIndex<PK,​E> primaryIndex, java.lang.Class<SK> secondaryKeyClass, EntryBinding<SK> secondaryKeyBinding)` | Creates a secondary index without using an `EntityStore`.

Copyright (c) 1996, 2020 Oracle and/or its affiliates. All rights reserved.