DatabaseEnvironmentConfig Members

BerkeleyDB

The DatabaseEnvironmentConfig type exposes the following members.

Constructors

  NameDescription
DatabaseEnvironmentConfig
Create a new object, with default settings

Methods

  NameDescription
Equals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
GetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType
Gets the Type of the current instance.
(Inherited from Object.)
SetEncryption
Set the password and algorithm used by the Berkeley DB library to perform encryption and decryption.
ToString
Returns a String that represents the current Object.
(Inherited from Object.)

Fields

  NameDescription
AutoCommit
If true, database operations for which no explicit transaction handle was specified, and which modify databases in the database environment, will be automatically enclosed within a transaction.
CDB_ALLDB
If true, Berkeley DB Concurrent Data Store applications will perform locking on an environment-wide basis rather than on a per-database basis.
Create
If true, Berkeley DB subsystems will create any underlying files, as necessary.
CreationDir
The path of a directory to be used as the location to create the access method database files. When Open(String, BTreeDatabaseConfig), Open(String, HashDatabaseConfig), Open(String, QueueDatabaseConfig) or Open(String, RecnoDatabaseConfig) is used to create a file it will be created relative to this path.
DataDirs
Paths of directories to be used as the location of the access method database files.
ErrorFeedback
The mechanism for reporting detailed error messages to the application.
ErrorPrefix
The prefix string that appears before error messages issued by Berkeley DB.
EventNotify
A delegate which is called to notify the process of specific Berkeley DB events.
Feedback
Monitor progress within long running operations.
ForceFlush
If true, Berkeley DB will flush database writes to the backing disk before returning from the write system call, rather than flushing database writes explicitly in a separate system call, as necessary.
FreeThreaded
If true, the created DatabaseEnvironment object will be free-threaded; that is, concurrently usable by multiple threads in the address space.
InitRegions
If true, Berkeley DB will page-fault shared regions into memory when initially creating or joining a Berkeley DB environment. In addition, Berkeley DB will write the shared regions when creating an environment, forcing the underlying virtual memory and filesystems to instantiate both the necessary memory and the necessary disk space. This can also avoid out-of-disk space failures later on.
IntermediateDirMode
The permissions for any intermediate directories created by Berkeley DB.
Lockdown
If true, lock shared Berkeley DB environment files and memory-mapped databases into memory.
LockSystemCfg
Configuration for the locking subsystem
LogSystemCfg
Configuration for the logging subsystem
MPoolSystemCfg
Configuration for the memory pool subsystem
MutexSystemCfg
Configuration for the mutex subsystem
NoBuffer
If true, turn off system buffering of Berkeley DB database files to avoid double caching.
NoLocking
If true, Berkeley DB will grant all requested mutual exclusion mutexes and database locks without regard for their actual availability. This functionality should never be used for purposes other than debugging.
NoMMap
If true, Berkeley DB will copy read-only database files into the local cache instead of potentially mapping them into process memory (see MMapSize for further information).
NoPanic
If true, Berkeley DB will ignore any panic state in the database environment. (Database environments in a panic state normally refuse all attempts to call Berkeley DB functions, throwing RunRecoveryException. This functionality should never be used for purposes other than debugging.
Overwrite
If true, overwrite files stored in encrypted formats before deleting them.
Private
If true, allocate region memory from the heap instead of from memory backed by the filesystem or system shared memory.
Register
If true, check to see if recovery needs to be performed before opening the database environment. (For this check to be accurate, all processes using the environment must specify it when opening the environment.)
RepSystemCfg
Configuration for the replication subsystem
RunFatalRecovery
If true, catastrophic recovery will be run on this environment before opening it for normal use.
RunRecovery
If true, normal recovery will be run on this environment before opening it for normal use.
SetThreadID
A delegate that returns a unique identifier pair for the current thread of control.
SystemMemory
If true, allocate region memory from system shared memory instead of from heap memory or memory backed by the filesystem.
TempDir
The path of a directory to be used as the location of temporary files.
ThreadIsAlive
A delegate that returns if a thread of control (either a true thread or a process) is still running.
ThreadName
A delegate that formats a process ID and thread ID identifier pair.
TimeNotGranted
If true, database calls timing out based on lock or transaction timeout values will throw LockNotGrantedException instead of DeadlockException. This allows applications to distinguish between operations which have deadlocked and operations which have exceeded their time limits.
TxnNoSync
If true, Berkeley DB will not write or synchronously flush the log on transaction commit.
TxnNoWait
If true and a lock is unavailable for any Berkeley DB operation performed in the context of a transaction, cause the operation to throw DeadlockException (or LockNotGrantedException if TimeNotGranted is set.
TxnSnapshot
If true, all transactions in the environment will be started as if Snapshot were passed to BeginTransaction()()(), and all non-transactional cursors will be opened as if SnapshotIsolation were passed to Cursor()()().
TxnWriteNoSync
If true, Berkeley DB will write, but will not synchronously flush, the log on transaction commit.
UseCDB
If true, initialize locking for the Berkeley DB Concurrent Data Store product.
UseEnvironmentVars
If true, the Berkeley DB process' environment may be permitted to specify information to be used when naming files.
UseLocking
If true, initialize the locking subsystem.
UseLogging
If true, initialize the logging subsystem.
UseMPool
If true, initialize the shared memory buffer pool subsystem.
UseMVCC
If true, all databases in the environment will be opened as if UseMVCC is passed to Open(String, DatabaseConfig). This flag will be ignored for queue databases for which MVCC is not supported.
UseReplication
If true, initialize the replication subsystem.
UseTxns
If true, initialize the transaction subsystem.
Verbosity
Specific additional informational and debugging messages in the Berkeley DB message output.
YieldCPU
If true, Berkeley DB will yield the processor immediately after each page or mutex acquisition. This functionality should never be used for purposes other than stress testing.

Properties

  NameDescription
EncryptAlgorithm
The algorithm used to perform encryption and decryption.
EncryptionPassword
The password used to perform encryption and decryption.
LockTimeout
A value, in microseconds, representing lock timeouts.
MaxTransactions
The number of active transactions supported by the environment. This value bounds the size of the memory allocated for transactions. Child transactions are counted as active until they either commit or abort.
ThreadCount
An approximate number of threads in the database environment.
TxnTimeout
A value, in microseconds, representing transaction timeouts.
TxnTimestamp
Recover to the time specified by timestamp rather than to the most current possible date.

See Also