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

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

- Packages that use SSecondaryDatabase
  Package | Description
  --- | ---
  com.sleepycat.client |
  com.sleepycat.client.persist | The Direct Persistence Layer (DPL) adds a persistent object model to the Berkeley DB transactional engine.

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

    Methods in com.sleepycat.client that return SSecondaryDatabase
    Modifier and Type | Method and Description
    --- | ---
    `SSecondaryDatabase` | SSecondaryCursor.`getDatabase()` Return the `SSecondaryDatabase` handle associated with this cursor.
    `SSecondaryDatabase` | SEnvironment.`openSecondaryDatabase(STransaction txn, java.lang.String fileName, java.lang.String databaseName, SDatabase primaryDatabase, SSecondaryConfig config)` Open a secondary database.

    Methods in com.sleepycat.client that return types with arguments of type SSecondaryDatabase
    Modifier and Type | Method and Description
    --- | ---
    `java.util.Set<SSecondaryDatabase>` | SCursor.`getSecondaryDatabases()`
    `java.util.Set<SSecondaryDatabase>` | PutHelper.`getSecondaryDatabases()` Return the set of secondary databases associated with this primary database.
    `java.util.Set<SSecondaryDatabase>` | SDatabase.`getSecondaryDatabases()`

    Methods in com.sleepycat.client with parameters of type SSecondaryDatabase
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | SSecondaryKeyCreator.`createSecondaryKey(SSecondaryDatabase secondary, SDatabaseEntry key, SDatabaseEntry data, SDatabaseEntry result)` Creates a secondary key entry, given a primary key and data entry.
    `void` | SSecondaryMultiKeyCreator.`createSecondaryKeys(SSecondaryDatabase secondary, SDatabaseEntry key, SDatabaseEntry data, java.util.Set<SDatabaseEntry> results)` Create multiple secondary key entries, given a primary key and data entry.
    `boolean` | SForeignKeyNullifier.`nullifyForeignKey(SSecondaryDatabase secondary, SDatabaseEntry data)` Sets the foreign key reference to null in the datum of the primary database.
    `default boolean` | SForeignKeyNullifier.`nullifyForeignKey(SSecondaryDatabase secondary, SDatabaseEntry key, SDatabaseEntry data, SDatabaseEntry secKey)`
    `boolean` | SForeignMultiKeyNullifier.`nullifyForeignKey(SSecondaryDatabase secondary, SDatabaseEntry key, SDatabaseEntry data, SDatabaseEntry secKey)` Sets the foreign key reference to null in the datum of the primary database.

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

    Methods in com.sleepycat.client.persist that return SSecondaryDatabase
    Modifier and Type | Method and Description
    --- | ---
    `SSecondaryDatabase` | SecondaryIndex.`getDatabase()` Returns the underlying secondary database for this index.

    Constructors in com.sleepycat.client.persist with parameters of type SSecondaryDatabase
    Constructor and Description
    `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.