<xml></xml>

Collapse All Expand All Code: All Code: Multiple Code: C# Code: Visual Basic Code: Visual C++ Members: Show All Members: Filtered Members: Filtered Members: Filtered

Berkeley DB .NET API Documentation
HeapDatabaseConfig Members
HeapDatabaseConfig Class Constructors Methods Fields Properties See Also Send Feedback

The HeapDatabaseConfig type exposes the following members.

# Constructors

| Name | Description
--- | --- | ---
| HeapDatabaseConfig | Instantiate a new HeapDatabaseConfig object

# Methods

| Name | Description
--- | --- | ---
| 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.)
| MaxSize | Set the maximum on-disk database file size used by the database. If this value is never set, the database's file size can grow without bound. If this value is set, then the heap file can never grow larger than the limit defined by this method. In that case, attempts to update or create records in a database that has reached its maximum size will throw a HeapFullException.
| SetEncryption | Set the password and algorithm used by the Berkeley DB library to perform encryption and decryption. (Inherited from DatabaseConfig.)
| ToString | Returns a string that represents the current object. (Inherited from Object.)

# Fields

| Name | Description
--- | --- | ---
| AutoCommit | Enclose the open call within a transaction. If the call succeeds, the open operation will be recoverable and all subsequent database modification operations based on this handle will be transactionally protected. If the call fails, no database will have been created. (Inherited from DatabaseConfig.)
| BlobDir | The path of the directory where blobs are stored. If the database is opened within DatabaseEnvironment, this path setting will be ignored during Open(String, HeapDatabaseConfig). Use BlobDir to identify the current storage location of blobs after opening the database.
| ByteOrder | The byte order for integers in the stored database metadata. The host byte order of the machine where the Berkeley DB library was compiled is the default value. (Inherited from DatabaseConfig.)
| CacheSize | The size of the shared memory buffer pool (the cache). (Inherited from DatabaseConfig.)
| Creation | The policy for how to handle database creation.
| DoChecksum | If true, do checksum verification of pages read into the cache from the backing filestore. (Inherited from DatabaseConfig.)
| Env | The Berkeley DB environment within which to create a database. If null, the database will be created stand-alone; that is, it is not part of any Berkeley DB environment. (Inherited from DatabaseConfig.)
| ErrorFeedback | The mechanism for reporting error messages to the application. (Inherited from DatabaseConfig.)
| ErrorPrefix | The prefix string that appears before error messages issued by Berkeley DB. (Inherited from DatabaseConfig.)
| Feedback | (Inherited from DatabaseConfig.)
| FreeThreaded | Causes the database object to be free-threaded; that is, concurrently usable by multiple threads in the address space. (Inherited from DatabaseConfig.)
| NoMMap | Do not map this database into process memory. (Inherited from DatabaseConfig.)
| NonDurableTxns | If true, Berkeley DB will not write log records for this database. (Inherited from DatabaseConfig.)
| NoWaitDbExclusiveLock | Configuration of BaseDatabase handle to obtain a write lock on the entire database. (Inherited from DatabaseConfig.)
| Priority | The cache priority for pages referenced by the database. (Inherited from DatabaseConfig.)
| ReadOnly | Open the database for reading only. Any attempt to modify items in the database will fail, regardless of the actual permissions of any underlying files. (Inherited from DatabaseConfig.)
| ReadUncommitted | Support transactional read operations with degree 1 isolation. (Inherited from DatabaseConfig.)
| Truncate | Physically truncate the underlying file, discarding all previous databases it might have held. (Inherited from DatabaseConfig.)
| UseMVCC | Open the database with support for multiversion concurrency control. (Inherited from DatabaseConfig.)

# Properties

| Name | Description
--- | --- | ---

BlobThreshold

The size in bytes which is used to determine when a data item will be stored as a blob.

Any data item that is equal to or larger in size than the threshold value will automatically be stored as a blob.

If the threshold value is 0, blobs will never be used by the database.

It is illegal to enable blob in the database which is configured as in-memory database or with chksum, encryption, duplicates, sorted duplicates, compression, multiversion concurrency control and transactional read operations with degree 1 isolation.

| EncryptAlgorithm | The algorithm used to perform encryption and decryption. (Inherited from DatabaseConfig.)
| Encrypted | Encrypt the database using the cryptographic password specified by DatabaseConfig.SetEncryption or DatabaseEnvironmentConfig.SetEncryption. (Inherited from DatabaseConfig.)
| EncryptionPassword | The password used to perform encryption and decryption. (Inherited from DatabaseConfig.)
| MaxSizeBytes | The bytes component of the maximum on-disk database file size.
| MaxSizeGBytes | The gigabytes component of the maximum on-disk database file size.
| PageSize | The size of the pages used to hold items in the database, in bytes. (Inherited from DatabaseConfig.)

RegionSize

The number of pages in a region of the database. If this value is never set, the default region size for the database's page size will be used. You can set the database page size using PageSize. If the database already exists, this value will be ignored. If the specified region size is larger than the maximum region size for the database's page size, an error will be returned when Open(String, DatabaseConfig) is called. The maximum allowable region size will be included in the error message.

# See Also

HeapDatabaseConfig Class
BerkeleyDB Namespace