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

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

- Packages that use STransaction
  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 STransaction in com.sleepycat.client

    Methods in com.sleepycat.client that return STransaction
    Modifier and Type | Method and Description
    --- | ---
    `STransaction` | SEnvironment.`beginTransaction(STransaction parent, STransactionConfig config)` Create a new transaction in the database environment.

    Methods in com.sleepycat.client with parameters of type STransaction
    Modifier and Type | Method and Description
    --- | ---
    `STransaction` | SEnvironment.`beginTransaction(STransaction parent, STransactionConfig config)` Create a new transaction in the database environment.
    `V` | TxnHelper.TransactionOperations.`call(STransaction txn)`
    `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.
    `SOperationStatus` | SDatabase.`delete(STransaction txn, SDatabaseEntry key)` Remove key/data pairs from the database.
    `SOperationStatus` | SDatabase.`deleteMultiple(STransaction txn, SMultipleDataEntry keys)` Remove key/data pairs from the database.
    `SOperationStatus` | SDatabase.`deleteMultipleKey(STransaction txn, SMultiplePairs pairs)` Remove key/data pairs from the database.
    `SOperationStatus` | SDatabase.`exists(STransaction txn, SDatabaseEntry key)` Checks if the specified key appears in the database.
    `long` | SSequence.`get(STransaction txn, int delta)` Return the next available element in the sequence and changes the sequence value by delta.
    `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.
    `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` | 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` | 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.
    `SDatabaseStats` | SDatabase.`getStats(STransaction txn, SStatsConfig config)` Return database statistics.
    `SCursor` | SDatabase.`openCursor(STransaction txn, SCursorConfig config)` Return a cursor into the database.
    `SSecondaryCursor` | SSecondaryDatabase.`openCursor(STransaction txn, SCursorConfig config)` Return a `SSecondaryCursor` into this secondary database.
    `SDatabase` | SEnvironment.`openDatabase(STransaction txn, java.lang.String fileName, java.lang.String databaseName, SDatabaseConfig config)` Open a database.
    `SSecondaryDatabase` | SEnvironment.`openSecondaryDatabase(STransaction txn, java.lang.String fileName, java.lang.String databaseName, SDatabase primaryDatabase, SSecondaryConfig config)` Open a secondary database.
    `SSequence` | SDatabase.`openSequence(STransaction txn, SDatabaseEntry key, SSequenceConfig config)` Open a sequence represented by the key in the database.
    `SOperationStatus` | SDatabase.`put(STransaction txn, SDatabaseEntry key, SDatabaseEntry data)` Store the key/data pair into the database.
    `SOperationStatus` | SDatabase.`putMultipleKey(STransaction txn, SMultiplePairs pairs, boolean overwrite)` Store a set of key/data pairs 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` | 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.
    `void` | SEnvironment.`removeDatabase(STransaction txn, java.lang.String fileName, java.lang.String databaseName, boolean force)` Remove the database specified by the fileName and databaseName parameters.
    `void` | SDatabase.`removeSequence(STransaction txn, SDatabaseEntry key, boolean autoCommitNoSync, boolean force)` Remove the sequence from the database.
    `void` | SEnvironment.`renameDatabase(STransaction txn, java.lang.String fileName, java.lang.String databaseName, java.lang.String newName, boolean force)` Rename a database.
    `default <V> V` | TxnHelper.`runInSingleTxn(STransaction userTxn, java.util.function.Function<STransaction,V> operations)` Run multiple operations in the context of a single transaction.
    `default <V> V` | TxnHelper.`runInSingleTxnWithIOException(STransaction userTxn, TxnHelper.TransactionOperations<V> operations)` Run multiple operations in the context of a single transaction.
    `int` | SDatabase.`truncate(STransaction txn, boolean countRecords)` Empty the database, discarding all records it contains.

    Method parameters in com.sleepycat.client with type arguments of type STransaction
    Modifier and Type | Method and Description
    --- | ---
    `default <V> V` | TxnHelper.`runInSingleTxn(STransaction userTxn, java.util.function.Function<STransaction,V> operations)` Run multiple operations in the context of a single transaction.

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

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

    Methods in com.sleepycat.client.collections that return STransaction
    Modifier and Type | Method and Description
    --- | ---
    `STransaction` | CurrentTransaction.`abortTransaction()` Aborts the transaction that is active for the current thread for this environment and makes the parent transaction (if any) the current transaction.
    `STransaction` | CurrentTransaction.`beginTransaction(STransactionConfig config)` Begins a new transaction for this environment and associates it with the current thread.
    `STransaction` | CurrentTransaction.`commitTransaction()` Commits the transaction that is active for the current thread for this environment and makes the parent transaction (if any) the current transaction.
    `STransaction` | CurrentTransaction.`getTransaction()` Returns the transaction associated with the current thread for this environment, or null if no transaction is active.

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

    Methods in com.sleepycat.client.persist with parameters of type STransaction
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | EntityIndex.`contains(STransaction txn, K key, SLockMode lockMode)` Checks for existence of a key in this index.
    `boolean` | EntityIndex.`delete(STransaction txn, K key)` Deletes all entities with a given index key.
    `EntityCursor<V>` | EntityIndex.`entities(STransaction txn, K fromKey, boolean fromInclusive, K toKey, boolean toInclusive, SCursorConfig config)` Opens a cursor for traversing entities in a key range.
    `ForwardCursor<E>` | EntityJoin.`entities(STransaction txn, SCursorConfig config)` Opens a cursor that returns the entities qualifying for the join.
    `EntityCursor<V>` | EntityIndex.`entities(STransaction txn, SCursorConfig config)` Opens a cursor for traversing all entities in this index.
    `V` | EntityIndex.`get(STransaction txn, K key, SLockMode lockMode)` Gets an entity via a key of this index.
    `E` | PrimaryIndex.`get(STransaction txn, PK key, SLockMode lockMode)`
    `E` | SecondaryIndex.`get(STransaction txn, SK key, SLockMode lockMode)`
    `EntityCursor<K>` | EntityIndex.`keys(STransaction txn, K fromKey, boolean fromInclusive, K toKey, boolean toInclusive, SCursorConfig config)` Opens a cursor for traversing keys in a key range.
    `ForwardCursor<PK>` | EntityJoin.`keys(STransaction txn, SCursorConfig config)` Opens a cursor that returns the primary keys of entities qualifying for the join.
    `EntityCursor<K>` | EntityIndex.`keys(STransaction txn, SCursorConfig config)` Opens a cursor for traversing all keys in this index.
    `E` | PrimaryIndex.`put(STransaction txn, E entity)` Inserts an entity and returns null, or updates it if the primary key already exists and returns the existing entity.
    `boolean` | PrimaryIndex.`putNoOverwrite(STransaction txn, E entity)` Inserts an entity and returns true, or returns false if the primary key already exists.
    `void` | PrimaryIndex.`putNoReturn(STransaction txn, E entity)` Inserts an entity, or updates it if the primary key already exists (does not return the existing entity).
    `void` | EntityStore.`truncateClass(STransaction txn, java.lang.Class entityClass)` Deletes all instances of this entity class and its (non-entity) subclasses.

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