<xml></xml>

Collapse AllExpand 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
BTreeDatabaseConfig Members
BTreeDatabaseConfig Class Constructors Methods Fields Properties See Also Send Feedback

The BTreeDatabaseConfig type exposes the following members.

# Constructors

| Name | Description
--- | --- | ---
| BTreeDatabaseConfig | Create a new BTreeDatabaseConfig 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.)
| SetCompression | Overloaded.
| SetEncryption | Set the password and algorithm used by the Berkeley DB library to perform encryption and decryption. (Inherited from DatabaseConfig.)
| SetPartitionByCallback | Enable database partitioning using the specified number of partitions and partition function. Return true if the specified number of partitions are successfully enabled; otherwise return false. The number of partitions to createThe name of partitioning function
| SetPartitionByKeys | Enable database partitioning using the specified partition keys. Return true if partitioning is successfully enabled; otherwise return false. An array of DatabaseEntry where each array entry defines the range of key values to be stored in each partition
| 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 is recoverable and all subsequent database modification operations based on this handle will be transactionally protected. If the call fails, no database has been created. (Inherited from DatabaseConfig.)
| BlobDir | Deprecated. Replaced by ExternalFileDir.
| BTreeCompare | The Btree key comparison function.
| BTreePrefixCompare | The Btree prefix function.
| 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.)
| DuplicateCompare | The duplicate data item comparison function.
| Duplicates | Policy for duplicate data items in the database. Allows a key/data pair to be inserted into the database even if the key already exists.
| Env | The Berkeley DB environment within which to create a database. If null, the database is created stand-alone; 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.)
| ExternalFileDir | The path of the directory where external files are stored. If the database is opened within DatabaseEnvironment, this path setting is ignored during Open(String, BTreeDatabaseConfig). Use ExternalFileDir to identify the current storage location of external files after opening the database. Replaces BlobDir.
| 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.)
| MessagePrefix | The prefix string that appears before informational messages issued by Berkeley DB. (Inherited from DatabaseConfig.)
| NoMMap | Do not map this database into process memory. (Inherited from DatabaseConfig.)
| NonDurableTxns | If true, Berkeley DB does not write log records for this database. (Inherited from DatabaseConfig.)
| NoReverseSplitting | Turn reverse splitting in the Btree on or off.
| 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.)
| UseRecordNumbers | If true, support retrieval from the Btree using record numbers.

# Properties

| Name | Description
--- | --- | ---
| BlobThreshold | Deprecated. Replaced by ExternalFileThreshold.
| Compress | The compression function used to store key/data pairs in the database.
| Decompress | The decompression function used to retrieve key/data pairs from the database.
| 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.)

ExternalFileThreshold

The size in bytes which is used to determine when a data item is stored as an external file.

Any data item that is equal to or larger in size than the threshold value is automatically stored as an external file.

If the threshold value is 0, external files are never be used by the database.

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

| MinKeysPerPage | The minimum number of key/data pairs intended to be stored on any single Btree leaf page.
| NParts | Return the number of partitions to create.
| PageSize | The size of the pages used to hold items in the database, in bytes. (Inherited from DatabaseConfig.)
| Partition | Return the application-specified partitioning function.
| PartitionKeys | Return an array of type DatabaseEntry where each array entry contains the range of keys contained in one of the database's partitions. The array contains the information for the entire database.

# See Also

BTreeDatabaseConfig Class
BerkeleyDB Namespace