EnvironmentConfig (${name} Classes)

java.lang.Object
- com.sleepycat.je.EnvironmentMutableConfig
- - com.sleepycat.je.EnvironmentConfig

All Implemented Interfaces:

java.lang.Cloneable
```
public class EnvironmentConfig
extends EnvironmentMutableConfig
```
Specifies the attributes of an environment.
To change the default settings for a database environment, an application creates a configuration object, customizes settings and uses it for environment construction. The set methods of this class validate the configuration values when the method is invoked. An IllegalArgumentException is thrown if the value is not valid for that attribute.

All commonly used environment attributes have convenience setter/getter methods defined in this class. For example, to change the default transaction timeout setting for an environment, the application should do the following:
```
     // customize an environment configuration
     EnvironmentConfig envConfig = new EnvironmentConfig();
 envConfig.setTxnTimeout(10000);  // will throw if timeout value is
 invalid
     // Open the environment.
     Environment myEnvironment = new Environment(home, envConfig);
 
```
Additional parameters are described by the parameter name String constants in this class. These additional parameters will not be needed by most applications. This category of properties can be specified for the EnvironmentConfig object through a Properties object read by EnvironmentConfig(Properties), or individually through EnvironmentConfig.setConfigParam().

For example, an application can change the default btree node size with:
```
     envConfig.setConfigParam("je.nodeMaxEntries", "256");
 
```
Environment configuration follows this order of precedence:
1. Configuration parameters specified in <environment home>/je.properties take first precedence.
2. Configuration parameters set in the EnvironmentConfig object used at Environment construction are next.
3. Any configuration parameters not set by the application are set to system defaults, described along with the parameter name String constants in this class.
An EnvironmentConfig can be used to specify both mutable and immutable environment properties. Immutable properties may be specified when the first Environment handle (instance) is opened for a given physical environment. When more handles are opened for the same environment, the following rules apply:
1. Immutable properties must equal the original values specified when constructing an Environment handle for an already open environment. When a mismatch occurs, an exception is thrown.
2. Mutable properties are ignored when constructing an Environment handle for an already open environment.
After an Environment has been constructed, its mutable properties may be changed using Environment.setMutableConfig(com.sleepycat.je.EnvironmentMutableConfig). See EnvironmentMutableConfig for a list of mutable properties; all other properties are immutable. Whether a property is mutable or immutable is also described along with the parameter name String constants in this class.

Getting the Current Environment Properties
To get the current "live" properties of an environment after constructing it or changing its properties, you must call Environment.getConfig() or Environment.getMutableConfig(). The original EnvironmentConfig or EnvironmentMutableConfig object used to set the properties is not kept up to date as properties are changed, and does not reflect property validation or properties that are computed.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ADLER32_CHUNK_SIZE` By default, JE passes an entire log record to the Adler32 class for checksumming.
`static java.lang.String`	`CHECKPOINTER_BYTES_INTERVAL` Ask the checkpointer to run every time we write this many bytes to the log.
`static java.lang.String`	`CHECKPOINTER_DEADLOCK_RETRY` The number of times to retry a checkpoint if it runs into a deadlock.
`static java.lang.String`	`CHECKPOINTER_HIGH_PRIORITY` If true, the checkpointer uses more resources in order to complete the checkpoint in a shorter time interval.
`static java.lang.String`	`CHECKPOINTER_WAKEUP_INTERVAL` The checkpointer wakeup interval in microseconds.
`static java.lang.String`	`CLEANER_BYTES_INTERVAL` The cleaner checks disk utilization every time we write this many bytes to the log.
`static java.lang.String`	`CLEANER_DEADLOCK_RETRY` The number of times to retry cleaning if a deadlock occurs.
`static java.lang.String`	`CLEANER_DETAIL_MAX_MEMORY_PERCENTAGE` Tracking of detailed cleaning information will use no more than this percentage of the cache.
`static java.lang.String`	`CLEANER_EXPUNGE` If true, the cleaner deletes log files after successful cleaning.
`static java.lang.String`	`CLEANER_FETCH_OBSOLETE_SIZE` If true, the cleaner will fetch records to determine their size to more accurately calculate log utilization.
`static java.lang.String`	`CLEANER_FORCE_CLEAN_FILES` Specifies a list of files or file ranges to be cleaned at a time when no other log cleaning is necessary.
`static java.lang.String`	`CLEANER_LOCK_TIMEOUT` The lock timeout for cleaner transactions in microseconds.
`static java.lang.String`	`CLEANER_LOOK_AHEAD_CACHE_SIZE` The look ahead cache size for cleaning in bytes.
`static java.lang.String`	`CLEANER_MAX_BATCH_FILES` The maximum number of log files in the cleaner's backlog, or zero if there is no limit.
`static java.lang.String`	`CLEANER_MIN_AGE` The minimum age of a file (number of files between it and the active file) to qualify it for cleaning under any conditions.
`static java.lang.String`	`CLEANER_MIN_FILE_UTILIZATION` A log file will be cleaned if its utilization percentage is below this value, irrespective of total utilization.
`static java.lang.String`	`CLEANER_MIN_UTILIZATION` The cleaner will keep the total disk space utilization percentage above this value.
`static java.lang.String`	`CLEANER_READ_SIZE` The read buffer size for cleaning.
`static java.lang.String`	`CLEANER_THREADS` The number of threads allocated by the cleaner for log file processing.
`static java.lang.String`	`CLEANER_UPGRADE_TO_LOG_VERSION` All log files having a log version prior to the specified version will be cleaned at a time when no other log cleaning is necessary.
`static java.lang.String`	`COMPRESSOR_DEADLOCK_RETRY` The number of times to retry a compression run if a deadlock occurs.
`static java.lang.String`	`COMPRESSOR_LOCK_TIMEOUT` The lock timeout for compressor transactions in microseconds.
`static java.lang.String`	`COMPRESSOR_PURGE_ROOT` If true, when the compressor encounters an empty tree, the root node of the tree is deleted.
`static java.lang.String`	`COMPRESSOR_WAKEUP_INTERVAL` The compressor thread wakeup interval in microseconds.
`static EnvironmentConfig`	`DEFAULT`
`static java.lang.String`	`ENV_BACKGROUND_READ_LIMIT` The maximum number of read operations performed by JE background activities (e.g., cleaning) before sleeping to ensure that application threads can perform I/O.
`static java.lang.String`	`ENV_BACKGROUND_SLEEP_INTERVAL` The number of microseconds that JE background activities will sleep when the `ENV_BACKGROUND_WRITE_LIMIT` or `ENV_BACKGROUND_WRITE_LIMIT` is reached.
`static java.lang.String`	`ENV_BACKGROUND_WRITE_LIMIT` The maximum number of write operations performed by JE background activities (e.g., checkpointing and eviction) before sleeping to ensure that application threads can perform I/O.
`static java.lang.String`	`ENV_CHECK_LEAKS` Debugging support: check leaked locks and txns at env close.
`static java.lang.String`	`ENV_DB_EVICTION` If true, enable eviction of metadata for closed databases.
`static java.lang.String`	`ENV_FAIR_LATCHES` If true, use latches instead of synchronized blocks to implement the lock table and log write mutexes.
`static java.lang.String`	`ENV_FORCED_YIELD` Debugging support: call Thread.yield() at strategic points.
`static java.lang.String`	`ENV_IS_LOCKING` If true, create the environment with record locking.
`static java.lang.String`	`ENV_IS_TRANSACTIONAL` If true, create an environment that is capable of performing transactions.
`static java.lang.String`	`ENV_LOCKOUT_TIMEOUT` The maximum time in milliseconds to wait for an API call to start executing when the API is locked.
`static java.lang.String`	`ENV_READ_ONLY` If true, open the environment read-only.
`static java.lang.String`	`ENV_RECOVERY_FORCE_CHECKPOINT` If true, a checkpoint is forced following recovery, even if the log ends with a checkpoint.
`static java.lang.String`	`ENV_RUN_CHECKPOINTER` If true, starts up the checkpointer thread.
`static java.lang.String`	`ENV_RUN_CLEANER` If true, starts up the cleaner thread.
`static java.lang.String`	`ENV_RUN_IN_COMPRESSOR` If true, starts up the INCompressor thread.
`static java.lang.String`	`EVICTOR_DEADLOCK_RETRY` The number of times to retry the evictor if it runs into a deadlock.
`static java.lang.String`	`EVICTOR_EVICT_BYTES` When eviction occurs, the evictor will push memory usage to this number of bytes below `MAX_MEMORY`.
`static java.lang.String`	`EVICTOR_FORCED_YIELD` Call Thread.yield() at each check for cache overflow.
`static java.lang.String`	`EVICTOR_LRU_ONLY` If true (the default), use an LRU-only policy to select nodes for eviction.
`static java.lang.String`	`EVICTOR_NODES_PER_SCAN` The number of nodes in one evictor scan.
`static java.lang.String`	`LOCK_N_LOCK_TABLES` Number of Lock Tables.
`static java.lang.String`	`LOCK_TIMEOUT` The `LockTimeout` property.
`static java.lang.String`	`LOG_BUFFER_SIZE` The maximum starting size of a JE log buffer.
`static java.lang.String`	`LOG_CHECKSUM_READ` If true, perform a checksum check when reading entries from log.
`static java.lang.String`	`LOG_CHUNKED_NIO` If non-0 (default is 0) break all IO into chunks of this size.
`static java.lang.String`	`LOG_DIRECT_NIO` If true (default is false) direct NIO buffers are used.
`static java.lang.String`	`LOG_FAULT_READ_SIZE` The buffer size for faulting in objects from disk, in bytes.
`static java.lang.String`	`LOG_FILE_CACHE_SIZE` The size of the file handle cache.
`static java.lang.String`	`LOG_FILE_MAX` The maximum size of each individual JE log file, in bytes.
`static java.lang.String`	`LOG_FSYNC_TIMEOUT` The timeout limit for group file sync, in microseconds.
`static java.lang.String`	`LOG_ITERATOR_MAX_SIZE` The maximum read buffer size for log iterators, which are used when scanning the log during activities like log cleaning and environment open, in bytes.
`static java.lang.String`	`LOG_ITERATOR_READ_SIZE` The read buffer size for log iterators, which are used when scanning the log during activities like log cleaning and environment open, in bytes.
`static java.lang.String`	`LOG_MEM_ONLY` If true, operates in an in-memory test mode without flushing the log to disk.
`static java.lang.String`	`LOG_NUM_BUFFERS` The number of JE log buffers.
`static java.lang.String`	`LOG_TOTAL_BUFFER_BYTES` The total memory taken by log buffers, in bytes.
`static java.lang.String`	`LOG_USE_NIO` If true (default is false) NIO is used for all file I/O.
`static java.lang.String`	`LOG_USE_ODSYNC` If true (default is false) O_DSYNC is used to open JE log files.
`static java.lang.String`	`LOG_VERIFY_CHECKSUMS` If true, perform a checksum verification just before and after writing to the log.
`static java.lang.String`	`MAX_MEMORY` The `CacheSize` property.
`static java.lang.String`	`MAX_MEMORY_PERCENT` The `CachePercent` property.
`static java.lang.String`	`NODE_DUP_TREE_MAX_ENTRIES` The maximum number of entries in an internal dup btree node.
`static java.lang.String`	`NODE_MAX_ENTRIES` The maximum number of entries in an internal btree node.
`static java.lang.String`	`SHARED_CACHE` The `SharedCache` property.
`static java.lang.String`	`TRACE_CONSOLE` Use ConsoleHandler in logging system.
`static java.lang.String`	`TRACE_DB` Use DbLogHandler in logging system.
`static java.lang.String`	`TRACE_FILE` Use FileHandler in logging system.
`static java.lang.String`	`TRACE_FILE_COUNT` Log file count for FileHandler.
`static java.lang.String`	`TRACE_FILE_LIMIT` Log file limit for FileHandler.
`static java.lang.String`	`TRACE_LEVEL` Trace messages equal and above this level will be logged.
`static java.lang.String`	`TRACE_LEVEL_CLEANER` Cleaner specific detailed trace messages will be issued at this level.
`static java.lang.String`	`TRACE_LEVEL_EVICTOR` Evictor specific trace messages will be issued at this level.
`static java.lang.String`	`TRACE_LEVEL_LOCK_MANAGER` Lock manager specific trace messages will be issued at this level.
`static java.lang.String`	`TRACE_LEVEL_RECOVERY` Recovery specific trace messages will be issued at this level.
`static java.lang.String`	`TREE_BIN_DELTA` If less than this percentage of entries are changed on a BIN, log a delta instead of a full version.
`static java.lang.String`	`TREE_MAX_DELTA` After this many deltas, log a full version.
`static java.lang.String`	`TREE_MIN_MEMORY` The minimum bytes allocated out of the memory cache to hold Btree data including internal nodes and record keys and data.
`static java.lang.String`	`TXN_DEADLOCK_STACK_TRACE` Set this parameter to true to add stacktrace information to deadlock (lock timeout) exception messages.
`static java.lang.String`	`TXN_DUMP_LOCKS` Dump the lock table when a lock timeout is encountered, for debugging assistance.
`static java.lang.String`	`TXN_SERIALIZABLE_ISOLATION` The `TxnSerializableIsolation` property.
`static java.lang.String`	`TXN_TIMEOUT` The `TxnTimeout` property.

Fields inherited from class com.sleepycat.je.EnvironmentMutableConfig
cacheSize, props, validateParams

Constructor Summary

Constructors
Constructor and Description
`EnvironmentConfig()` Creates an EnvironmentConfig initialized with the system default settings.
`EnvironmentConfig(java.util.Properties properties)` Creates an EnvironmentConfig which includes the properties specified in the properties parameter.

Method Summary

Methods
Modifier and Type	Method and Description
`(package private) EnvironmentConfig`	`cloneConfig()` Used by Environment to create a copy of the application supplied configuration.
`boolean`	`getAllowCreate()` Returns a flag that specifies if we may create this environment.
`(package private) boolean`	`getCheckpointUP()` For unit testing, to prevent writing utilization data during checkpoint.
`(package private) boolean`	`getCreateUP()` For unit testing, to prevent creating the utilization profile DB.
`boolean`	`getLocking()` Returns true if the database environment is configured for locking.
`long`	`getLockTimeout()` Returns the lock timeout setting, in microseconds.
`boolean`	`getReadOnly()` Returns true if the database environment is configured to be read only.
`boolean`	`getSharedCache()` Returns true if the shared cache is used by this environment.
`boolean`	`getTransactional()` Returns true if the database environment is configured for transactions.
`(package private) boolean`	`getTxnReadCommitted()` For unit testing, to set readCommitted as the default.
`boolean`	`getTxnSerializableIsolation()` Returns true if all transactions for this environment has been configured to have Serializable (Degree 3) isolation.
`long`	`getTxnTimeout()` Returns the transaction timeout, in microseconds.
`void`	`setAllowCreate(boolean allowCreate)` If true, creates the database environment if it doesn't already exist.
`(package private) void`	`setCheckpointUP(boolean checkpointUP)` For unit testing, to prevent writing utilization data during checkpoint.
`void`	`setConfigParam(java.lang.String paramName, java.lang.String value)` Validates the value prescribed for the configuration parameter; if it is valid, the value is set in the configuration.
`(package private) void`	`setCreateUP(boolean createUP)` For unit testing, to prevent creating the utilization profile DB.
`void`	`setLocking(boolean locking)` Configures the database environment for no locking.
`void`	`setLockTimeout(long timeout)` Configures the lock timeout, in microseconds.
`void`	`setReadOnly(boolean readOnly)` Configures the database environment to be read only, and any attempt to modify a database will fail.
`void`	`setSharedCache(boolean sharedCache)` If true, the shared cache is used by this environment.
`void`	`setTransactional(boolean transactional)` Configures the database environment for transactions.
`(package private) void`	`setTxnReadCommitted(boolean txnReadCommitted)` For unit testing, sets readCommitted as the default.
`void`	`setTxnSerializableIsolation(boolean txnSerializableIsolation)` Configures all transactions for this environment to have Serializable (Degree 3) isolation.
`void`	`setTxnTimeout(long timeout)` Configures the transaction timeout, in microseconds.
`java.lang.String`	`toString()` Display configuration values.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT

public static final EnvironmentConfig DEFAULT

MAX_MEMORY
```
public static final java.lang.String MAX_MEMORY
```
The CacheSize property.

Name Type Mutable Default Minimum Maximum

"je.maxMemory" Long Yes 0 -none- -none-

See Also:
EnvironmentMutableConfig.setCacheSize(long), Constant Field Values

MAX_MEMORY_PERCENT
```
public static final java.lang.String MAX_MEMORY_PERCENT
```
The CachePercent property.

Name Type Mutable Default Minimum Maximum

"je.maxMemoryPercent" Integer Yes 60 1 90

See Also:
EnvironmentMutableConfig.setCachePercent(int), Constant Field Values

SHARED_CACHE
```
public static final java.lang.String SHARED_CACHE
```
The SharedCache property.

Name Type Mutable Default

"je.sharedCache" Boolean No false

See Also:
Constant Field Values

ENV_RECOVERY_FORCE_CHECKPOINT
```
public static final java.lang.String ENV_RECOVERY_FORCE_CHECKPOINT
```
If true, a checkpoint is forced following recovery, even if the log ends with a checkpoint.

Name Type Mutable Default

"je.env.recoveryForceCheckpoint" Boolean No false

See Also:
Constant Field Values

ENV_RUN_IN_COMPRESSOR
```
public static final java.lang.String ENV_RUN_IN_COMPRESSOR
```
If true, starts up the INCompressor thread.

Name Type Mutable Default

"je.env.runINCompressor" Boolean Yes true

See Also:
Constant Field Values

ENV_RUN_CHECKPOINTER
```
public static final java.lang.String ENV_RUN_CHECKPOINTER
```
If true, starts up the checkpointer thread.

Name Type Mutable Default

"je.env.runCheckpointer" Boolean Yes true

See Also:
Constant Field Values

ENV_RUN_CLEANER
```
public static final java.lang.String ENV_RUN_CLEANER
```
If true, starts up the cleaner thread.

Name Type Mutable Default

"je.env.runCleaner" Boolean Yes true

See Also:
Constant Field Values

ENV_BACKGROUND_READ_LIMIT
```
public static final java.lang.String ENV_BACKGROUND_READ_LIMIT
```
The maximum number of read operations performed by JE background activities (e.g., cleaning) before sleeping to ensure that application threads can perform I/O. If zero (the default) then no limitation on I/O is enforced.

Name Type Mutable Default Minimum Maximum

"je.env.backgroundReadLimit" Integer Yes 0 0 -none-

See Also:
ENV_BACKGROUND_SLEEP_INTERVAL, Constant Field Values

ENV_BACKGROUND_WRITE_LIMIT
```
public static final java.lang.String ENV_BACKGROUND_WRITE_LIMIT
```
The maximum number of write operations performed by JE background activities (e.g., checkpointing and eviction) before sleeping to ensure that application threads can perform I/O. If zero (the default) then no limitation on I/O is enforced.

Name Type Mutable Default Minimum Maximum

"je.env.backgroundWriteLimit" Integer Yes 0 0 -none-

See Also:
ENV_BACKGROUND_SLEEP_INTERVAL, Constant Field Values

ENV_LOCKOUT_TIMEOUT
```
public static final java.lang.String ENV_LOCKOUT_TIMEOUT
```
The maximum time in milliseconds to wait for an API call to start executing when the API is locked. The default timeout is indefinite.

Name Type Mutable Default Minimum Maximum

"je.env.lockoutTimeout" Integer Yes 2147483647 0 -none

See Also:
Constant Field Values

ENV_BACKGROUND_SLEEP_INTERVAL
```
public static final java.lang.String ENV_BACKGROUND_SLEEP_INTERVAL
```
The number of microseconds that JE background activities will sleep when the ENV_BACKGROUND_WRITE_LIMIT or ENV_BACKGROUND_WRITE_LIMIT is reached. If ENV_BACKGROUND_WRITE_LIMIT and ENV_BACKGROUND_WRITE_LIMIT are zero, this setting is not used.

Name Type Mutable Default Minimum Maximum

"je.env.backgroundSleepInterval" Long Yes 1000 1000 9223372036854775807L

See Also:
Constant Field Values

ENV_CHECK_LEAKS
```
public static final java.lang.String ENV_CHECK_LEAKS
```
Debugging support: check leaked locks and txns at env close.

Name Type Mutable Default

"je.env.checkLeaks" Boolean No true

See Also:
Constant Field Values

ENV_FORCED_YIELD
```
public static final java.lang.String ENV_FORCED_YIELD
```
Debugging support: call Thread.yield() at strategic points.

Name Type Mutable Default

"je.env.forcedYield" Boolean No false

See Also:
Constant Field Values

ENV_IS_TRANSACTIONAL
```
public static final java.lang.String ENV_IS_TRANSACTIONAL
```
If true, create an environment that is capable of performing transactions. If true is not passed, transactions may not be used. For licensing purposes, the use of this method distinguishes the use of the Transactional product. Note that if transactions are not used, specifying true does not create additional overhead in the environment.

Name Type Mutable Default

"je.env.isTransactional" Boolean No false

See Also:
Constant Field Values

ENV_IS_LOCKING
```
public static final java.lang.String ENV_IS_LOCKING
```
If true, create the environment with record locking. This property should be set to false only in special circumstances when it is safe to run without record locking.

Name Type Mutable Default

"je.env.isLocking" Boolean No true

See Also:
Constant Field Values

ENV_READ_ONLY
```
public static final java.lang.String ENV_READ_ONLY
```
If true, open the environment read-only.

Name Type Mutable Default

"je.env.isReadOnly" Boolean No false

See Also:
Constant Field Values

ENV_FAIR_LATCHES
```
public static final java.lang.String ENV_FAIR_LATCHES
```
If true, use latches instead of synchronized blocks to implement the lock table and log write mutexes. Latches require that threads queue to obtain the mutex in question and therefore guarantee that there will be no mutex starvation, but do incur a performance penalty. Latches should not be necessary in most cases, so synchronized blocks are the default. An application that puts heavy load on JE with threads with different thread priorities might find it useful to use latches. In a Java 5 JVM, where java.util.concurrent.locks.ReentrantLock is used for the latch implementation, this parameter will determine whether they are 'fair' or not. This parameter is 'static' across all environments.

Name Type Mutable Default

"je.env.fairLatches" Boolean No false

See Also:
Constant Field Values

ENV_DB_EVICTION
```
public static final java.lang.String ENV_DB_EVICTION
```
If true, enable eviction of metadata for closed databases.

Name Type Mutable Default

"je.env.dbEviction" Boolean No true

See Also:
Constant Field Values

ADLER32_CHUNK_SIZE
```
public static final java.lang.String ADLER32_CHUNK_SIZE
```
By default, JE passes an entire log record to the Adler32 class for checksumming. This can cause problems with the GC in some cases if the records are large and there is concurrency. Setting this parameter will cause JE to pass chunks of the log record to the checksumming class so that the GC does not block. 0 means do not chunk.

Name Type Mutable Default Minimum Maximum

"je.adler32.chunkSize" Integer Yes 0 0 1048576 (1M)

See Also:
Constant Field Values

LOG_TOTAL_BUFFER_BYTES
```
public static final java.lang.String LOG_TOTAL_BUFFER_BYTES
```
The total memory taken by log buffers, in bytes. If 0, use 7% of je.maxMemory. If 0 and je.sharedCache=true, use 7% divided by N where N is the number of environments sharing the global cache.

Name Type Mutable Default Minimum Maximum

"je.log.totalBufferBytes" Long No 0 6144L -none-

See Also:
Constant Field Values

LOG_NUM_BUFFERS
```
public static final java.lang.String LOG_NUM_BUFFERS
```
The number of JE log buffers.

Name Type Mutable Default Minimum Maximum

"je.log.numBuffers" Integer No 3 2 -none-

See Also:
Constant Field Values

LOG_BUFFER_SIZE
```
public static final java.lang.String LOG_BUFFER_SIZE
```
The maximum starting size of a JE log buffer.

Name Type Mutable Default Minimum Maximum

"je.log.bufferSize" Integer No 1048576 (1M) 1024 (1K) -none-

See Also:
Constant Field Values

LOG_FAULT_READ_SIZE
```
public static final java.lang.String LOG_FAULT_READ_SIZE
```
The buffer size for faulting in objects from disk, in bytes.

Name Type Mutable Default Minimum Maximum

"je.log.faultReadSize" Integer No 2048 (2K) 32 -none-

See Also:
Constant Field Values

LOG_ITERATOR_READ_SIZE
```
public static final java.lang.String LOG_ITERATOR_READ_SIZE
```
The read buffer size for log iterators, which are used when scanning the log during activities like log cleaning and environment open, in bytes. This may grow as the system encounters larger log entries.

Name Type Mutable Default Minimum Maximum

"je.log.iteratorReadSize" Integer No 8192 (8K) 128 -none-

See Also:
Constant Field Values

LOG_ITERATOR_MAX_SIZE
```
public static final java.lang.String LOG_ITERATOR_MAX_SIZE
```
The maximum read buffer size for log iterators, which are used when scanning the log during activities like log cleaning and environment open, in bytes.

Name Type Mutable Default Minimum Maximum

"je.log.iteratorMaxSize" Integer No 16777216 (16M) 128 -none-

See Also:
Constant Field Values

LOG_FILE_MAX

public static final java.lang.String LOG_FILE_MAX

The maximum size of each individual JE log file, in bytes.

Name	Type	Mutable	Default	Minimum	Maximum	JVM
"je.log.fileMax"	Long	No	10000000 (10M)	1000000 (1M)	4294967296 (4G)	Conventional JVM
"je.log.fileMax"	Long	No	100000 (100K)	10000 (10K)	4294967296 (4G)	Dalvik JVM

See Also:: Constant Field Values

LOG_CHECKSUM_READ
```
public static final java.lang.String LOG_CHECKSUM_READ
```
If true, perform a checksum check when reading entries from log.

Name Type Mutable Default

"je.log.checksumRead" Boolean No true

See Also:
Constant Field Values

LOG_VERIFY_CHECKSUMS
```
public static final java.lang.String LOG_VERIFY_CHECKSUMS
```
If true, perform a checksum verification just before and after writing to the log. This is primarily used for debugging.

Name Type Mutable Default

"je.log.verifyChecksums" Boolean No false

See Also:
Constant Field Values

LOG_MEM_ONLY
```
public static final java.lang.String LOG_MEM_ONLY
```
If true, operates in an in-memory test mode without flushing the log to disk. An environment directory must be specified, but it need not exist and no files are written. The system operates until it runs out of memory, at which time an OutOfMemoryError is thrown. Because the entire log is kept in memory, this mode is normally useful only for testing.

Name Type Mutable Default

"je.log.memOnly" Boolean No false

See Also:
Constant Field Values

LOG_FILE_CACHE_SIZE
```
public static final java.lang.String LOG_FILE_CACHE_SIZE
```
The size of the file handle cache.

Name Type Mutable Default Minimum Maximum

"je.log.fileCacheSize" Integer No 100 3 -none-

See Also:
Constant Field Values

LOG_FSYNC_TIMEOUT
```
public static final java.lang.String LOG_FSYNC_TIMEOUT
```
The timeout limit for group file sync, in microseconds.

Name Type Mutable Default Minimum Maximum

"je.log.fsyncTimeout" Long No 500000 (0.5 sec) 10000< (0.01 sec)/td> -none-

See Also:
Constant Field Values

LOG_USE_ODSYNC
```
public static final java.lang.String LOG_USE_ODSYNC
```
If true (default is false) O_DSYNC is used to open JE log files.

Name Type Mutable Default

"je.log.useODSYNC" Boolean No false

See Also:
Constant Field Values

LOG_USE_NIO
```
public static final java.lang.String LOG_USE_NIO
```
If true (default is false) NIO is used for all file I/O.

Name Type Mutable Default

"je.log.useNIO" Boolean No false

See Also:
Constant Field Values

LOG_DIRECT_NIO
```
public static final java.lang.String LOG_DIRECT_NIO
```
If true (default is false) direct NIO buffers are used. This setting is only used if LOG_USE_NIO is true.

Name Type Mutable Default

"je.log.directNIO" Boolean No false

See Also:
Constant Field Values

LOG_CHUNKED_NIO
```
public static final java.lang.String LOG_CHUNKED_NIO
```
If non-0 (default is 0) break all IO into chunks of this size. This setting is only used if LOG_USE_NIO is true.

Name Type Mutable Default Minimum Maximum

"je.log.chunkedNIO" Long No 0 0 67108864 (64M)

See Also:
Constant Field Values

NODE_MAX_ENTRIES
```
public static final java.lang.String NODE_MAX_ENTRIES
```
The maximum number of entries in an internal btree node. This can be set per-database using the DatabaseConfig object.

Name Type Mutable Default Minimum Maximum

"je.nodeMaxEntries" Integer No 128 4 32767 (32K)

See Also:
Constant Field Values

NODE_DUP_TREE_MAX_ENTRIES
```
public static final java.lang.String NODE_DUP_TREE_MAX_ENTRIES
```
The maximum number of entries in an internal dup btree node. This can be set per-database using the DatabaseConfig object.

Name Type Mutable Default Minimum Maximum

"je.nodeDupTreeMaxEntries" Integer No 128 4 32767 (32K)

See Also:
Constant Field Values

TREE_MAX_DELTA
```
public static final java.lang.String TREE_MAX_DELTA
```
After this many deltas, log a full version.

Name Type Mutable Default Minimum Maximum

"je.tree.maxDelta" Integer No 10 0 100

See Also:
Constant Field Values

TREE_BIN_DELTA
```
public static final java.lang.String TREE_BIN_DELTA
```
If less than this percentage of entries are changed on a BIN, log a delta instead of a full version.

Name Type Mutable Default Minimum Maximum

"je.tree.binDelta" Integer No 25 0 75

See Also:
Constant Field Values

TREE_MIN_MEMORY
```
public static final java.lang.String TREE_MIN_MEMORY
```
The minimum bytes allocated out of the memory cache to hold Btree data including internal nodes and record keys and data. If the specified value is larger than the size initially available in the cache, it will be truncated to the amount available.
TREE_MIN_MEMORY is the minimum for a single environment. By default, 500 KB or the size initially available in the cache is used, whichever is smaller.

Name Type Mutable Default Minimum Maximum

"je.tree.minMemory" Long Yes 512000 (500K) 51200 (50K) -none-

See Also:
Constant Field Values

COMPRESSOR_WAKEUP_INTERVAL
```
public static final java.lang.String COMPRESSOR_WAKEUP_INTERVAL
```
The compressor thread wakeup interval in microseconds.

Name Type Mutable Default Minimum Maximum

"je.compressor.wakeupInterval" Long No 5000000 (5 sec) 1000000 (1 sec) 4294967296 (71.6 min)

See Also:
Constant Field Values

COMPRESSOR_DEADLOCK_RETRY
```
public static final java.lang.String COMPRESSOR_DEADLOCK_RETRY
```
The number of times to retry a compression run if a deadlock occurs.

Name Type Mutable Default Minimum Maximum

"je.compressor.deadlockRetry" Integer No 3 0 -none-

See Also:
Constant Field Values

COMPRESSOR_LOCK_TIMEOUT
```
public static final java.lang.String COMPRESSOR_LOCK_TIMEOUT
```
The lock timeout for compressor transactions in microseconds.

Name Type Mutable Default Minimum Maximum

"je.compressor.lockTimeout" Long No 500000 (0.5 sec) 0 4294967296 (71.6 min)

See Also:
Constant Field Values

COMPRESSOR_PURGE_ROOT
```
public static final java.lang.String COMPRESSOR_PURGE_ROOT
```
If true, when the compressor encounters an empty tree, the root node of the tree is deleted.

Name Type Mutable Default

"je.compressor.purgeRoot" Boolean No false

See Also:
Constant Field Values

EVICTOR_EVICT_BYTES
```
public static final java.lang.String EVICTOR_EVICT_BYTES
```
When eviction occurs, the evictor will push memory usage to this number of bytes below MAX_MEMORY. No more than 50% of je.maxMemory will be evicted per eviction cycle, regardless of this setting.

Name Type Mutable Default Minimum Maximum

"je.evictor.evictBytes" Long No 524288 (512K) 1024 (1K) -none-

See Also:
Constant Field Values

EVICTOR_NODES_PER_SCAN
```
public static final java.lang.String EVICTOR_NODES_PER_SCAN
```
The number of nodes in one evictor scan.

Name Type Mutable Default Minimum Maximum

"je.evictor.nodesPerScan" Integer No 10 1 1000

See Also:
Constant Field Values

EVICTOR_DEADLOCK_RETRY
```
public static final java.lang.String EVICTOR_DEADLOCK_RETRY
```
The number of times to retry the evictor if it runs into a deadlock.

Name Type Mutable Default Minimum Maximum

"je.evictor.deadlockRetry" Integer No 3 0 -none-

See Also:
Constant Field Values

EVICTOR_LRU_ONLY
```
public static final java.lang.String EVICTOR_LRU_ONLY
```
If true (the default), use an LRU-only policy to select nodes for eviction. If false, select by Btree level first, and then by LRU.

Name Type Mutable Default

"je.evictor.lruOnly" Boolean No true

See Also:
Constant Field Values

EVICTOR_FORCED_YIELD
```
public static final java.lang.String EVICTOR_FORCED_YIELD
```
Call Thread.yield() at each check for cache overflow. This improves GC performance on some systems.

Name Type Mutable Default

"je.evictor.forcedYield" Boolean No false

See Also:
Constant Field Values

CHECKPOINTER_BYTES_INTERVAL

public static final java.lang.String CHECKPOINTER_BYTES_INTERVAL

Ask the checkpointer to run every time we write this many bytes to the log. If set, supercedes CHECKPOINTER_WAKEUP_INTERVAL. To use time based checkpointing, set this to 0.

Name	Type	Mutable	Default	Minimum	Maximum	JVM
"je.checkpointer.bytesInterval"	Long	No	20000000 (20M)	0	-none-	Conventional JVM
"je.checkpointer.bytesInterval"	Long	No	200000 (200K)	0	-none-	Dalvik JVM

See Also:: Constant Field Values

CHECKPOINTER_WAKEUP_INTERVAL
```
public static final java.lang.String CHECKPOINTER_WAKEUP_INTERVAL
```
The checkpointer wakeup interval in microseconds. By default, this is inactive and we wakeup the checkpointer as a function of the number of bytes written to the log (CHECKPOINTER_BYTES_INTERVAL).

Name Type Mutable Default Minimum Maximum

"je.checkpointer.wakeupInterval" Long No 0 1000000 (1 sec) 4294967296 (71.6 min)

See Also:
Constant Field Values

CHECKPOINTER_DEADLOCK_RETRY
```
public static final java.lang.String CHECKPOINTER_DEADLOCK_RETRY
```
The number of times to retry a checkpoint if it runs into a deadlock.

Name Type Mutable Default Minimum Maximum

"je.checkpointer.deadlockRetry" Integer No 3 0 -none-

See Also:
Constant Field Values

CHECKPOINTER_HIGH_PRIORITY
```
public static final java.lang.String CHECKPOINTER_HIGH_PRIORITY
```
If true, the checkpointer uses more resources in order to complete the checkpoint in a shorter time interval. Btree latches are held and other threads are blocked for a longer period. Log cleaner record migration is performed by cleaner threads instead of during checkpoints. When set to true, application response time may be longer during a checkpoint, and more cleaner threads may be required to maintain the configured log utilization.

Name Type Mutable Default

"je.checkpointer.highPriority" Boolean Yes false

See Also:
Constant Field Values

CLEANER_MIN_UTILIZATION
```
public static final java.lang.String CLEANER_MIN_UTILIZATION
```
The cleaner will keep the total disk space utilization percentage above this value.

Name Type Mutable Default Minimum Maximum

"je.cleaner.minUtilization" Integer Yes 50 0 90

See Also:
Constant Field Values

CLEANER_MIN_FILE_UTILIZATION
```
public static final java.lang.String CLEANER_MIN_FILE_UTILIZATION
```
A log file will be cleaned if its utilization percentage is below this value, irrespective of total utilization.

Name Type Mutable Default Minimum Maximum

"je.cleaner.minFileUtilization" Integer Yes 5 0 50

See Also:
Constant Field Values

CLEANER_BYTES_INTERVAL
```
public static final java.lang.String CLEANER_BYTES_INTERVAL
```
The cleaner checks disk utilization every time we write this many bytes to the log. If zero (and by default) it is set to the LOG_FILE_MAX value divided by four.

Name Type Mutable Default Minimum Maximum

"je.cleaner.bytesInterval" Long Yes 0 0 -none-

See Also:
Constant Field Values

CLEANER_FETCH_OBSOLETE_SIZE
```
public static final java.lang.String CLEANER_FETCH_OBSOLETE_SIZE
```
If true, the cleaner will fetch records to determine their size to more accurately calculate log utilization. This setting is used during DB truncation/removal and during recovery, and will cause more I/O during those operations when set to true.

Name Type Mutable Default

"je.cleaner.fetchObsoleteSize" Boolean Yes false

See Also:
Constant Field Values

CLEANER_DEADLOCK_RETRY
```
public static final java.lang.String CLEANER_DEADLOCK_RETRY
```
The number of times to retry cleaning if a deadlock occurs.

Name Type Mutable Default Minimum Maximum

"je.cleaner.deadlockRetry" Integer Yes 3 0 -none-

See Also:
Constant Field Values

CLEANER_LOCK_TIMEOUT
```
public static final java.lang.String CLEANER_LOCK_TIMEOUT
```
The lock timeout for cleaner transactions in microseconds.

Name Type Mutable Default Minimum Maximum

"je.cleaner.lockTimeout" Long Yes 500000 (0.5 sec) 0 4294967296 (71.6 min)

See Also:
Constant Field Values

CLEANER_EXPUNGE
```
public static final java.lang.String CLEANER_EXPUNGE
```
If true, the cleaner deletes log files after successful cleaning. If false, the cleaner changes log file extensions to .DEL instead of deleting them. The latter is useful for diagnosing log cleaning problems.

Name Type Mutable Default

"je.cleaner.expunge" Boolean Yes true

See Also:
Constant Field Values

CLEANER_MIN_AGE
```
public static final java.lang.String CLEANER_MIN_AGE
```
The minimum age of a file (number of files between it and the active file) to qualify it for cleaning under any conditions.

Name Type Mutable Default Minimum Maximum

"je.cleaner.minAge" Integer Yes 2 1 1000

See Also:
Constant Field Values

CLEANER_MAX_BATCH_FILES
```
public static final java.lang.String CLEANER_MAX_BATCH_FILES
```
The maximum number of log files in the cleaner's backlog, or zero if there is no limit. Changing this property can impact the performance of some out-of-memory applications.

Name Type Mutable Default Minimum Maximum

"je.cleaner.maxBatchFiles" Integer Yes 0 0 100000

See Also:
Constant Field Values

CLEANER_READ_SIZE
```
public static final java.lang.String CLEANER_READ_SIZE
```
The read buffer size for cleaning. If zero (the default), then LOG_ITERATOR_READ_SIZE value is used.

Name Type Mutable Default Minimum Maximum

"je.cleaner.readSize" Integer Yes 0 128 -none-

See Also:
Constant Field Values

CLEANER_DETAIL_MAX_MEMORY_PERCENTAGE
```
public static final java.lang.String CLEANER_DETAIL_MAX_MEMORY_PERCENTAGE
```
Tracking of detailed cleaning information will use no more than this percentage of the cache. The default value is 2% of MAX_MEMORY. If 0 and SHARED_CACHE is true, use 2% divided by N where N is the number of environments sharing the global cache.

Name Type Mutable Default Minimum Maximum

"je.cleaner.detailMaxMemoryPercentage" Integer Yes 2 1 90

See Also:
Constant Field Values

CLEANER_FORCE_CLEAN_FILES
```
public static final java.lang.String CLEANER_FORCE_CLEAN_FILES
```
Specifies a list of files or file ranges to be cleaned at a time when no other log cleaning is necessary. This parameter is intended for use in forcing the cleaning of a large number of log files. File numbers are in hex and are comma separated or hyphen separated to specify ranges, e.g.: '9,a,b-d' will clean 5 files.

Name Type Mutable Default

"je.cleaner.forceCleanFiles" String No ""

See Also:
Constant Field Values

CLEANER_UPGRADE_TO_LOG_VERSION
```
public static final java.lang.String CLEANER_UPGRADE_TO_LOG_VERSION
```
All log files having a log version prior to the specified version will be cleaned at a time when no other log cleaning is necessary. Intended for use in upgrading old format log files forward to the current log format version, e.g., to take advantage of format improvements; note that log upgrading is optional. The default value zero (0) specifies that no upgrading will occur. The value negative one (-1) specifies upgrading to the current log version.

Name Type Mutable Default Minimum Maximum

"je.cleaner.upgradeToLogVersion" Integer No 0 -1 -none-

See Also:
Constant Field Values

CLEANER_THREADS
```
public static final java.lang.String CLEANER_THREADS
```
The number of threads allocated by the cleaner for log file processing. If the cleaner backlog becomes large, try increasing this value.

Name Type Mutable Default Minimum Maximum

"je.cleaner.threads" Integer Yes 1 1 -none-

See Also:
Constant Field Values

CLEANER_LOOK_AHEAD_CACHE_SIZE
```
public static final java.lang.String CLEANER_LOOK_AHEAD_CACHE_SIZE
```
The look ahead cache size for cleaning in bytes. Increasing this value can reduce the number of Btree lookups.

Name Type Mutable Default Minimum Maximum

"je.cleaner.lookAheadCacheSize" Integer Yes 8192 (8K) 0 -none-

See Also:
Constant Field Values

LOCK_N_LOCK_TABLES
```
public static final java.lang.String LOCK_N_LOCK_TABLES
```
Number of Lock Tables. Set this to a value other than 1 when an application has multiple threads performing concurrent JE operations. It should be set to a prime number, and in general not higher than the number of application threads performing JE operations.

Name Type Mutable Default Minimum Maximum

"je.lock.nLockTables" Integer No 1 1 32767 (32K)

See Also:
Constant Field Values

LOCK_TIMEOUT
```
public static final java.lang.String LOCK_TIMEOUT
```
The LockTimeout property.

Name Type Mutable Default Minimum Maximum

"je.lock.timeout" Long No 500000 (0.5 sec) 0 4294967296 (71.6 min)

See Also:
setLockTimeout(long), Constant Field Values

TXN_TIMEOUT
```
public static final java.lang.String TXN_TIMEOUT
```
The TxnTimeout property.

Name Type Mutable Default Minimum Maximum

"je.txn.timeout" Long No 0 0 4294967296 (71.6 min)

See Also:
setTxnTimeout(long), Constant Field Values

TXN_SERIALIZABLE_ISOLATION
```
public static final java.lang.String TXN_SERIALIZABLE_ISOLATION
```
The TxnSerializableIsolation property.

Name Type Mutable Default

"je.txn.serializableIsolation" Boolean No false

See Also:
setTxnSerializableIsolation(boolean), Constant Field Values

TXN_DEADLOCK_STACK_TRACE
```
public static final java.lang.String TXN_DEADLOCK_STACK_TRACE
```
Set this parameter to true to add stacktrace information to deadlock (lock timeout) exception messages. The stack trace will show where each lock was taken. The default is false, and true should only be used during debugging because of the added memory/processing cost. This parameter is 'static' across all environments.

Name Type Mutable Default

"je.txn.deadlockStackTrace" Boolean Yes false

See Also:
Constant Field Values

TXN_DUMP_LOCKS
```
public static final java.lang.String TXN_DUMP_LOCKS
```
Dump the lock table when a lock timeout is encountered, for debugging assistance.

Name Type Mutable Default

"je.txn.dumpLocks" Boolean Yes false

See Also:
Constant Field Values

TRACE_FILE
```
public static final java.lang.String TRACE_FILE
```
Use FileHandler in logging system.

Name Type Mutable Default

"java.util.logging.FileHandler.on" Boolean No false

See Also:
Constant Field Values

TRACE_CONSOLE
```
public static final java.lang.String TRACE_CONSOLE
```
Use ConsoleHandler in logging system.

Name Type Mutable Default

"java.util.logging.ConsoleHandler.on" Boolean No false

See Also:
Constant Field Values

TRACE_DB
```
public static final java.lang.String TRACE_DB
```
Use DbLogHandler in logging system.

Name Type Mutable Default

"java.util.logging.DbLogHandler.on" Boolean No true

See Also:
Constant Field Values

TRACE_FILE_LIMIT
```
public static final java.lang.String TRACE_FILE_LIMIT
```
Log file limit for FileHandler.

Name Type Mutable Default Minimum Maximum

"java.util.logging.FileHandler.limit" Integer No 10000000 (10M) 1000 1000000000 (1G)

See Also:
Constant Field Values

TRACE_FILE_COUNT
```
public static final java.lang.String TRACE_FILE_COUNT
```
Log file count for FileHandler.

Name Type Mutable Default Minimum Maximum

"java.util.logging.FileHandler.count" Integer No 10 1 -none-

See Also:
Constant Field Values

TRACE_LEVEL
```
public static final java.lang.String TRACE_LEVEL
```
Trace messages equal and above this level will be logged. Value should be one of the predefined java.util.logging.Level values.

Name Type Mutable Default

"java.util.logging.level" String No "INFO"

See Also:
Constant Field Values

TRACE_LEVEL_LOCK_MANAGER
```
public static final java.lang.String TRACE_LEVEL_LOCK_MANAGER
```
Lock manager specific trace messages will be issued at this level. Value should be one of the predefined java.util.logging.Level values.

Name Type Mutable Default

"java.util.logging.level.lockMgr" String No "FINE"

See Also:
Constant Field Values

TRACE_LEVEL_RECOVERY
```
public static final java.lang.String TRACE_LEVEL_RECOVERY
```
Recovery specific trace messages will be issued at this level. Value should be one of the predefined java.util.logging.Level values.

Name Type Mutable Default

"java.util.logging.level.recovery" String No "FINE"

See Also:
Constant Field Values

TRACE_LEVEL_EVICTOR
```
public static final java.lang.String TRACE_LEVEL_EVICTOR
```
Evictor specific trace messages will be issued at this level. Value should be one of the predefined java.util.logging.Level values.

Name Type Mutable Default

"java.util.logging.level.evictor" String No "FINE"

See Also:
Constant Field Values

TRACE_LEVEL_CLEANER
```
public static final java.lang.String TRACE_LEVEL_CLEANER
```
Cleaner specific detailed trace messages will be issued at this level. Value should be one of the predefined java.util.logging.Level values.

Name Type Mutable Default

"java.util.logging.level.cleaner" String Yes "FINE"

See Also:
Constant Field Values

Constructor Detail
- EnvironmentConfig
```
public EnvironmentConfig()
```
  Creates an EnvironmentConfig initialized with the system default settings.
- EnvironmentConfig
```
public EnvironmentConfig(java.util.Properties properties)
                  throws java.lang.IllegalArgumentException
```
  Creates an EnvironmentConfig which includes the properties specified in the properties parameter.
  
  Parameters:
  properties - Supported properties are described in the sample property file.
  
  Throws:
  
  java.lang.IllegalArgumentException - If any properties read from the properties param are invalid.

Method Detail
- setAllowCreate
```
public void setAllowCreate(boolean allowCreate)
```
  If true, creates the database environment if it doesn't already exist.
  
  Parameters:
  allowCreate - If true, the database environment is created if it doesn't already exist.
- getAllowCreate
```
public boolean getAllowCreate()
```
  Returns a flag that specifies if we may create this environment.
  
  Returns:
  true if we may create this environment.
- setLockTimeout
```
public void setLockTimeout(long timeout)
                    throws java.lang.IllegalArgumentException
```
  Configures the lock timeout, in microseconds.
  Equivalent to setting the je.lock.timeout parameter in the je.properties file.
  
  Parameters:
  timeout - The lock timeout, in microseconds. A value of 0 turns off lock timeouts.
  
  Throws:
  
  java.lang.IllegalArgumentException - If the value of timeout is negative
  See Also:
  Transaction.setLockTimeout(long)
- getLockTimeout
```
public long getLockTimeout()
```
  Returns the lock timeout setting, in microseconds. A value of 0 means no timeout is set.
- setReadOnly
```
public void setReadOnly(boolean readOnly)
```
  Configures the database environment to be read only, and any attempt to modify a database will fail.
  
  Parameters:
  readOnly - If true, configure the database environment to be read only, and any attempt to modify a database will fail.
- getReadOnly
```
public boolean getReadOnly()
```
  Returns true if the database environment is configured to be read only.
  This method may be called at any time during the life of the application.
  
  Returns:
  True if the database environment is configured to be read only.
- setTransactional
```
public void setTransactional(boolean transactional)
```
  Configures the database environment for transactions.
  This configuration option should be used when transactional guarantees such as atomicity of multiple operations and durability are important.
  
  Parameters:
  transactional - If true, configure the database environment for transactions.
- getTransactional
```
public boolean getTransactional()
```
  Returns true if the database environment is configured for transactions.
  This method may be called at any time during the life of the application.
  
  Returns:
  True if the database environment is configured for transactions.
- setLocking
```
public void setLocking(boolean locking)
```
  Configures the database environment for no locking.
  This configuration option should be used when locking guarantees such as consistency and isolation are not important. If locking mode is disabled (it is enabled by default), the cleaner is automatically disabled. The user is responsible for invoking the cleaner and ensuring that there are no concurrent operations while the cleaner is running.
  
  Parameters:
  locking - If false, configure the database environment for no locking. The default is true.
- getLocking
```
public boolean getLocking()
```
  Returns true if the database environment is configured for locking.
  This method may be called at any time during the life of the application.
  
  Returns:
  True if the database environment is configured for locking.
- setTxnTimeout
```
public void setTxnTimeout(long timeout)
                   throws java.lang.IllegalArgumentException
```
  Configures the transaction timeout, in microseconds.
  Equivalent to setting the je.txn.timeout parameter in the je.properties file.
  
  Parameters:
  timeout - The transaction timeout, in microseconds. A value of 0 turns off transaction timeouts.
  
  Throws:
  
  java.lang.IllegalArgumentException - If the value of timeout is negative
  See Also:
  Transaction.setTxnTimeout(long)
- getTxnTimeout
```
public long getTxnTimeout()
```
  Returns the transaction timeout, in microseconds.
  A value of 0 means transaction timeouts are not configured.
  
  Returns:
  The transaction timeout, in microseconds.
- setTxnSerializableIsolation
```
public void setTxnSerializableIsolation(boolean txnSerializableIsolation)
```
  Configures all transactions for this environment to have Serializable (Degree 3) isolation. By setting Serializable isolation, phantoms will be prevented. By default transactions provide Repeatable Read isolation. The default is false for the database environment.
  
  See Also:
  LockMode
- getTxnSerializableIsolation
```
public boolean getTxnSerializableIsolation()
```
  Returns true if all transactions for this environment has been configured to have Serializable (Degree 3) isolation.
  
  Returns:
  true if the environment has been configured to have repeatable read isolation.
  See Also:
  LockMode
- setTxnReadCommitted
```
void setTxnReadCommitted(boolean txnReadCommitted)
```
  For unit testing, sets readCommitted as the default.
- getTxnReadCommitted
```
boolean getTxnReadCommitted()
```
  For unit testing, to set readCommitted as the default.
- setSharedCache
```
public void setSharedCache(boolean sharedCache)
```
  If true, the shared cache is used by this environment.
  By default this parameter is false and this environment uses a private cache. If this parameter is set to true, this environment will use a cache that is shared with all other open environments in this process that also set this parameter to true. There is a single shared cache per process.
  
  By using the shared cache, multiple open environments will make better use of memory because the cache LRU algorithm is applied across all information in all environments sharing the cache. For example, if one environment is open but not recently used, then it will only use a small portion of the cache, leaving the rest of the cache for environments that have been recently used.
  
  Parameters:
  sharedCache - If true, the shared cache is used by this environment.
- getSharedCache
```
public boolean getSharedCache()
```
  Returns true if the shared cache is used by this environment.
  
  Returns:
  true if the shared cache is used by this environment. @see #setSharedCache
- setConfigParam
```
public void setConfigParam(java.lang.String paramName,
                  java.lang.String value)
                    throws java.lang.IllegalArgumentException
```
  Description copied from class: EnvironmentMutableConfig
  
  Validates the value prescribed for the configuration parameter; if it is valid, the value is set in the configuration.
  
  Overrides:
  
  setConfigParam in class EnvironmentMutableConfig
  
  Parameters:
  paramName - The name of the configuration parameter. See the sample je.properties file for descriptions of all parameters.
  value - The value for this configuration parameter.
  
  Throws:
  
  java.lang.IllegalArgumentException - if an invalid parameter was specified.
- setCreateUP
```
void setCreateUP(boolean createUP)
```
  For unit testing, to prevent creating the utilization profile DB.
- getCreateUP
```
boolean getCreateUP()
```
  For unit testing, to prevent creating the utilization profile DB.
- setCheckpointUP
```
void setCheckpointUP(boolean checkpointUP)
```
  For unit testing, to prevent writing utilization data during checkpoint.
- getCheckpointUP
```
boolean getCheckpointUP()
```
  For unit testing, to prevent writing utilization data during checkpoint.
- cloneConfig
```
EnvironmentConfig cloneConfig()
```
  Used by Environment to create a copy of the application supplied configuration.
- toString
```
public java.lang.String toString()
```
  Display configuration values.
  
  Overrides:
  
  toString in class EnvironmentMutableConfig

Class EnvironmentConfig

Getting the Current Environment Properties

Field Summary

Fields inherited from class com.sleepycat.je.EnvironmentMutableConfig

Constructor Summary

Method Summary

Methods inherited from class com.sleepycat.je.EnvironmentMutableConfig

Methods inherited from class java.lang.Object

Field Detail

DEFAULT

MAX_MEMORY

MAX_MEMORY_PERCENT

SHARED_CACHE

ENV_RECOVERY_FORCE_CHECKPOINT

ENV_RUN_IN_COMPRESSOR

ENV_RUN_CHECKPOINTER

ENV_RUN_CLEANER

ENV_BACKGROUND_READ_LIMIT

ENV_BACKGROUND_WRITE_LIMIT

ENV_LOCKOUT_TIMEOUT

ENV_BACKGROUND_SLEEP_INTERVAL

ENV_CHECK_LEAKS

ENV_FORCED_YIELD

ENV_IS_TRANSACTIONAL

ENV_IS_LOCKING

ENV_READ_ONLY

ENV_FAIR_LATCHES

ENV_DB_EVICTION

ADLER32_CHUNK_SIZE

LOG_TOTAL_BUFFER_BYTES

LOG_NUM_BUFFERS

LOG_BUFFER_SIZE

LOG_FAULT_READ_SIZE

LOG_ITERATOR_READ_SIZE

LOG_ITERATOR_MAX_SIZE

LOG_FILE_MAX

LOG_CHECKSUM_READ

LOG_VERIFY_CHECKSUMS

LOG_MEM_ONLY

LOG_FILE_CACHE_SIZE

LOG_FSYNC_TIMEOUT

LOG_USE_ODSYNC

LOG_USE_NIO

LOG_DIRECT_NIO

LOG_CHUNKED_NIO

NODE_MAX_ENTRIES

NODE_DUP_TREE_MAX_ENTRIES

TREE_MAX_DELTA

TREE_BIN_DELTA

TREE_MIN_MEMORY

COMPRESSOR_WAKEUP_INTERVAL

COMPRESSOR_DEADLOCK_RETRY

COMPRESSOR_LOCK_TIMEOUT

COMPRESSOR_PURGE_ROOT

EVICTOR_EVICT_BYTES

EVICTOR_NODES_PER_SCAN

EVICTOR_DEADLOCK_RETRY

EVICTOR_LRU_ONLY

EVICTOR_FORCED_YIELD

CHECKPOINTER_BYTES_INTERVAL

CHECKPOINTER_WAKEUP_INTERVAL

CHECKPOINTER_DEADLOCK_RETRY

CHECKPOINTER_HIGH_PRIORITY

CLEANER_MIN_UTILIZATION

CLEANER_MIN_FILE_UTILIZATION

CLEANER_BYTES_INTERVAL

CLEANER_FETCH_OBSOLETE_SIZE

CLEANER_DEADLOCK_RETRY

CLEANER_LOCK_TIMEOUT

CLEANER_EXPUNGE

CLEANER_MIN_AGE

CLEANER_MAX_BATCH_FILES

CLEANER_READ_SIZE

CLEANER_DETAIL_MAX_MEMORY_PERCENTAGE

CLEANER_FORCE_CLEAN_FILES

CLEANER_UPGRADE_TO_LOG_VERSION

CLEANER_THREADS

CLEANER_LOOK_AHEAD_CACHE_SIZE

LOCK_N_LOCK_TABLES

LOCK_TIMEOUT