DatabaseEnvironment Methods

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

C#
Visual Basic
Visual C++
Include Protected Members
Include Inherited Members

Berkeley DB .NET API Documentation
DatabaseEnvironment Methods
DatabaseEnvironment Class See Also Send Feedback

The DatabaseEnvironment type exposes the following members.

# Methods

| Name | Description
--- | --- | ---
| ArchivableDatabaseFiles | The database files that need to be archived in order to recover the database from catastrophic failure. Database files that have not been accessed during the lifetime of the current log files are not included in this list. It is also possible that some of the files referred to by the log have since been deleted from the system.
| ArchivableLogFiles | The names of all of the log files that are no longer in use (for example, that are no longer involved in active transactions), and that may safely be archived for catastrophic recovery and then removed from the system.
| Backup | Perform a hot back up of the open environment. All files used by the environment are backed up, so long as the normal rules for file placement are followed. For information on how files are normally placed relative to the environment directory, see the "Berkeley DB File Naming" section in the Berkeley DB Reference Guide. By default, data directories and the log directory specified relative to the home directory are recreated relative to the target directory. If absolute path names are used, then use the SingleDir method. This method provides the same functionality as the db_hotbackup utility. However, this method does not perform the housekeeping actions performed by that utility. In particular, you may want to run a checkpoint before calling this method. To run a checkpoint, use the Checkpoint()()() method. For more information on checkpoints, see the "Checkpoint" section in the Berkeley DB Reference Guide. To back up a single database file within the environment, use the BackupDatabase(String, String, Boolean) method. In addition to the configuration options available using the BackupOptions class, additional tuning modifications can be made using the BackupReadCount, BackupReadSleepDuration, BackupBufferSize, and BackupWriteDirect properties. Alternatively, you can write your own custom hot back up facility using the IBackup interface.
| BackupDatabase | Perform a hot back up of a single database file contained within the environment. To back up the entire environment, use the Backup(String, BackupOptions) method. You can make some tuning modifications to the backup process using the BackupReadCount, BackupReadSleepDuration, BackupBufferSize, and BackupWriteDirect properties. Alternatively, you can write your own custom hot back up facility using the IBackup interface.
| BeginCDSGroup | Allocate a locker ID in an environment configured for Berkeley DB Concurrent Data Store applications.
| BeginTransaction | Overloaded.
| Checkpoint | Overloaded.
| Close | By closing the Berkeley DB environment you can free allocated resources and close any open databases along with the underlying subsystems.
| CloseForceSync | Close the Berkeley DB environment, freeing any allocated resources, closing any open databases as well as underlying subsystems.
| CloseForceSyncAndForceSyncEnv | Close the Berkeley DB environment, freeing any allocated resources, closing any open databases as well as underlying subsystems.
| CloseForceSyncEnv | Close the Berkeley DB environment, freeing any allocated resources, closing any open databases as well as underlying subsystems.
| DetectDeadlocks | Run one iteration of the deadlock detector. The deadlock detector traverses the lock table and marks one of the participating lock requesters for rejection in each deadlock it finds.
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
| FailCheck | Check for threads of control (either a true thread or a process) that have exited while manipulating Berkeley DB library data structures, while holding a logical database lock, or with an unresolved transaction (that is, a transaction that was never aborted or committed).
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.)
| GetType | Gets the Type of the current instance. (Inherited from Object.)
| IsTransactionApplied | This method checks to see if a specified transaction has been replicated from the master of a replication group. It may be called by applications using either the Base API or the Replication Manager.
| LockingSystemStats | Overloaded.
| LogFile | Map an LSN object to a log filename
| LogFiles | The names of all of the log files
| LogFlush | Overloaded.
| LoggingSystemStats | Overloaded.
| LogVerify | Verify log records of this environment.
| LogWrite | Append a record to the log
| MPoolSystemStats | Overloaded.
| MutexSystemStats | Overloaded.
| Open | Instantiate a new DatabaseEnvironment object and open the Berkeley DB environment represented by home.
| Panic | Set the panic state for the database environment. (Database environments in a panic state normally refuse all attempts to call Berkeley DB functions, throwing RunRecoveryException.)
| PrintLockingSystemStats | Overloaded.
| PrintLoggingSystemStats | Overloaded.
| PrintMPoolSystemStats | Overloaded.
| PrintMutexSystemStats | Overloaded.
| PrintReplicationSystemStats | Overloaded.
| PrintRepMgrSystemStats | Overloaded.
| PrintStats | Overloaded.
| PrintSubsystemStats | Overloaded.
| PrintTransactionSystemStats | Overloaded.
| Recover | Restore transactions that were prepared, but not yet resolved at the time of the system shut down or crash, to their state prior to the shut down or crash, including any locks previously held.
| RegionSetMemoryLimit | The amount of memory to be used by shared structures in the main environment region. These are structures other than mutexes and the page cache (memory pool).
| Remove | Overloaded. The environment regions, including any backing files, are removed. Any log or database files and the environment directory are not removed. If there are processes that have called Open(String, DatabaseEnvironmentConfig) without calling Close()()() (that is, there are processes currently using the environment), Remove fails without further action. Calling Remove should not be necessary for most applications because the Berkeley DB environment is cleaned up as part of normal database recovery procedures. However, applications may want to call Remove as part of application shut down to free up system resources. For example, if SystemMemory was specified to Open(String, DatabaseEnvironmentConfig), it may be useful to call Remove in order to release system shared memory segments that have been allocated. Or, on architectures in which mutexes require allocation of underlying system resources, it may be useful to call Remove in order to release those resources. Alternatively, if recovery is not required because no database state is maintained across failures, and no system resources need to be released, it is possible to clean up an environment by simply removing all the Berkeley DB files in the database environment's directories. In multithreaded applications, only a single thread may call Remove.
| RemoveDB | Overloaded.
| RemoveUnusedLogFiles | Remove log files that are no longer needed. Automatic log file removal is likely to make catastrophic recovery impossible.
| RenameDB | Overloaded.
| RepHoldElection | Overloaded. RepHoldElection is not called by most replication applications. It should only be called by applications implementing their own network transport layer, explicitly holding replication group elections and handling replication messages outside of the replication manager framework. If the election is successful, Berkeley DB notifies the application of the results of the election by means of either the REP_ELECTED or REP_NEWMASTER events (see EventNotifyfor more information). The application is responsible for adjusting its relationship to the other database environments in the replication group, including directing all database updates to the newly selected master, in accordance with the results of the election. The thread of control that calls RepHoldElection must not be the thread of control that processes incoming messages; processing the incoming messages is necessary to successfully complete an election. Before calling this method, the RepTransport delegate must already have been configured to send replication messages.
| ReplicationSystemStats | Overloaded.
| RepMgrChannel | Create DbChannel with given eid.
| RepmgrSetIncomingQueueMax | Set a byte-count limit on the maximum amount of dynamic memory used by the Replication Manager incoming queue.
| RepMgrSite | Overloaded.
| RepMgrSiteConfig | Configure a site in the replication manager.
| RepMgrStartClient | Overloaded. There are two ways to build Berkeley DB replication applications: the most common approach is to use the Berkeley DB library "replication manager" support, where the Berkeley DB library manages the replication group, including network transport, all replication message processing and acknowledgment, and group elections. Applications using the replication manager support generally make the following calls: Configure the local site in the replication group, RepMgrLocalSite. Call RepMgrSiteConfig(DbSiteConfig) to configure the remote site(s) in the replication group. Configure the message acknowledgment policy (RepMgrAckPolicy) which provides the replication group's transactional needs. Configure the local site's election priority, RepPriority. Call RepMgrStartClient(Int32) or RepMgrStartMaster(Int32) to start the replication application. For more information on building replication manager applications, please see the Replication Getting Started Guide included in the Berkeley DB documentation. Applications with special needs (for example, applications using network protocols not supported by the Berkeley DB replication manager), must perform additional configuration and call other Berkeley DB replication methods. For more information on building advanced replication applications, please see the Base Replication API section in the Berkeley DB Programmer's Reference Guide for more information. Starting the replication manager consists of opening the TCP/IP listening socket to accept incoming connections, and starting all necessary background threads. When multiple processes share a database environment, only one process can open the listening socket; RepMgrStartClient(Int32) (and RepMgrStartMaster(Int32)) automatically open the socket in the first process to call it, and skips this step in the later calls from other processes.
| RepMgrStartMaster | Start the replication manager as a master site, and do not call for an election.
| RepMgrSystemStats | Overloaded.
| RepProcessMessage | Process an incoming replication message sent by a member of the replication group to the local database environment.
| RepSetClockskew | Set the clock skew ratio among replication group members based on the fastest and slowest measurements among the group for use with master leases.
| RepSetRetransmissionRequest | Set a threshold for the minimum and maximum time that a client waits before requesting retransmission of a missing message.
| RepSetTransmitLimit | Set a byte-count limit on the amount of data that is transmitted from a site in response to a single message processed by RepProcessMessage(DatabaseEntry, DatabaseEntry, Int32). The limit is not a hard limit, and the record that exceeds the limit is the last record to be sent.
| RepSetTransport | Initialize the communication infrastructure for a database environment participating in a replicated application.
| RepStartClient | Overloaded. RepStartClient is not called by most replication applications. It should only be called by applications implementing their own network transport layer, explicitly holding replication group elections and handling replication messages outside of the replication manager framework. Replication master environments are the only database environments where replicated databases may be modified. Replication client environments are read-only as long as they are clients. Replication client environments may be upgraded to be replication master environments in the case that the current master fails or there is no master present. If master leases are in use, this method cannot be used to appoint a master, and should only be used to configure a database environment as a master as the result of an election. Before calling this method, the RepTransport delegate must already have been configured to send replication messages.
| RepStartMaster | Overloaded. RepStartMaster is not called by most replication applications. It should only be called by applications implementing their own network transport layer, explicitly holding replication group elections and handling replication messages outside of the replication manager framework. Replication master environments are the only database environments where replicated databases may be modified. Replication client environments are read-only as long as they are clients. Replication client environments may be upgraded to be replication master environments in the case that the current master fails or there is no master present. If master leases are in use, this method cannot be used to appoint a master, and should only be used to configure a database environment as a master as the result of an election. Before calling this method, the RepTransport delegate must already have been configured to send replication messages.
| RepSync | Force master synchronization to begin for this client.
| ResetFileID | Allow database files to be copied and used in the same database environment as the original.
| ResetLSN | Allow database files to be moved from one transactional database environment to another.
| SetMaxSequentialWrites | Limit the number of sequential write operations scheduled by the library when flushing dirty pages from the cache.
| SyncMemPool | Overloaded.
| ToString | Returns a String that represents the current Object. (Inherited from Object.)
| TransactionSystemStats | Overloaded.
| TrickleCleanMemPool | Ensure that a specified percent of the pages in the cache are clean, by writing dirty pages to their backing files.
| WriteToLog | Overloaded. WriteToLog allows applications to include information in the database environment log files, for later review using the db_printlog utility. This method is intended for debugging and performance tuning. WriteToLog allows applications to include information in the database environment log files, for later review using the db_printlog utility. This method is intended for debugging and performance tuning.

# See Also

DatabaseEnvironment Class
BerkeleyDB Namespace