Uses of Class com.sleepycat.je.SecondaryDatabase (Oracle - Berkeley DB Java Edition API)
Date: 2014-12-16

## Uses of Class
com.sleepycat.je.SecondaryDatabase

- Packages that use SecondaryDatabase
  Package | Description
  --- | ---
  com.sleepycat.bind.serial | Bindings that use Java serialization.
  com.sleepycat.bind.tuple | Bindings that use sequences of primitive fields, or tuples.
  com.sleepycat.je | Foundation for creating environments, databases and transactions; provides cursor based data access.
  com.sleepycat.je.jca.ra | Support for the Java Connector Architecture, which provides a standard for connecting the J2EE platform to legacy enterprise information systems (EIS), such as ERP systems, database systems, and legacy applications not written in Java.
  com.sleepycat.persist | The Direct Persistence Layer (DPL) adds a persistent object model to the Berkeley DB transactional engine.

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

    Methods in com.sleepycat.bind.serial with parameters of type SecondaryDatabase
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | SerialSerialKeyCreator.`createSecondaryKey(SecondaryDatabase db, DatabaseEntry primaryKeyEntry, DatabaseEntry dataEntry, DatabaseEntry indexKeyEntry)`
    `boolean` | TupleSerialKeyCreator.`createSecondaryKey(SecondaryDatabase db, DatabaseEntry primaryKeyEntry, DatabaseEntry dataEntry, DatabaseEntry indexKeyEntry)`
    `boolean` | SerialSerialKeyCreator.`nullifyForeignKey(SecondaryDatabase db, DatabaseEntry dataEntry)`
    `boolean` | TupleSerialKeyCreator.`nullifyForeignKey(SecondaryDatabase db, DatabaseEntry dataEntry)`

  - ### Uses of SecondaryDatabase in com.sleepycat.bind.tuple

    Methods in com.sleepycat.bind.tuple with parameters of type SecondaryDatabase
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | TupleTupleKeyCreator.`createSecondaryKey(SecondaryDatabase db, DatabaseEntry primaryKeyEntry, DatabaseEntry dataEntry, DatabaseEntry indexKeyEntry)`
    `boolean` | TupleTupleKeyCreator.`nullifyForeignKey(SecondaryDatabase db, DatabaseEntry dataEntry)`

  - ### Uses of SecondaryDatabase in com.sleepycat.je

    Methods in com.sleepycat.je that return SecondaryDatabase
    Modifier and Type | Method and Description
    --- | ---
    `SecondaryDatabase` | SecondaryCursor.`getDatabase()` Returns the Database handle associated with this Cursor.
    `SecondaryDatabase` | Environment.`openSecondaryDatabase(Transaction txn, String databaseName, Database primaryDatabase, SecondaryConfig dbConfig)` Opens and optionally creates a `SecondaryDatabase`.

    Methods in com.sleepycat.je that return types with arguments of type SecondaryDatabase
    Modifier and Type | Method and Description
    --- | ---
    `List<SecondaryDatabase>` | SecondaryDatabase.`getSecondaryDatabases()` Returns an empty list, since this database is itself a secondary database.
    `List<SecondaryDatabase>` | Database.`getSecondaryDatabases()` Returns a list of all `SecondaryDatabase` objects associated with a primary database.

    Methods in com.sleepycat.je with parameters of type SecondaryDatabase
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | SecondaryKeyCreator.`createSecondaryKey(SecondaryDatabase secondary, DatabaseEntry key, DatabaseEntry data, DatabaseEntry result)` Creates a secondary key entry, given a primary key and data entry.
    `void` | SecondaryMultiKeyCreator.`createSecondaryKeys(SecondaryDatabase secondary, DatabaseEntry key, DatabaseEntry data, Set<DatabaseEntry> results)` Creates a secondary key entry, given a primary key and data entry.
    `boolean` | ForeignKeyNullifier.`nullifyForeignKey(SecondaryDatabase secondary, DatabaseEntry data)` Sets the foreign key reference to null in the datum of the primary database.
    `boolean` | ForeignMultiKeyNullifier.`nullifyForeignKey(SecondaryDatabase secondary, DatabaseEntry key, DatabaseEntry data, DatabaseEntry secKey)` Sets the foreign key reference to null in the datum of the primary database.

  - ### Uses of SecondaryDatabase in com.sleepycat.je.jca.ra

    Methods in com.sleepycat.je.jca.ra that return SecondaryDatabase
    Modifier and Type | Method and Description
    --- | ---
    `SecondaryDatabase` | JEConnection.`openSecondaryDatabase(String name, Database primaryDatabase, SecondaryConfig config)`

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

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

    Constructors in com.sleepycat.persist with parameters of type SecondaryDatabase
    Constructor and Description
    `SecondaryIndex(SecondaryDatabase database, Database keysDatabase, PrimaryIndex<PK,E> primaryIndex, Class<SK> secondaryKeyClass, EntryBinding<SK> secondaryKeyBinding)` Creates a secondary index without using an `EntityStore`.

Copyright (c) 2004, 2014 Oracle and/or its affiliates. All rights reserved.