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

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

- Packages that use DatabaseConfig
  Package | Description
  --- | ---
  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 DatabaseConfig in com.sleepycat.je

    Subclasses of DatabaseConfig in com.sleepycat.je
    Modifier and Type | Class and Description
    --- | ---
    `class` | `SecondaryConfig` The configuration properties of a `SecondaryDatabase` extend those of a primary `Database`.

    Fields in com.sleepycat.je declared as DatabaseConfig
    Modifier and Type | Field and Description
    --- | ---
    `static DatabaseConfig` | DatabaseConfig.`DEFAULT` An instance created using the default constructor is initialized with the system's default settings.

    Methods in com.sleepycat.je that return DatabaseConfig
    Modifier and Type | Method and Description
    --- | ---
    `DatabaseConfig` | DatabaseConfig.`clone()` Returns a copy of this configuration object.
    `DatabaseConfig` | DatabaseConfig.`cloneConfig()` Deprecated. As of JE 4.0.13, replaced by `clone()`.
    `DatabaseConfig` | Database.`getConfig()` Returns this Database object's configuration.
    `DatabaseConfig` | DatabaseConfig.`setAllowCreate(boolean allowCreate)` Configures the `Environment.openDatabase` method to create the database if it does not already exist.
    `DatabaseConfig` | DatabaseConfig.`setBtreeComparator(Class<? extends Comparator<byte[]>> btreeComparatorClass)` By default, a byte by byte lexicographic comparison is used for btree keys.
    `DatabaseConfig` | DatabaseConfig.`setBtreeComparator(Comparator<byte[]> btreeComparator)` By default, a byte by byte lexicographic comparison is used for btree keys.
    `DatabaseConfig` | DatabaseConfig.`setCacheMode(CacheMode cacheMode)` Sets the default `CacheMode` used for operations performed on this database.
    `DatabaseConfig` | DatabaseConfig.`setDeferredWrite(boolean deferredWrite)` Sets the deferred-write option.
    `DatabaseConfig` | DatabaseConfig.`setDuplicateComparator(Class<? extends Comparator<byte[]>> duplicateComparatorClass)` By default, a byte by byte lexicographic comparison is used for duplicate data items in a duplicate set.
    `DatabaseConfig` | DatabaseConfig.`setDuplicateComparator(Comparator<byte[]> duplicateComparator)` By default, a byte by byte lexicographic comparison is used for duplicate data items in a duplicate set.
    `DatabaseConfig` | DatabaseConfig.`setExclusiveCreate(boolean exclusiveCreate)` Configure the `Environment.openDatabase` method to fail if the database already exists.
    `DatabaseConfig` | DatabaseConfig.`setKeyPrefixing(boolean keyPrefixing)` Configure the database to support key prefixing.
    `DatabaseConfig` | DatabaseConfig.`setNodeMaxDupTreeEntries(int nodeMaxDupTreeEntries)` Deprecated. this property no longer has any effect; `setNodeMaxEntries(int)` should be used instead.
    `DatabaseConfig` | DatabaseConfig.`setNodeMaxEntries(int nodeMaxEntries)` Configures the `Environment.openDatabase` method to have a B+Tree fanout of nodeMaxEntries.
    `DatabaseConfig` | DatabaseConfig.`setOverrideBtreeComparator(boolean override)` Sets to true if the database exists and the btree comparator specified in this configuration object should override the current comparator.
    `DatabaseConfig` | DatabaseConfig.`setOverrideDuplicateComparator(boolean override)` Sets to true if the database exists and the duplicate comparator specified in this configuration object should override the current comparator.
    `DatabaseConfig` | DatabaseConfig.`setReadOnly(boolean readOnly)` Configures the database in read-only mode.
    `DatabaseConfig` | DatabaseConfig.`setReplicated(boolean replicated)` Configures a database to be replicated or non-replicated, in a replicated Environment.
    `DatabaseConfig` | DatabaseConfig.`setSortedDuplicates(boolean sortedDuplicates)` Configures the database to support records with duplicate keys.
    `DatabaseConfig` | DatabaseConfig.`setTemporary(boolean temporary)` Sets the temporary database option.
    `DatabaseConfig` | DatabaseConfig.`setTransactional(boolean transactional)` Encloses the database open within a transaction.
    `DatabaseConfig` | DatabaseConfig.`setUseExistingConfig(boolean useExistingConfig)` Setting useExistingConfig to true allows a program to open a database without knowing a prior what its configuration is.

    Methods in com.sleepycat.je with parameters of type DatabaseConfig
    Modifier and Type | Method and Description
    --- | ---
    `Database` | Environment.`openDatabase(Transaction txn, String databaseName, DatabaseConfig dbConfig)` Opens, and optionally creates, a `Database`.

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

    Methods in com.sleepycat.je.jca.ra with parameters of type DatabaseConfig
    Modifier and Type | Method and Description
    --- | ---
    `Database` | JEConnection.`openDatabase(String name, DatabaseConfig config)`

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

    Methods in com.sleepycat.persist that return DatabaseConfig
    Modifier and Type | Method and Description
    --- | ---
    `DatabaseConfig` | EntityStore.`getPrimaryConfig(Class entityClass)` Returns the default primary database Berkeley DB engine API configuration for an entity class.

    Methods in com.sleepycat.persist with parameters of type DatabaseConfig
    Modifier and Type | Method and Description
    --- | ---
    `void` | EntityStore.`setPrimaryConfig(Class entityClass, DatabaseConfig config)` Configures the primary database for an entity class using the Berkeley DB engine API.

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