The SecondaryDatabase type exposes the following members.

Methods

  NameDescription
CloseOverloaded.

Although closing a database also closes any open cursors, it is recommended that applications explicitly close all their Cursor objects before closing the database. The reason why is that when the cursor is explicitly closed, the memory allocated for it is reclaimed; however, this does not happen if you close a database while cursors are still opened.

The same rule, for the same reasons, holds true for Transaction objects. Simply make sure you resolve all your transaction objects before closing your database handle.

Because key/data pairs are cached in-memory, applications should make a point to always either close database handles or sync their data to disk (using Sync()()() before exiting, to ensure that any data cached in main memory is reflected in the underlying file system.

When called on a secondary index's primary database, the primary should be closed only after all secondary indices referencing it have been closed.

When multiple threads use the object concurrently, only a single thread may call the Close method.

The object may not be accessed again after Close is called, regardless of its outcome.

CursorOverloaded.
DeleteOverloaded.
Dispose
Release the resources held by this object, and close the database if it is still open.
(Inherited from BaseDatabase.)
Equals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
ExistsOverloaded.
GetOverloaded.
GetBothOverloaded.
GetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType
Gets the Type of the current instance.
(Inherited from Object.)
OpenOverloaded.
PrintFastStatsOverloaded.
The statistical information is described by the BTreeStats, HashStats, HeapStats, QueueStats, and RecnoStats classes.
PrintStatsOverloaded.
The statistical information is described by the BTreeStats, HashStats, HeapStats, QueueStats, and RecnoStats classes.
SecondaryCursorOverloaded.
Sync
Flush any cached information to disk.
(Inherited from BaseDatabase.)
ToString
Returns a String that represents the current Object.
(Inherited from Object.)
TruncateOverloaded.
When called on a database configured with secondary indices, This method truncates the primary database and all secondary indices. A count of the records discarded from the primary database is returned.

Properties

  NameDescription
AutoCommit
If true, all database modification operations based on this object are transactionally protected.
(Inherited from BaseDatabase.)
CacheSize
The size of the shared memory buffer pool (the cache).
(Inherited from BaseDatabase.)
Creation
The CreatePolicy with which this database was opened.
(Inherited from BaseDatabase.)
DatabaseName
The name of this database, if it has one.
(Inherited from BaseDatabase.)
DoChecksum
If true, do checksum verification of pages read into the cache from the backing filestore.
(Inherited from BaseDatabase.)
EncryptAlgorithm
The algorithm used by the Berkeley DB library to perform encryption and decryption.
(Inherited from BaseDatabase.)
Encrypted
If true, encrypt all data stored in the database.
(Inherited from BaseDatabase.)
Endianness
The database byte order.
(Inherited from BaseDatabase.)
ErrorFeedback
The mechanism for reporting detailed error messages to the application.
(Inherited from BaseDatabase.)
ErrorPrefix
The prefix string that appears before error messages issued by Berkeley DB.
(Inherited from BaseDatabase.)
Feedback
Monitor progress within long running operations.
(Inherited from BaseDatabase.)
FileName
The filename of this database, if it has one.
(Inherited from BaseDatabase.)
FreeThreaded
If true, the object is free-threaded; concurrently usable by multiple threads in the address space.
(Inherited from BaseDatabase.)
HasMultiple
If true, the object references a physical file supporting multiple databases.
(Inherited from BaseDatabase.)
InHostOrder
If true, the underlying database files were created on an architecture of the same byte order as the current one. This information may be used to determine whether application data needs to be adjusted for this architecture or not.
(Inherited from BaseDatabase.)
KeyGen
The delegate that creates the set of secondary keys corresponding to a given primary key and data pair.
messageFeedback
The mechanism for reporting detailed statistic messages to the application.
(Inherited from BaseDatabase.)
MessagePrefix
The prefix string that appears before informational messages issued by Berkeley DB.
(Inherited from BaseDatabase.)
Msgfile
The message file.
(Inherited from BaseDatabase.)
NoMMap

If true, this database is not mapped into process memory.

See MMapSize for further information.

(Inherited from BaseDatabase.)
NonDurableTxns
If true, Berkeley DB does not write log records for this database.
(Inherited from BaseDatabase.)
NoWaitDbExclusiveLock
If true, configure the database handle to obtain a write lock on the entire database. When the database is opened it immediately throws LockNotGrantedException if it cannot obtain the exclusive lock immediately. If False, configure the database handle to obtain a write lock on the entire database. When the database is opened, it blocks until it can obtain the exclusive lock. If null, do not configure the database handle to obtain a write lock on the entire database.
(Inherited from BaseDatabase.)
Nullifier
The nullifying function used to set the foreign key to null.
Pagesize
The database's current page size.
(Inherited from BaseDatabase.)
Priority
The cache priority for pages referenced by this object.
(Inherited from BaseDatabase.)
ReadOnly
If true, this database has been opened for read only. Any attempt to modify items in the database will fail, regardless of the actual permissions of any underlying files.
(Inherited from BaseDatabase.)
ReadUncommitted
If true, this database supports transactional read operations with degree 1 isolation. Read operations on the database may request the return of modified but not yet committed data.
(Inherited from BaseDatabase.)
Transactional
If true, this database has been opened in a transactional mode.
(Inherited from BaseDatabase.)
Truncated
If true, the underlying file was physically truncated upon open, discarding all previous databases it might have held.
(Inherited from BaseDatabase.)
Type
The type of the underlying access method (and file format). This value may be used to determine the type of the database after an Open(String, DatabaseConfig).
(Inherited from BaseDatabase.)
UseMVCC
If true, the database was opened with support for multiversion concurrency control.
(Inherited from BaseDatabase.)

See Also