Uses of Class com.sleepycat.client.SDatabase (Oracle - Berkeley DB Client-Server API)
Date: 2018-05-29

## Uses of Class
com.sleepycat.client.SDatabase

- Packages that use SDatabase
  Package | Description
  --- | ---
  com.sleepycat.client |
  com.sleepycat.client.collections | Data access based on the standard Java collections API.
  com.sleepycat.client.persist | The Direct Persistence Layer (DPL) adds a persistent object model to the Berkeley DB transactional engine.

- - ### Uses of SDatabase in com.sleepycat.client

    Subclasses of SDatabase in com.sleepycat.client
    Modifier and Type | Class and Description
    --- | ---
    `class` | `SSecondaryDatabase` A secondary database handle.

    Methods in com.sleepycat.client that return SDatabase
    Modifier and Type | Method and Description
    --- | ---
    `SDatabase` | SJoinCursor.`getDatabase()` Returns the primary database handle associated with this cursor.
    `SDatabase` | SCursor.`getDatabase()` Return the `SDatabase` handle associated with this cursor.
    `SDatabase` | SSequence.`getDatabase()` Return the SDatabase handle associated with this sequence.
    `SDatabase` | SSecondaryConfig.`getForeignKeyDatabase()` Return the database used to check the foreign key integrity constraint, or null if no foreign key constraint will be checked.
    `SDatabase` | SSecondaryDatabase.`getPrimaryDatabase()` Returns the primary database associated with this secondary database.
    `SDatabase` | SEnvironment.`openDatabase(STransaction txn, java.lang.String fileName, java.lang.String databaseName, SDatabaseConfig config)` Open a database.

    Methods in com.sleepycat.client with parameters of type SDatabase
    Modifier and Type | Method and Description
    --- | ---
    `SSecondaryDatabase` | SEnvironment.`openSecondaryDatabase(STransaction txn, java.lang.String fileName, java.lang.String databaseName, SDatabase primaryDatabase, SSecondaryConfig config)` Open a secondary database.
    `SSecondaryConfig` | SSecondaryConfig.`setForeignKeyDatabase(SDatabase foreignDb)` Define a foreign key integrity constraint for a given foreign key database.

    Constructors in com.sleepycat.client with parameters of type SDatabase
    Constructor and Description
    `SCursor(TCursor tCursor, SDatabase database, STransaction txn, BdbService.Client client)`

  - ### Uses of SDatabase in com.sleepycat.client.collections

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

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

  - ### Uses of SDatabase in com.sleepycat.client.persist

    Methods in com.sleepycat.client.persist that return SDatabase
    Modifier and Type | Method and Description
    --- | ---
    `SDatabase` | EntityIndex.`getDatabase()` Returns the underlying database for this index.
    `SDatabase` | 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.client.persist with parameters of type SDatabase
    Constructor and Description
    `PrimaryIndex(SDatabase 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(SSecondaryDatabase database, SDatabase keysDatabase, PrimaryIndex<PK,E> primaryIndex, java.lang.Class<SK> secondaryKeyClass, EntryBinding<SK> secondaryKeyBinding)` Creates a secondary index without using an `EntityStore`.

Copyright (c) 2016, 2018 Oracle and/or its affiliates. All rights reserved.