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

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

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

    Fields in com.sleepycat.client declared as SCursorConfig
    Modifier and Type | Field and Description
    --- | ---
    `static SCursorConfig` | SCursorConfig.`DEFAULT` Default configuration used if null is passed to methods that create a cursor.
    `static SCursorConfig` | SCursorConfig.`READ_COMMITTED` A convenience instance to configure a cursor for read committed isolation.
    `static SCursorConfig` | SCursorConfig.`READ_UNCOMMITTED` A convenience instance to configure read operations performed by the cursor to return modified but not yet committed data.
    `static SCursorConfig` | SCursorConfig.`SNAPSHOT` A convenience instance to configure read operations performed by the cursor to return values as they were when the cursor was opened, if `SDatabaseConfig.setMultiversion(boolean)` is configured.

    Methods in com.sleepycat.client that return SCursorConfig
    Modifier and Type | Method and Description
    --- | ---
    `SCursorConfig` | SCursor.`getConfig()` Return this cursor's configuration.
    `SCursorConfig` | SCursorConfig.`setBulkCursor(boolean bulkCursor)` Specify that the cursor will be used to do bulk operations on the underlying database.
    `SCursorConfig` | SCursorConfig.`setReadCommitted(boolean readCommitted)` Configure the cursor for read committed isolation.
    `SCursorConfig` | SCursorConfig.`setReadUncommitted(boolean readUncommitted)` Configure read operations performed by the cursor to return modified but not yet committed data.
    `SCursorConfig` | SCursorConfig.`setSnapshot(boolean snapshot)` Configure read operations performed by the cursor to return data as it was when the cursor opened without locking, if `SDatabaseConfig.setMultiversion(boolean)` was configured.

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

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

    Methods in com.sleepycat.client.collections that return SCursorConfig
    Modifier and Type | Method and Description
    --- | ---
    `SCursorConfig` | StoredContainer.`getCursorConfig()` Returns the cursor configuration that is used for all operations performed via this container.

    Methods in com.sleepycat.client.collections with parameters of type SCursorConfig
    Modifier and Type | Method and Description
    --- | ---
    `static <E> java.util.Collection<E>` | StoredCollections.`configuredCollection(java.util.Collection<E> storedCollection, SCursorConfig config)` Creates a configured collection from a given stored collection.
    `static <E> java.util.List<E>` | StoredCollections.`configuredList(java.util.List<E> storedList, SCursorConfig config)` Creates a configured list from a given stored list.
    `static <K,V> java.util.Map<K,V>` | StoredCollections.`configuredMap(java.util.Map<K,V> storedMap, SCursorConfig config)` Creates a configured map from a given stored map.
    `static <E> java.util.Set<E>` | StoredCollections.`configuredSet(java.util.Set<E> storedSet, SCursorConfig config)` Creates a configured set from a given stored set.
    `static <K,V> java.util.SortedMap<K,V>` | StoredCollections.`configuredSortedMap(java.util.SortedMap<K,V> storedSortedMap, SCursorConfig config)` Creates a configured sorted map from a given stored sorted map.
    `static <E> java.util.SortedSet<E>` | StoredCollections.`configuredSortedSet(java.util.SortedSet<E> storedSortedSet, SCursorConfig config)` Creates a configured sorted set from a given stored sorted set.

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

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

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