|
Berkeley DB Java Edition version 3.3.62 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.sleepycat.je.EnvironmentMutableConfig com.sleepycat.je.EnvironmentConfig
public class EnvironmentConfig
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:
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:
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.
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 | |
---|---|
static String |
ADLER32_CHUNK_SIZE
By default, JE passes an entire log record to the Adler32 class for checksumming. |
static String |
CHECKPOINTER_BYTES_INTERVAL
Ask the checkpointer to run every time we write this many bytes to the log. |
static String |
CHECKPOINTER_DEADLOCK_RETRY
The number of times to retry a checkpoint if it runs into a deadlock. |
static String |
CHECKPOINTER_HIGH_PRIORITY
If true, the checkpointer uses more resources in order to complete the checkpoint in a shorter time interval. |
static String |
CHECKPOINTER_WAKEUP_INTERVAL
The checkpointer wakeup interval in microseconds. |
static String |
CLEANER_BYTES_INTERVAL
The cleaner checks disk utilization every time we write this many bytes to the log. |
static String |
CLEANER_DEADLOCK_RETRY
The number of times to retry cleaning if a deadlock occurs. |
static String |
CLEANER_DETAIL_MAX_MEMORY_PERCENTAGE
Tracking of detailed cleaning information will use no more than this percentage of the cache. |
static String |
CLEANER_EXPUNGE
If true, the cleaner deletes log files after successful cleaning. |
static String |
CLEANER_FETCH_OBSOLETE_SIZE
If true, the cleaner will fetch records to determine their size to more accurately calculate log utilization. |
static 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 String |
CLEANER_LOCK_TIMEOUT
The lock timeout for cleaner transactions in microseconds. |
static String |
CLEANER_LOOK_AHEAD_CACHE_SIZE
The look ahead cache size for cleaning in bytes. |
static String |
CLEANER_MAX_BATCH_FILES
The maximum number of log files in the cleaner's backlog, or zero if there is no limit. |
static 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 String |
CLEANER_MIN_FILE_UTILIZATION
A log file will be cleaned if its utilization percentage is below this value, irrespective of total utilization. |
static String |
CLEANER_MIN_UTILIZATION
The cleaner will keep the total disk space utilization percentage above this value. |
static String |
CLEANER_READ_SIZE
The read buffer size for cleaning. |
static String |
CLEANER_THREADS
The number of threads allocated by the cleaner for log file processing. |
static 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 String |
COMPRESSOR_DEADLOCK_RETRY
The number of times to retry a compression run if a deadlock occurs. |
static String |
COMPRESSOR_LOCK_TIMEOUT
The lock timeout for compressor transactions in microseconds. |
static String |
COMPRESSOR_PURGE_ROOT
If true, when the compressor encounters an empty tree, the root node of the tree is deleted. |
static String |
COMPRESSOR_WAKEUP_INTERVAL
The compressor thread wakeup interval in microseconds. |
static 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 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 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 String |
ENV_CHECK_LEAKS
Debugging support: check leaked locks and txns at env close. |
static String |
ENV_DB_EVICTION
If true, enable eviction of metadata for closed databases. |
static String |
ENV_FAIR_LATCHES
If true, use latches instead of synchronized blocks to implement the lock table and log write mutexes. |
static String |
ENV_FORCED_YIELD
Debugging support: call Thread.yield() at strategic points. |
static String |
ENV_IS_LOCKING
If true, create the environment with record locking. |
static String |
ENV_IS_TRANSACTIONAL
If true, create an environment that is capable of performing transactions. |
static String |
ENV_LOCKOUT_TIMEOUT
The maximum time in milliseconds to wait for an API call to start executing when the API is locked. |
static String |
ENV_READ_ONLY
If true, open the environment read-only. |
static String |
ENV_RECOVERY_FORCE_CHECKPOINT
If true, a checkpoint is forced following recovery, even if the log ends with a checkpoint. |
static String |
ENV_RUN_CHECKPOINTER
If true, starts up the checkpointer thread. |
static String |
ENV_RUN_CLEANER
If true, starts up the cleaner thread. |
static String |
ENV_RUN_IN_COMPRESSOR
If true, starts up the INCompressor thread. |
static String |
EVICTOR_DEADLOCK_RETRY
The number of times to retry the evictor if it runs into a deadlock. |
static String |
EVICTOR_EVICT_BYTES
When eviction occurs, the evictor will push memory usage to this number of bytes below MAX_MEMORY . |
static String |
EVICTOR_FORCED_YIELD
Call Thread.yield() at each check for cache overflow. |
static String |
EVICTOR_LRU_ONLY
If true (the default), use an LRU-only policy to select nodes for eviction. |
static String |
EVICTOR_NODES_PER_SCAN
The number of nodes in one evictor scan. |
static String |
LOCK_N_LOCK_TABLES
Number of Lock Tables. |
static String |
LOCK_TIMEOUT
The LockTimeout property. |
static String |
LOG_BUFFER_SIZE
The maximum starting size of a JE log buffer. |
static String |
LOG_CHECKSUM_READ
If true, perform a checksum check when reading entries from log. |
static String |
LOG_CHUNKED_NIO
If non-0 (default is 0) break all IO into chunks of this size. |
static String |
LOG_DIRECT_NIO
If true (default is false) direct NIO buffers are used. |
static String |
LOG_FAULT_READ_SIZE
The buffer size for faulting in objects from disk, in bytes. |
static String |
LOG_FILE_CACHE_SIZE
The size of the file handle cache. |
static String |
LOG_FILE_MAX
The maximum size of each individual JE log file, in bytes. |
static String |
LOG_FSYNC_TIMEOUT
The timeout limit for group file sync, in microseconds. |
static 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 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 String |
LOG_MEM_ONLY
If true, operates in an in-memory test mode without flushing the log to disk. |
static String |
LOG_NUM_BUFFERS
The number of JE log buffers. |
static String |
LOG_TOTAL_BUFFER_BYTES
The total memory taken by log buffers, in bytes. |
static String |
LOG_USE_NIO
If true (default is false) NIO is used for all file I/O. |
static String |
LOG_USE_ODSYNC
If true (default is false) O_DSYNC is used to open JE log files. |
static String |
LOG_VERIFY_CHECKSUMS
If true, perform a checksum verification just before and after writing to the log. |
static String |
MAX_MEMORY
The CacheSize property. |
static String |
MAX_MEMORY_PERCENT
The CachePercent property. |
static String |
NODE_DUP_TREE_MAX_ENTRIES
The maximum number of entries in an internal dup btree node. |
static String |
NODE_MAX_ENTRIES
The maximum number of entries in an internal btree node. |
static String |
SHARED_CACHE
The SharedCache property. |
static String |
TRACE_CONSOLE
Use ConsoleHandler in logging system. |
static String |
TRACE_DB
Use DbLogHandler in logging system. |
static String |
TRACE_FILE
Use FileHandler in logging system. |
static String |
TRACE_FILE_COUNT
Log file count for FileHandler. |
static String |
TRACE_FILE_LIMIT
Log file limit for FileHandler. |
static String |
TRACE_LEVEL
Trace messages equal and above this level will be logged. |
static String |
TRACE_LEVEL_CLEANER
Cleaner specific detailed trace messages will be issued at this level. |
static String |
TRACE_LEVEL_EVICTOR
Evictor specific trace messages will be issued at this level. |
static String |
TRACE_LEVEL_LOCK_MANAGER
Lock manager specific trace messages will be issued at this level. |
static String |
TRACE_LEVEL_RECOVERY
Recovery specific trace messages will be issued at this level. |
static 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 String |
TREE_MAX_DELTA
After this many deltas, log a full version. |
static 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 String |
TXN_DEADLOCK_STACK_TRACE
Set this parameter to true to add stacktrace information to deadlock (lock timeout) exception messages. |
static String |
TXN_DUMP_LOCKS
Dump the lock table when a lock timeout is encountered, for debugging assistance. |
static String |
TXN_SERIALIZABLE_ISOLATION
The TxnSerializableIsolation
property. |
static String |
TXN_TIMEOUT
The TxnTimeout property. |
Constructor Summary | |
---|---|
EnvironmentConfig()
Creates an EnvironmentConfig initialized with the system default settings. |
|
EnvironmentConfig(Properties properties)
Creates an EnvironmentConfig which includes the properties specified in the properties parameter. |
Method Summary | |
---|---|
boolean |
getAllowCreate()
Returns a flag that specifies if we may create this environment. |
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. |
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. |
void |
setConfigParam(String paramName,
String value)
Validates the value prescribed for the configuration parameter; if it is valid, the value is set in the configuration. |
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. |
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. |
String |
toString()
Display configuration values. |
Methods inherited from class com.sleepycat.je.EnvironmentMutableConfig |
---|
getCachePercent, getCacheSize, getConfigParam, getExceptionListener, getNumExplicitlySetParams, getTxnNoSync, getTxnWriteNoSync, setCachePercent, setCacheSize, setExceptionListener, setTxnNoSync, setTxnWriteNoSync |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String MAX_MEMORY
CacheSize
property.
Name | Type | Mutable | Default | Minimum | Maximum |
"je.maxMemory" | Long | Yes | 0 | -none- | -none- |
EnvironmentMutableConfig.setCacheSize(long)
,
Constant Field Valuespublic static final String MAX_MEMORY_PERCENT
CachePercent
property.
Name | Type | Mutable | Default | Minimum | Maximum |
"je.maxMemoryPercent" | Integer | Yes | 60 | 1 | 90 |
EnvironmentMutableConfig.setCachePercent(int)
,
Constant Field Valuespublic static final String SHARED_CACHE
SharedCache
property.
Name | Type | Mutable | Default |
"je.sharedCache" | Boolean | No | false |
public static final String ENV_RECOVERY_FORCE_CHECKPOINT
Name | Type | Mutable | Default |
"je.env.recoveryForceCheckpoint" | Boolean | No | false |
public static final String ENV_RUN_IN_COMPRESSOR
Name | Type | Mutable | Default |
"je.env.runINCompressor" | Boolean | Yes | true |
public static final String ENV_RUN_CHECKPOINTER
Name | Type | Mutable | Default |
"je.env.runCheckpointer" | Boolean | Yes | true |
public static final String ENV_RUN_CLEANER
Name | Type | Mutable | Default |
"je.env.runCleaner" | Boolean | Yes | true |
public static final String ENV_BACKGROUND_READ_LIMIT
Name | Type | Mutable | Default | Minimum | Maximum |
"je.env.backgroundReadLimit" | Integer | Yes | 0 | 0 | -none- |
ENV_BACKGROUND_SLEEP_INTERVAL
,
Constant Field Valuespublic static final String ENV_BACKGROUND_WRITE_LIMIT
Name | Type | Mutable | Default | Minimum | Maximum |
"je.env.backgroundWriteLimit" | Integer | Yes | 0 | 0 | -none- |
ENV_BACKGROUND_SLEEP_INTERVAL
,
Constant Field Valuespublic static final String ENV_LOCKOUT_TIMEOUT
Name | Type | Mutable | Default | Minimum | Maximum |
"je.env.lockoutTimeout" | Integer | Yes | 2147483647 | 0 | -none |
public static final String ENV_BACKGROUND_SLEEP_INTERVAL
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 |
public static final String ENV_CHECK_LEAKS
Name | Type | Mutable | Default |
"je.env.checkLeaks" | Boolean | No | true |
public static final String ENV_FORCED_YIELD
Name | Type | Mutable | Default |
"je.env.forcedYield" | Boolean | No | false |
public static final String ENV_IS_TRANSACTIONAL
Name | Type | Mutable | Default |
"je.env.isTransactional" | Boolean | No | false |
public static final String ENV_IS_LOCKING
Name | Type | Mutable | Default |
"je.env.isLocking" | Boolean | No | true |
public static final String ENV_READ_ONLY
Name | Type | Mutable | Default |
"je.env.isReadOnly" | Boolean | No | false |
public static final String ENV_FAIR_LATCHES
Name | Type | Mutable | Default |
"je.env.fairLatches" | Boolean | No | false |
public static final String ENV_DB_EVICTION
Name | Type | Mutable | Default |
"je.env.dbEviction" | Boolean | No | true |
public static final String ADLER32_CHUNK_SIZE
Name | Type | Mutable | Default | Minimum | Maximum |
"je.adler32.chunkSize" | Integer | Yes | 0 | 0 | 1048576 (1M) |
public static final String LOG_TOTAL_BUFFER_BYTES
Name | Type | Mutable | Default | Minimum | Maximum |
"je.log.totalBufferBytes" | Long | No | 0 | 6144L | -none- |
public static final String LOG_NUM_BUFFERS
Name | Type | Mutable | Default | Minimum | Maximum |
"je.log.numBuffers" | Integer | No | 3 | 2 | -none- |
public static final String LOG_BUFFER_SIZE
Name | Type | Mutable | Default | Minimum | Maximum |
"je.log.bufferSize" | Integer | No | 1048576 (1M) | 1024 (1K) | -none- |
public static final String LOG_FAULT_READ_SIZE
Name | Type | Mutable | Default | Minimum | Maximum |
"je.log.faultReadSize" | Integer | No | 2048 (2K) | 32 | -none- |
public static final String LOG_ITERATOR_READ_SIZE
Name | Type | Mutable | Default | Minimum | Maximum |
"je.log.iteratorReadSize" | Integer | No | 8192 (8K) | 128 | -none- |
public static final String LOG_ITERATOR_MAX_SIZE
Name | Type | Mutable | Default | Minimum | Maximum |
"je.log.iteratorMaxSize" | Integer | No | 16777216 (16M) | 128 | -none- |
public static final String LOG_FILE_MAX
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 |
public static final String LOG_CHECKSUM_READ
Name | Type | Mutable | Default |
"je.log.checksumRead" | Boolean | No | true |
public static final String LOG_VERIFY_CHECKSUMS
Name | Type | Mutable | Default |
"je.log.verifyChecksums" | Boolean | No | false |
public static final String LOG_MEM_ONLY
Name | Type | Mutable | Default |
"je.log.memOnly" | Boolean | No | false |
public static final String LOG_FILE_CACHE_SIZE
Name | Type | Mutable | Default | Minimum | Maximum |
"je.log.fileCacheSize" | Integer | No | 100 | 3 | -none- |
public static final String LOG_FSYNC_TIMEOUT
Name | Type | Mutable | Default | Minimum | Maximum |
"je.log.fsyncTimeout" | Long | No | 500000 (0.5 sec) | 10000< (0.01 sec)/td> | -none- |
public static final String LOG_USE_ODSYNC
Name | Type | Mutable | Default |
"je.log.useODSYNC" | Boolean | No | false |
public static final String LOG_USE_NIO
Name | Type | Mutable | Default |
"je.log.useNIO" | Boolean | No | false |
public static final String LOG_DIRECT_NIO
LOG_USE_NIO
is true.
Name | Type | Mutable | Default |
"je.log.directNIO" | Boolean | No | false |
public static final String LOG_CHUNKED_NIO
LOG_USE_NIO
is true.
Name | Type | Mutable | Default | Minimum | Maximum |
"je.log.chunkedNIO" | Long | No | 0 | 0 | 67108864 (64M) |
public static final String NODE_MAX_ENTRIES
Name | Type | Mutable | Default | Minimum | Maximum |
"je.nodeMaxEntries" | Integer | No | 128 | 4 | 32767 (32K) |
public static final String NODE_DUP_TREE_MAX_ENTRIES
Name | Type | Mutable | Default | Minimum | Maximum |
"je.nodeDupTreeMaxEntries" | Integer | No | 128 | 4 | 32767 (32K) |
public static final String TREE_MAX_DELTA
Name | Type | Mutable | Default | Minimum | Maximum |
"je.tree.maxDelta" | Integer | No | 10 | 0 | 100 |
public static final String TREE_BIN_DELTA
Name | Type | Mutable | Default | Minimum | Maximum |
"je.tree.binDelta" | Integer | No | 25 | 0 | 75 |
public static final String TREE_MIN_MEMORY
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- |
public static final String COMPRESSOR_WAKEUP_INTERVAL
Name | Type | Mutable | Default | Minimum | Maximum |
"je.compressor.wakeupInterval" | Long | No | 5000000 (5 sec) | 1000000 (1 sec) | 4294967296 (71.6 min) |
public static final String COMPRESSOR_DEADLOCK_RETRY
Name | Type | Mutable | Default | Minimum | Maximum |
"je.compressor.deadlockRetry" | Integer | No | 3 | 0 | -none- |
public static final String COMPRESSOR_LOCK_TIMEOUT
Name | Type | Mutable | Default | Minimum | Maximum |
"je.compressor.lockTimeout" | Long | No | 500000 (0.5 sec) | 0 | 4294967296 (71.6 min) |
public static final String COMPRESSOR_PURGE_ROOT
Name | Type | Mutable | Default |
"je.compressor.purgeRoot" | Boolean | No | false |
public static final String EVICTOR_EVICT_BYTES
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- |
public static final String EVICTOR_NODES_PER_SCAN
Name | Type | Mutable | Default | Minimum | Maximum |
"je.evictor.nodesPerScan" | Integer | No | 10 | 1 | 1000 |
public static final String EVICTOR_DEADLOCK_RETRY
Name | Type | Mutable | Default | Minimum | Maximum |
"je.evictor.deadlockRetry" | Integer | No | 3 | 0 | -none- |
public static final String EVICTOR_LRU_ONLY
Name | Type | Mutable | Default |
"je.evictor.lruOnly" | Boolean | No | true |
public static final String EVICTOR_FORCED_YIELD
Name | Type | Mutable | Default |
"je.evictor.forcedYield" | Boolean | No | false |
public static final String CHECKPOINTER_BYTES_INTERVAL
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 |
public static final String CHECKPOINTER_WAKEUP_INTERVAL
CHECKPOINTER_BYTES_INTERVAL
).
Name | Type | Mutable | Default | Minimum | Maximum |
"je.checkpointer.wakeupInterval" | Long | No | 0 | 1000000 (1 sec) | 4294967296 (71.6 min) |
public static final String CHECKPOINTER_DEADLOCK_RETRY
Name | Type | Mutable | Default | Minimum | Maximum |
"je.checkpointer.deadlockRetry" | Integer | No | 3 | 0 | -none- |
public static final String CHECKPOINTER_HIGH_PRIORITY
Name | Type | Mutable | Default |
"je.checkpointer.highPriority" | Boolean | Yes | false |
public static final String CLEANER_MIN_UTILIZATION
Name | Type | Mutable | Default | Minimum | Maximum |
"je.cleaner.minUtilization" | Integer | Yes | 50 | 0 | 90 |
public static final String CLEANER_MIN_FILE_UTILIZATION
Name | Type | Mutable | Default | Minimum | Maximum |
"je.cleaner.minFileUtilization" | Integer | Yes | 5 | 0 | 50 |
public static final String CLEANER_BYTES_INTERVAL
LOG_FILE_MAX
value divided by four.
Name | Type | Mutable | Default | Minimum | Maximum |
"je.cleaner.bytesInterval" | Long | Yes | 0 | 0 | -none- |
public static final String CLEANER_FETCH_OBSOLETE_SIZE
Name | Type | Mutable | Default |
"je.cleaner.fetchObsoleteSize" | Boolean | Yes | false |
public static final String CLEANER_DEADLOCK_RETRY
Name | Type | Mutable | Default | Minimum | Maximum |
"je.cleaner.deadlockRetry" | Integer | Yes | 3 | 0 | -none- |
public static final String CLEANER_LOCK_TIMEOUT
Name | Type | Mutable | Default | Minimum | Maximum |
"je.cleaner.lockTimeout" | Long | Yes | 500000 (0.5 sec) | 0 | 4294967296 (71.6 min) |
public static final String CLEANER_EXPUNGE
Name | Type | Mutable | Default |
"je.cleaner.expunge" | Boolean | Yes | true |
public static final String CLEANER_MIN_AGE
Name | Type | Mutable | Default | Minimum | Maximum |
"je.cleaner.minAge" | Integer | Yes | 2 | 1 | 1000 |
public static final String CLEANER_MAX_BATCH_FILES
Name | Type | Mutable | Default | Minimum | Maximum |
"je.cleaner.maxBatchFiles" | Integer | Yes | 0 | 0 | 100000 |
public static final String CLEANER_READ_SIZE
LOG_ITERATOR_READ_SIZE
value is used.
Name | Type | Mutable | Default | Minimum | Maximum |
"je.cleaner.readSize" | Integer | Yes | 0 | 128 | -none- |
public static final String CLEANER_DETAIL_MAX_MEMORY_PERCENTAGE
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 |
public static final String CLEANER_FORCE_CLEAN_FILES
Name | Type | Mutable | Default |
"je.cleaner.forceCleanFiles" | String | No | "" |
public static final String CLEANER_UPGRADE_TO_LOG_VERSION
Name | Type | Mutable | Default | Minimum | Maximum |
"je.cleaner.upgradeToLogVersion" | Integer | No | 0 | -1 | -none- |
public static final String CLEANER_THREADS
Name | Type | Mutable | Default | Minimum | Maximum |
"je.cleaner.threads" | Integer | Yes | 1 | 1 | -none- |
public static final String CLEANER_LOOK_AHEAD_CACHE_SIZE
Name | Type | Mutable | Default | Minimum | Maximum |
"je.cleaner.lookAheadCacheSize" | Integer | Yes | 8192 (8K) | 0 | -none- |
public static final String LOCK_N_LOCK_TABLES
Name | Type | Mutable | Default | Minimum | Maximum |
"je.lock.nLockTables" | Integer | No | 1 | 1 | 32767 (32K) |
public static final String LOCK_TIMEOUT
LockTimeout
property.
Name | Type | Mutable | Default | Minimum | Maximum |
"je.lock.timeout" | Long | No | 500000 (0.5 sec) | 0 | 4294967296 (71.6 min) |
setLockTimeout(long)
,
Constant Field Valuespublic static final String TXN_TIMEOUT
TxnTimeout
property.
Name | Type | Mutable | Default | Minimum | Maximum |
"je.txn.timeout" | Long | No | 0 | 0 | 4294967296 (71.6 min) |
setTxnTimeout(long)
,
Constant Field Valuespublic static final String TXN_SERIALIZABLE_ISOLATION
TxnSerializableIsolation
property.
Name | Type | Mutable | Default |
"je.txn.serializableIsolation" | Boolean | No | false |
setTxnSerializableIsolation(boolean)
,
Constant Field Valuespublic static final String TXN_DEADLOCK_STACK_TRACE
Name | Type | Mutable | Default |
"je.txn.deadlockStackTrace" | Boolean | Yes | false |
public static final String TXN_DUMP_LOCKS
Name | Type | Mutable | Default |
"je.txn.dumpLocks" | Boolean | Yes | false |
public static final String TRACE_FILE
Name | Type | Mutable | Default |
"java.util.logging.FileHandler.on" | Boolean | No | false |
public static final String TRACE_CONSOLE
Name | Type | Mutable | Default |
"java.util.logging.ConsoleHandler.on" | Boolean | No | false |
public static final String TRACE_DB
Name | Type | Mutable | Default |
"java.util.logging.DbLogHandler.on" | Boolean | No | true |
public static final String TRACE_FILE_LIMIT
Name | Type | Mutable | Default | Minimum | Maximum |
"java.util.logging.FileHandler.limit" | Integer | No | 10000000 (10M) | 1000 | 1000000000 (1G) |
public static final String TRACE_FILE_COUNT
Name | Type | Mutable | Default | Minimum | Maximum |
"java.util.logging.FileHandler.count" | Integer | No | 10 | 1 | -none- |
public static final String TRACE_LEVEL
Name | Type | Mutable | Default |
"java.util.logging.level" | String | No | "INFO" |
public static final String TRACE_LEVEL_LOCK_MANAGER
Name | Type | Mutable | Default |
"java.util.logging.level.lockMgr" | String | No | "FINE" |
public static final String TRACE_LEVEL_RECOVERY
Name | Type | Mutable | Default |
"java.util.logging.level.recovery" | String | No | "FINE" |
public static final String TRACE_LEVEL_EVICTOR
Name | Type | Mutable | Default |
"java.util.logging.level.evictor" | String | No | "FINE" |
public static final String TRACE_LEVEL_CLEANER
Name | Type | Mutable | Default |
"java.util.logging.level.cleaner" | String | Yes | "FINE" |
Constructor Detail |
---|
public EnvironmentConfig()
public EnvironmentConfig(Properties properties) throws IllegalArgumentException
properties
- Supported properties are described in the sample
property file.
IllegalArgumentException
- If any properties read from the
properties param are invalid.Method Detail |
---|
public void setAllowCreate(boolean allowCreate)
allowCreate
- If true, the database environment is created if it
doesn't already exist.public boolean getAllowCreate()
public void setLockTimeout(long timeout) throws IllegalArgumentException
Equivalent to setting the je.lock.timeout parameter in the je.properties file.
timeout
- The lock timeout, in microseconds. A value of 0 turns off
lock timeouts.
IllegalArgumentException
- If the value of timeout is negativeTransaction.setLockTimeout(long)
public long getLockTimeout()
public void setReadOnly(boolean readOnly)
readOnly
- If true, configure the database environment to be read
only, and any attempt to modify a database will fail.public boolean getReadOnly()
This method may be called at any time during the life of the application.
public void setTransactional(boolean transactional)
This configuration option should be used when transactional guarantees such as atomicity of multiple operations and durability are important.
transactional
- If true, configure the database environment for
transactions.public boolean getTransactional()
This method may be called at any time during the life of the application.
public void setLocking(boolean 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.
locking
- If false, configure the database environment for no
locking. The default is true.public boolean getLocking()
This method may be called at any time during the life of the application.
public void setTxnTimeout(long timeout) throws IllegalArgumentException
Equivalent to setting the je.txn.timeout parameter in the je.properties file.
timeout
- The transaction timeout, in microseconds. A value of 0
turns off transaction timeouts.
IllegalArgumentException
- If the value of timeout is negativeTransaction.setTxnTimeout(long)
public long getTxnTimeout()
A value of 0 means transaction timeouts are not configured.
public void setTxnSerializableIsolation(boolean txnSerializableIsolation)
LockMode
public boolean getTxnSerializableIsolation()
LockMode
public void setSharedCache(boolean sharedCache)
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.
sharedCache
- If true, the shared cache is used by this
environment.public boolean getSharedCache()
public void setConfigParam(String paramName, String value) throws IllegalArgumentException
EnvironmentMutableConfig
setConfigParam
in class EnvironmentMutableConfig
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.
IllegalArgumentException
- if an invalid parameter was specified.public String toString()
toString
in class EnvironmentMutableConfig
|
Berkeley DB Java Edition version 3.3.62 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |