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

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

- Packages that use SDatabaseEntry
  Package | Description
  --- | ---
  com.sleepycat.client |
  com.sleepycat.client.bind | Bindings between database entries and Java objects.
  com.sleepycat.client.collections | Data access based on the standard Java collections API.

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

    Methods in com.sleepycat.client that return SDatabaseEntry
    Modifier and Type | Method and Description
    --- | ---
    `SDatabaseEntry` | SSequence.`getKey()` Return the SDatabaseEntry used to open this sequence.
    `SDatabaseEntry` | SDatabaseEntry.`setData(byte[] data)` Sets the data byte array.
    `SDatabaseEntry` | SDatabaseEntry.`setData(byte[] data, int offset, int size)` Sets the data byte array.
    `SDatabaseEntry` | SDatabaseEntry.`setExternalFile(boolean externalFile)` Configure this SDatabaseEntry to be stored as an external file.
    `SDatabaseEntry` | SDatabaseEntry.`setPartial(int doff, int dlen, boolean partial)` Configure this SDatabaseEntry to read or write partial records.
    `SDatabaseEntry` | SDatabaseEntry.`setRecordNumber(int recno, java.nio.ByteOrder byteOrder)` Initialize the entry from a logical record number.

    Methods in com.sleepycat.client with parameters of type SDatabaseEntry
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | SMultiplePairs.`append(SDatabaseEntry key, SDatabaseEntry data)`
    `default TKeyDataWithSecondaryKeys` | PutHelper.`calculateSKey(SDatabaseEntry key, SDatabaseEntry data)` Calculate the secondary keys generated for each secondary database for the specified primary key / data pair.
    `SCompactStats` | SDatabase.`compact(STransaction txn, SDatabaseEntry start, SDatabaseEntry stop, SDatabaseEntry end, SCompactConfig config)` Compact a Btree or Recno database or returns unused Btree, Hash or Recno database pages to the underlying filesystem.
    `default TKeyData` | GetHelper.`createGetSearchTerm(SDatabaseEntry key, SDatabaseEntryBase data)` This method helps to create the TKeyData argument used in a remote get call.
    `default TKeyDataWithPKey` | GetHelper.`createPGetSearchTerm(SDatabaseEntry sKey, SDatabaseEntry pKey, SDatabaseEntry pData)` This method helps to create the TKeyDataWithPKey argument used in a remote pGet call.
    `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.
    `SOperationStatus` | SDatabase.`delete(STransaction txn, SDatabaseEntry key)` Remove key/data pairs from the database.
    `SOperationStatus` | SDatabase.`exists(STransaction txn, SDatabaseEntry key)` Checks if the specified key appears in the database.
    `SOperationStatus` | SDatabase.`get(STransaction txn, SDatabaseEntry key, SDatabaseEntryBase data, SLockMode lockMode)` Retrieves the key/data pair with the given key from the database.
    `SOperationStatus` | SSecondaryDatabase.`get(STransaction txn, SDatabaseEntry sKey, SDatabaseEntry pKey, SDatabaseEntry pData, SLockMode lockMode)` Retrieves the secondary key / primary key / primary data tuple with the given secondary key.
    `SOperationStatus` | SCursor.`getCurrent(SDatabaseEntry key, SDatabaseEntryBase data, SLockMode lockMode)` Returns the key/data pair to which the cursor refers.
    `SOperationStatus` | SSecondaryCursor.`getCurrent(SDatabaseEntry sKey, SDatabaseEntry pKey, SDatabaseEntry pData, SLockMode lockMode)` Returns the key/data pair to which the cursor refers.
    `SOperationStatus` | SCursor.`getFirst(SDatabaseEntry key, SDatabaseEntryBase data, SLockMode lockMode)` Move the cursor to the first key/data pair of the database, and return that pair.
    `SOperationStatus` | SSecondaryCursor.`getFirst(SDatabaseEntry sKey, SDatabaseEntry pKey, SDatabaseEntry pData, SLockMode lockMode)` Move the cursor to the first key/data pair of the database, and return that pair.
    `SKeyRange` | SDatabase.`getKeyRange(STransaction txn, SDatabaseEntry key)` Return an estimate of the proportion of keys in the database less than, equal to, and greater than the specified key.
    `SOperationStatus` | SSecondaryCursor.`getLast(SDatabaseEntry sKey, SDatabaseEntry pKey, SDatabaseEntry pData, SLockMode lockMode)` Move the cursor to the last key/data pair of the database, and return that pair.
    `SOperationStatus` | SCursor.`getLast(SDatabaseEntry key, SDatabaseEntry data, SLockMode lockMode)` Move the cursor to the last key/data pair of the database, and return that pair.
    `SOperationStatus` | SCursor.`getNext(SDatabaseEntry key, SDatabaseEntryBase data, SLockMode lockMode)` Move the cursor to the next key/data pair and return that pair.
    `SOperationStatus` | SSecondaryCursor.`getNext(SDatabaseEntry sKey, SDatabaseEntry pKey, SDatabaseEntry pData, SLockMode lockMode)` Move the cursor to the next key/data pair and return that pair.
    `SOperationStatus` | SJoinCursor.`getNext(SDatabaseEntry key, SDatabaseEntry data, SLockMode lockMode)` Returns the next primary key and data resulting from the join operation.
    `SOperationStatus` | SJoinCursor.`getNext(SDatabaseEntry key, SLockMode lockMode)` Returns the next primary key resulting from the join operation.
    `SOperationStatus` | SCursor.`getNextDup(SDatabaseEntry key, SDatabaseEntryBase data, SLockMode lockMode)` If the next key/data pair of the database is a duplicate data record for the current key/data pair, move the cursor to the next key/data pair of the database and return that pair.
    `SOperationStatus` | SSecondaryCursor.`getNextDup(SDatabaseEntry sKey, SDatabaseEntry pKey, SDatabaseEntry pData, SLockMode lockMode)` If the next key/data pair of the database is a duplicate data record for the current key/data pair, move the cursor to the next key/data pair of the database and return that pair.
    `SOperationStatus` | SCursor.`getNextNoDup(SDatabaseEntry key, SDatabaseEntryBase data, SLockMode lockMode)` Move the cursor to the next non-duplicate key/data pair and return that pair.
    `SOperationStatus` | SSecondaryCursor.`getNextNoDup(SDatabaseEntry sKey, SDatabaseEntry pKey, SDatabaseEntry pData, SLockMode lockMode)` Move the cursor to the next non-duplicate key/data pair and return that pair.
    `SOperationStatus` | SSecondaryCursor.`getPrev(SDatabaseEntry sKey, SDatabaseEntry pKey, SDatabaseEntry pData, SLockMode lockMode)` Move the cursor to the previous key/data pair and return that pair.
    `SOperationStatus` | SCursor.`getPrev(SDatabaseEntry key, SDatabaseEntry data, SLockMode lockMode)` Move the cursor to the previous key/data pair and return that pair.
    `SOperationStatus` | SSecondaryCursor.`getPrevDup(SDatabaseEntry sKey, SDatabaseEntry pKey, SDatabaseEntry pData, SLockMode lockMode)` If the previous key/data pair of the database is a duplicate data record for the current key/data pair, move the cursor to the previous key/data pair of the database and return that pair.
    `SOperationStatus` | SCursor.`getPrevDup(SDatabaseEntry key, SDatabaseEntry data, SLockMode lockMode)` If the previous key/data pair of the database is a duplicate data record for the current key/data pair, move the cursor to the previous key/data pair of the database and return that pair.
    `SOperationStatus` | SSecondaryCursor.`getPrevNoDup(SDatabaseEntry sKey, SDatabaseEntry pKey, SDatabaseEntry pData, SLockMode lockMode)` Move the cursor to the previous non-duplicate key/data pair and return that pair.
    `SOperationStatus` | SCursor.`getPrevNoDup(SDatabaseEntry key, SDatabaseEntry data, SLockMode lockMode)` Move the cursor to the previous non-duplicate key/data pair and return that pair.
    `SOperationStatus` | SSecondaryCursor.`getRecordNumber(SDatabaseEntry secondaryRecno, SDatabaseEntry primaryRecno, SLockMode lockMode)` Return the record number associated with the cursor.
    `SOperationStatus` | SCursor.`getRecordNumber(SDatabaseEntry data, SLockMode lockMode)` Return the record number associated with the cursor.
    `SOperationStatus` | SCursor.`getSearchBoth(SDatabaseEntry key, SDatabaseEntryBase data, SLockMode lockMode)` Move the cursor to the specified key/data pair, where both the key and data items must match.
    `SOperationStatus` | SSecondaryCursor.`getSearchBoth(SDatabaseEntry sKey, SDatabaseEntry pKey, SDatabaseEntry pData, SLockMode lockMode)` Move the cursor to the specified secondary and primary key, where both the primary and secondary key items must match.
    `SOperationStatus` | SDatabase.`getSearchBoth(STransaction txn, SDatabaseEntry key, SDatabaseEntryBase data, SLockMode lockMode)` Retrieves the key/data pair with the given key and data value, that is, both the key and data items must match.
    `SOperationStatus` | SSecondaryDatabase.`getSearchBoth(STransaction txn, SDatabaseEntry sKey, SDatabaseEntry pKey, SDatabaseEntry pData, SLockMode lockMode)` Retrieves the key/data pair with the specified secondary and primary key, that is, both the primary and secondary key items must match.
    `SOperationStatus` | SCursor.`getSearchBothRange(SDatabaseEntry key, SDatabaseEntryBase data, SLockMode lockMode)` Move the cursor to the specified key and matching data item of the database.
    `SOperationStatus` | SSecondaryCursor.`getSearchBothRange(SDatabaseEntry sKey, SDatabaseEntry pKey, SDatabaseEntry pData, SLockMode lockMode)` Move the cursor to the specified secondary key and closest matching primary key of the database.
    `SOperationStatus` | SCursor.`getSearchKey(SDatabaseEntry key, SDatabaseEntryBase data, SLockMode lockMode)` Move the cursor to the given key of the database, and return the datum associated with the given key.
    `SOperationStatus` | SSecondaryCursor.`getSearchKey(SDatabaseEntry sKey, SDatabaseEntry pKey, SDatabaseEntry pData, SLockMode lockMode)` Move the cursor to the given key of the database, and return the datum associated with the given key.
    `SOperationStatus` | SCursor.`getSearchKeyRange(SDatabaseEntry key, SDatabaseEntryBase data, SLockMode lockMode)` Move the cursor to the closest matching key of the database, and return the data item associated with the matching key.
    `SOperationStatus` | SSecondaryCursor.`getSearchKeyRange(SDatabaseEntry sKey, SDatabaseEntry pKey, SDatabaseEntry pData, SLockMode lockMode)` Move the cursor to the closest matching key of the database, and return the data item associated with the matching key.
    `SOperationStatus` | SCursor.`getSearchRecordNumber(SDatabaseEntry key, SDatabaseEntryBase data, SLockMode lockMode)` Move the cursor to the specific numbered record of the database, and return the associated key/data pair.
    `SOperationStatus` | SSecondaryCursor.`getSearchRecordNumber(SDatabaseEntry secondaryRecno, SDatabaseEntry pKey, SDatabaseEntry pData, SLockMode lockMode)` Move the cursor to the specific numbered record of the database, and return the associated key/data pair.
    `SOperationStatus` | SDatabase.`getSearchRecordNumber(STransaction txn, SDatabaseEntry key, SDatabaseEntryBase data, SLockMode lockMode)` Retrieves the key/data pair associated with the specific numbered record of the database.
    `SOperationStatus` | SSecondaryDatabase.`getSearchRecordNumber(STransaction txn, SDatabaseEntry sKey, SDatabaseEntry pKey, SDatabaseEntry pData, SLockMode lockMode)` Retrieves the key/data pair associated with the specific numbered record of the database.
    `boolean` | SMultipleDataEntry.`next(SDatabaseEntry data)` Get the next data element in the returned set.
    `boolean` | SMultiplePairs.`next(SDatabaseEntry key, SDatabaseEntry data)` Get the next key/data pair in the returned set.
    `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.
    `SSequence` | SDatabase.`openSequence(STransaction txn, SDatabaseEntry key, SSequenceConfig config)` Open a sequence represented by the key in the database.
    `SOperationStatus` | SCursor.`put(SDatabaseEntry key, SDatabaseEntry data)` Store a key/data pair into the database.
    `SOperationStatus` | SDatabase.`put(STransaction txn, SDatabaseEntry key, SDatabaseEntry data)` Store the key/data pair into the database.
    `SOperationStatus` | SCursor.`putAfter(SDatabaseEntry key, SDatabaseEntry data)` Store a key/data pair into the database.
    `SOperationStatus` | SCursor.`putBefore(SDatabaseEntry key, SDatabaseEntry data)` Store a key/data pair into the database.
    `SOperationStatus` | SCursor.`putCurrent(SDatabaseEntry data)` Replaces the data in the key/data pair at the current cursor position.
    `SOperationStatus` | SCursor.`putKeyFirst(SDatabaseEntry key, SDatabaseEntry data)` Store a key/data pair into the database.
    `SOperationStatus` | SCursor.`putKeyLast(SDatabaseEntry key, SDatabaseEntry data)` Store a key/data pair into the database.
    `SOperationStatus` | SCursor.`putNoDupData(SDatabaseEntry key, SDatabaseEntry data)` Store a key/data pair into the database.
    `SOperationStatus` | SDatabase.`putNoDupData(STransaction txn, SDatabaseEntry key, SDatabaseEntry data)` Store the key/data pair into the database if it does not already appear in the database.
    `SOperationStatus` | SCursor.`putNoOverwrite(SDatabaseEntry key, SDatabaseEntry data)` Store a key/data pair into the database.
    `SOperationStatus` | SDatabase.`putNoOverwrite(STransaction txn, SDatabaseEntry key, SDatabaseEntry data)` Store the key/data pair into the database if the key does not already appear in the database.
    `default SOperationStatus` | GetHelper.`remoteGet(SDatabaseEntry key, SDatabaseEntryBase data, GetHelper.RemoteGetFunction getFunc)`
    `default SOperationStatus` | GetHelper.`remotePGet(SDatabaseEntry sKey, SDatabaseEntry pKey, SDatabaseEntry pData, GetHelper.RemotePGetFunction pGetFunc)`
    `default SOperationStatus` | PutHelper.`remotePut(java.util.List<TKeyDataWithSecondaryKeys> pairs, SDatabaseEntry retKey, PutHelper.RemotePutFunction func)`
    `void` | SDatabase.`removeSequence(STransaction txn, SDatabaseEntry key, boolean autoCommitNoSync, boolean force)` Remove the sequence from the database.
    `default void` | GetHelper.`updateKeyData(SDatabaseEntry key, SDatabaseEntryBase data, java.util.List<TKeyData> pairs)` This method helps to update the output arguments of a get call, using values returned from a remote get call.
    `default void` | GetHelper.`updateTuple(SDatabaseEntry sKey, SDatabaseEntry pKey, SDatabaseEntry pData, TKeyDataWithPKey tuple)` This method helps to update the output arguments of a pGet call, using values returned from a remote pGet call.

    Method parameters in com.sleepycat.client with type arguments of type SDatabaseEntry
    Modifier and Type | Method and Description
    --- | ---
    `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.

  - ### Uses of SDatabaseEntry in com.sleepycat.client.bind

    Methods in com.sleepycat.client.bind with parameters of type SDatabaseEntry
    Modifier and Type | Method and Description
    --- | ---
    `byte[]` | ByteArrayBinding.`entryToObject(SDatabaseEntry entry)`
    `E` | EntryBinding.`entryToObject(SDatabaseEntry entry)` Converts a entry buffer into an Object.
    `java.lang.Long` | RecordNumberBinding.`entryToObject(SDatabaseEntry entry)`
    `E` | EntityBinding.`entryToObject(SDatabaseEntry key, SDatabaseEntry data)` Converts key and data entry buffers into an entity Object.
    `static long` | RecordNumberBinding.`entryToRecordNumber(SDatabaseEntry entry, java.nio.ByteOrder byteOrder)` Utility method for use by bindings to translate a entry buffer to an record number integer.
    `void` | EntityBinding.`objectToData(E object, SDatabaseEntry data)` Extracts the data entry from an entity Object.
    `void` | ByteArrayBinding.`objectToEntry(byte[] object, SDatabaseEntry entry)`
    `void` | EntryBinding.`objectToEntry(E object, SDatabaseEntry entry)` Converts an Object into a entry buffer.
    `void` | RecordNumberBinding.`objectToEntry(java.lang.Object object, SDatabaseEntry entry)`
    `void` | EntityBinding.`objectToKey(E object, SDatabaseEntry key)` Extracts the key entry from an entity Object.
    `static void` | RecordNumberBinding.`recordNumberToEntry(long recordNumber, SDatabaseEntry entry, java.nio.ByteOrder byteOrder)` Utility method for use by bindings to translate a record number integer to a entry buffer.

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

    Methods in com.sleepycat.client.collections with parameters of type SDatabaseEntry
    Modifier and Type | Method and Description
    --- | ---
    `void` | PrimaryKeyAssigner.`assignKey(SDatabaseEntry keyData)` Assigns a new primary key value into the given buffer.

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