You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
338 lines
45 KiB
338 lines
45 KiB
<html xmlns:MSHelp="http://msdn.microsoft.com/mshelp" xmlns:mshelp="http://msdn.microsoft.com/mshelp" xmlns:ddue="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:msxsl="urn:schemas-microsoft-com:xslt"><head><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8" /><META NAME="save" CONTENT="history" /><title>DatabaseEnvironment Methods </title><link rel="stylesheet" type="text/css" href="../styles/presentation.css" /><link rel="stylesheet" type="text/css" href="ms-help://Hx/HxRuntime/HxLink.css" /><script type="text/javascript" src="../scripts/EventUtilities.js"> </script><script type="text/javascript" src="../scripts/SplitScreen.js"> </script><script type="text/javascript" src="../scripts/Dropdown.js"> </script><script type="text/javascript" src="../scripts/script_manifold.js"> </script><script type="text/javascript" src="../scripts/script_feedBack.js"> </script><script type="text/javascript" src="../scripts/CheckboxMenu.js"> </script><script type="text/javascript" src="../scripts/CommonUtilities.js"> </script><meta name="container" content="BerkeleyDB" /><meta name="file" content="Methods_T_BerkeleyDB_DatabaseEnvironment" /><meta name="guid" content="Methods_T_BerkeleyDB_DatabaseEnvironment" /><xml><MSHelp:Attr Name="AssetID" Value="Methods.T:BerkeleyDB.DatabaseEnvironment" /><MSHelp:TOCTitle Title="DatabaseEnvironment Methods " /><MSHelp:RLTitle Title="DatabaseEnvironment Methods (BerkeleyDB)" /><MSHelp:Keyword Index="A" Term="Methods.T:BerkeleyDB.DatabaseEnvironment" /><MSHelp:Keyword Index="A" Term="frlrfBerkeleyDBDatabaseEnvironmentMethodsTopic" /><MSHelp:Keyword Index="K" Term="DatabaseEnvironment class, methods" /><MSHelp:Attr Name="DevLang" Value="CSharp" /><MSHelp:Attr Name="DevLang" Value="VB" /><MSHelp:Attr Name="DevLang" Value="C++" /><MSHelp:Attr Name="Locale" Value="en-us" /><MSHelp:Attr Name="TopicType" Value="kbSyntax" /><MSHelp:Attr Name="TopicType" Value="apiref" /><MSHelp:Attr Name="AssemblyVersion" Value="6.2.23.0" /></xml></head><body><input type="hidden" id="userDataCache" class="userDataStyle" /><input type="hidden" id="hiddenScrollOffset" /><img id="collapseImage" style="display:none; height:0; width:0;" src="../icons/collapse_all.gif" title="Collapse image" /><img id="expandImage" style="display:none; height:0; width:0;" src="../icons/expand_all.gif" title="Expand Image" /><img id="collapseAllImage" style="display:none; height:0; width:0;" src="../icons/collapse_all.gif" /><img id="expandAllImage" style="display:none; height:0; width:0;" src="../icons/expand_all.gif" /><img id="dropDownImage" style="display:none; height:0; width:0;" src="../icons/dropdown.gif" /><img id="dropDownHoverImage" style="display:none; height:0; width:0;" src="../icons/dropdownHover.gif" /><img id="copyImage" style="display:none; height:0; width:0;" src="../icons/copycode.gif" title="Copy image" /><img id="copyHoverImage" style="display:none; height:0; width:0;" src="../icons/copycodeHighlight.gif" title="CopyHover image" /><div id="header"><table id="topTable" cellspacing="0" cellpadding="0"><tr><td><span onclick="ExpandCollapseAll(toggleAllImage)" style="cursor:default;" onkeypress="ExpandCollapseAll_CheckKey(toggleAllImage, event)" tabindex="0"><img ID="toggleAllImage" class="toggleAll" src="../icons/collapse_all.gif" /> <label id="collapseAllLabel" for="toggleAllImage" style="display: none;">Collapse All</label><label id="expandAllLabel" for="toggleAllImage" style="display: none;">Expand All</label> </span><span> </span><span id="devlangsDropdown" class="filter" tabindex="0"><img id="devlangsDropdownImage" src="../icons/dropdown.gif" /> <label id="devlangsMenuAllLabel" for="devlangsDropdownImage" style="display: none;"><nobr>Code: All </nobr></label><label id="devlangsMenuMultipleLabel" for="devlangsDropdownImage" style="display: none;"><nobr>Code: Multiple </nobr></label><label id="devlangsMenuCSharpLabel" for="devlangsDropdownImage" style="display: none;"><nobr>Code: C# </nobr></label><label id="devlangsMenuVisualBasicLabel" for="devlangsDropdownImage" style="display: none;"><nobr>Code: Visual Basic </nobr></label><label id="devlangsMenuManagedCPlusPlusLabel" for="devlangsDropdownImage" style="display: none;"><nobr>Code: Visual C++ </nobr></label></span><span> </span><span id="memberOptionsDropdown" class="filter" tabindex="0"><img id="memberOptionsDropdownImage" src="../icons/dropdown.gif" /> <label id="memberOptionsMenuAllLabel" for="memberOptionsDropdownImage" style="display: none;"><nobr>Members: Show All </nobr></label><label id="memberOptionsMenuMultipleLabel" for="memberOptionsDropdownImage" style="display: none;"><nobr>Members: Filtered </nobr></label><label id="memberOptionsMenuProtectedLabel" for="memberOptionsDropdownImage" style="display: none;"><nobr>Members: Filtered </nobr></label><label id="memberOptionsMenuInheritedLabel" for="memberOptionsDropdownImage" style="display: none;"><nobr>Members: Filtered </nobr></label></span></td></tr></table><div id="devlangsMenu"><input id="CSharpCheckbox" type="checkbox" data="CSharp,cs,'persist'" value="on" onClick="SetLanguage(this)" /><label class="checkboxLabel" for="CSharpCheckbox">C#</label><br /><input id="VisualBasicCheckbox" type="checkbox" data="VisualBasic,vb,'persist'" value="on" onClick="SetLanguage(this)" /><label class="checkboxLabel" for="VisualBasicCheckbox">Visual Basic</label><br /><input id="ManagedCPlusPlusCheckbox" type="checkbox" data="ManagedCPlusPlus,cpp,'persist'" value="on" onClick="SetLanguage(this)" /><label class="checkboxLabel" for="ManagedCPlusPlusCheckbox">Visual C++</label><br /></div><div id="memberOptionsMenu"><input id="ProtectedCheckbox" type="checkbox" data="Protected" value="on" onClick="SetMemberOptions(this, 'vis')" /><label class="checkboxLabel" for="ProtectedCheckbox">Include Protected Members</label><br /><input id="InheritedCheckbox" type="checkbox" data="Inherited" value="on" onClick="SetMemberOptions(this, 'decl')" /><label class="checkboxLabel" for="InheritedCheckbox">Include Inherited Members</label><br /></div><table id="bottomTable" cellpadding="0" cellspacing="0"><tr id="headerTableRow1"><td align="left"><span id="runningHeaderText">Berkeley DB .NET API Documentation</span></td></tr><tr id="headerTableRow2"><td align="left"><span id="nsrTitle">DatabaseEnvironment Methods </span></td></tr><tr id="headerTableRow3"><td align="left"><a href="T_BerkeleyDB_DatabaseEnvironment.htm">DatabaseEnvironment Class</a> <a href="#seeAlsoToggle" onclick="OpenSection(seeAlsoToggle)">See Also</a>
|
|
<span id="headfeedbackarea" class="feedbackhead">
|
|
<a href="javascript:SubmitFeedback('','Berkeley DB .NET API Documentation','','','','%0\dYour%20feedback%20is%20used%20to%20improve%20the%20documentation%20and%20the%20product.%20Your%20e-mail%20address%20will%20not%20be%20used%20for%20any%20other%20purpose%20and%20is%20disposed%20of%20after%20the%20issue%20you%20report%20is%20resolved.%20%20While%20working%20to%20resolve%20the%20issue%20that%20you%20report,%20you%20may%20be%20contacted%20via%20e-mail%20to%20get%20further%20details%20or%20clarification%20on%20the%20feedback%20you%20sent.%20After%20the%20issue%20you%20report%20has%20been%20addressed,%20you%20may%20receive%20an%20e-mail%20to%20let%20you%20know%20that%20your%20feedback%20has%20been%20addressed.%0\A%0\d','Customer%20Feedback');">
|
|
|
|
Send Feedback
|
|
</a>
|
|
</span>
|
|
</td></tr></table><table id="gradientTable"><tr><td class="nsrBottom" background="../icons/gradient.gif" /></tr></table></div><div id="mainSection"><div id="mainBody"><div id="allHistory" class="saveHistory" onsave="saveAll()" onload="loadAll()" /><span style="color: DarkGray"> </span><p>The <a href="T_BerkeleyDB_DatabaseEnvironment.htm">DatabaseEnvironment</a> type exposes the following members.</p><h1 class="heading"><span onclick="ExpandCollapse(methodTableToggle)" style="cursor:default;" onkeypress="ExpandCollapse_CheckKey(methodTableToggle, event)" tabindex="0"><img id="methodTableToggle" class="toggle" name="toggleSwitch" src="../icons/collapse_all.gif" />Methods</span></h1><div id="methodTableSection" class="section" name="collapseableSection" style=""><table id="memberList" class="members" frame="lhs" cellpadding="2"><col width="10%" /><tr><th class="iconColumn">
|
|
|
|
</th><th class="nameColumn">Name</th><th class="descriptionColumn">Description</th></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_ArchivableDatabaseFiles.htm">ArchivableDatabaseFiles</a></td><td><div class="summary">
|
|
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.
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_ArchivableLogFiles.htm">ArchivableLogFiles</a></td><td><div class="summary">
|
|
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.
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_Backup.htm">Backup</a></td><td><div class="summary">
|
|
Perform a hot back up of the open environment.
|
|
<p>
|
|
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.
|
|
</p><p>
|
|
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
|
|
<a href="F_BerkeleyDB_BackupOptions_SingleDir.htm">SingleDir</a> method.
|
|
</p><p>
|
|
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 <a href="M_BerkeleyDB_DatabaseEnvironment_Checkpoint.htm">Checkpoint<span class="languageSpecificText"><span class="cs">()</span><span class="cpp">()</span><span class="nu">()</span></span></a> method. For
|
|
more information on checkpoints, see the "Checkpoint" section in the
|
|
Berkeley DB Reference Guide.
|
|
</p><p>
|
|
To back up a single database file within the environment, use the
|
|
<a href="M_BerkeleyDB_DatabaseEnvironment_BackupDatabase.htm">BackupDatabase(String, String, Boolean)</a> method.
|
|
</p><p>
|
|
In addition to the configuration options available using the
|
|
<a href="T_BerkeleyDB_BackupOptions.htm">BackupOptions</a> class, additional tuning modifications
|
|
can be made using the <a href="P_BerkeleyDB_DatabaseEnvironment_BackupReadCount.htm">BackupReadCount</a>,
|
|
<a href="P_BerkeleyDB_DatabaseEnvironment_BackupReadSleepDuration.htm">BackupReadSleepDuration</a>,
|
|
<a href="P_BerkeleyDB_DatabaseEnvironment_BackupBufferSize.htm">BackupBufferSize</a>, and
|
|
<a href="P_BerkeleyDB_DatabaseEnvironment_BackupWriteDirect.htm">BackupWriteDirect</a> properties.
|
|
Alternatively, you can write your own custom hot back up facility
|
|
using the <a href="T_BerkeleyDB_IBackup.htm">IBackup</a> interface.
|
|
</p></div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_BackupDatabase.htm">BackupDatabase</a></td><td><div class="summary">
|
|
Perform a hot back up of a single database file contained within the
|
|
environment.
|
|
<p>
|
|
To back up the entire environment, use the
|
|
<a href="M_BerkeleyDB_DatabaseEnvironment_Backup.htm">Backup(String, BackupOptions)</a> method.
|
|
</p><p>
|
|
You can make some tuning modifications to the backup process using
|
|
the <a href="P_BerkeleyDB_DatabaseEnvironment_BackupReadCount.htm">BackupReadCount</a>,
|
|
<a href="P_BerkeleyDB_DatabaseEnvironment_BackupReadSleepDuration.htm">BackupReadSleepDuration</a>,
|
|
<a href="P_BerkeleyDB_DatabaseEnvironment_BackupBufferSize.htm">BackupBufferSize</a>, and
|
|
<a href="P_BerkeleyDB_DatabaseEnvironment_BackupWriteDirect.htm">BackupWriteDirect</a> properties.
|
|
Alternatively, you can write your own custom hot back up facility
|
|
using the <a href="T_BerkeleyDB_IBackup.htm">IBackup</a> interface.
|
|
</p></div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_BeginCDSGroup.htm">BeginCDSGroup</a></td><td><div class="summary">
|
|
Allocate a locker ID in an environment configured for Berkeley DB
|
|
Concurrent Data Store applications.
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_DatabaseEnvironment_BeginTransaction.htm">BeginTransaction</a></td><td>Overloaded. </td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_DatabaseEnvironment_Checkpoint.htm">Checkpoint</a></td><td>Overloaded. </td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_Close.htm">Close</a></td><td><div class="summary">
|
|
By closing the Berkeley DB environment you can free allocated resources
|
|
and close any open databases along with the underlying subsystems.
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_CloseForceSync.htm">CloseForceSync</a></td><td><div class="summary">
|
|
Close the Berkeley DB environment, freeing any allocated resources,
|
|
closing any open databases as well as underlying subsystems.
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_CloseForceSyncAndForceSyncEnv.htm">CloseForceSyncAndForceSyncEnv</a></td><td><div class="summary">
|
|
Close the Berkeley DB environment, freeing any allocated resources,
|
|
closing any open databases as well as underlying subsystems.
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_CloseForceSyncEnv.htm">CloseForceSyncEnv</a></td><td><div class="summary">
|
|
Close the Berkeley DB environment, freeing any allocated resources,
|
|
closing any open databases as well as underlying subsystems.
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_DetectDeadlocks.htm">DetectDeadlocks</a></td><td><div class="summary">
|
|
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.
|
|
</div></td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/bsc2ak47" target="_blank">Equals</a></td><td><div class="summary">
|
|
Determines whether the specified <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a> is equal to the current <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.
|
|
</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_FailCheck.htm">FailCheck</a></td><td><div class="summary">
|
|
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).
|
|
</div></td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/zdee4b3y" target="_blank">GetHashCode</a></td><td><div class="summary">
|
|
Serves as a hash function for a particular type.
|
|
</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/dfwy45w9" target="_blank">GetType</a></td><td><div class="summary">
|
|
Gets the <a href="http://msdn2.microsoft.com/en-us/library/42892f65" target="_blank">Type</a> of the current instance.
|
|
</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_IsTransactionApplied.htm">IsTransactionApplied</a></td><td><div class="summary">
|
|
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.
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_DatabaseEnvironment_LockingSystemStats.htm">LockingSystemStats</a></td><td>Overloaded. </td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_LogFile.htm">LogFile</a></td><td><div class="summary">
|
|
Map an LSN object to a log filename
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_LogFiles.htm">LogFiles</a></td><td><div class="summary">
|
|
The names of all of the log files
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_DatabaseEnvironment_LogFlush.htm">LogFlush</a></td><td>Overloaded. </td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_DatabaseEnvironment_LoggingSystemStats.htm">LoggingSystemStats</a></td><td>Overloaded. </td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_LogVerify.htm">LogVerify</a></td><td><div class="summary">
|
|
Verify log records of this environment.
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_LogWrite.htm">LogWrite</a></td><td><div class="summary">
|
|
Append a record to the log
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_DatabaseEnvironment_MPoolSystemStats.htm">MPoolSystemStats</a></td><td>Overloaded. </td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_DatabaseEnvironment_MutexSystemStats.htm">MutexSystemStats</a></td><td>Overloaded. </td></tr><tr data="public;static;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /><img src="../icons/static.gif" title="Static member" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_Open.htm">Open</a></td><td><div class="summary">
|
|
Instantiate a new DatabaseEnvironment object and open the Berkeley
|
|
DB environment represented by <span class="parameter">home</span>.
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_Panic.htm">Panic</a></td><td><div class="summary">
|
|
Set the panic state for the database environment. (Database
|
|
environments in a panic state normally refuse all attempts to call
|
|
Berkeley DB functions, throwing <a href="T_BerkeleyDB_RunRecoveryException.htm">RunRecoveryException</a>.)
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_DatabaseEnvironment_PrintLockingSystemStats.htm">PrintLockingSystemStats</a></td><td>Overloaded. </td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_DatabaseEnvironment_PrintLoggingSystemStats.htm">PrintLoggingSystemStats</a></td><td>Overloaded. </td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_DatabaseEnvironment_PrintMPoolSystemStats.htm">PrintMPoolSystemStats</a></td><td>Overloaded. </td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_DatabaseEnvironment_PrintMutexSystemStats.htm">PrintMutexSystemStats</a></td><td>Overloaded. </td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_DatabaseEnvironment_PrintReplicationSystemStats.htm">PrintReplicationSystemStats</a></td><td>Overloaded. </td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_DatabaseEnvironment_PrintRepMgrSystemStats.htm">PrintRepMgrSystemStats</a></td><td>Overloaded. </td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_DatabaseEnvironment_PrintStats.htm">PrintStats</a></td><td>Overloaded. </td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_DatabaseEnvironment_PrintSubsystemStats.htm">PrintSubsystemStats</a></td><td>Overloaded. </td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_DatabaseEnvironment_PrintTransactionSystemStats.htm">PrintTransactionSystemStats</a></td><td>Overloaded. </td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_Recover.htm">Recover</a></td><td><div class="summary">
|
|
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.
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_RegionSetMemoryLimit.htm">RegionSetMemoryLimit</a></td><td><div class="summary">
|
|
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).
|
|
</div></td></tr><tr data="public;static;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /><img src="../icons/static.gif" title="Static member" /></td><td><a href="Overload_BerkeleyDB_DatabaseEnvironment_Remove.htm">Remove</a></td><td>Overloaded. <div class="summary">
|
|
<p>
|
|
The environment regions, including any backing files, are removed.
|
|
Any log or database files and the environment directory are not
|
|
removed.
|
|
</p>
|
|
<p>
|
|
If there are processes that have called <a href="M_BerkeleyDB_DatabaseEnvironment_Open.htm">Open(String, DatabaseEnvironmentConfig)</a> without
|
|
calling <a href="M_BerkeleyDB_DatabaseEnvironment_Close.htm">Close<span class="languageSpecificText"><span class="cs">()</span><span class="cpp">()</span><span class="nu">()</span></span></a> (that is, there are processes currently
|
|
using the environment), Remove fails without further action.
|
|
</p>
|
|
<p>
|
|
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 <a href="F_BerkeleyDB_DatabaseEnvironmentConfig_SystemMemory.htm">SystemMemory</a> was
|
|
specified to <a href="M_BerkeleyDB_DatabaseEnvironment_Open.htm">Open(String, DatabaseEnvironmentConfig)</a>, 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.
|
|
</p>
|
|
<p>
|
|
In multithreaded applications, only a single thread may call Remove.
|
|
</p>
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_DatabaseEnvironment_RemoveDB.htm">RemoveDB</a></td><td>Overloaded. </td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_RemoveUnusedLogFiles.htm">RemoveUnusedLogFiles</a></td><td><div class="summary">
|
|
Remove log files that are no longer needed. Automatic log file
|
|
removal is likely to make catastrophic recovery impossible.
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_DatabaseEnvironment_RenameDB.htm">RenameDB</a></td><td>Overloaded. </td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_DatabaseEnvironment_RepHoldElection.htm">RepHoldElection</a></td><td>Overloaded. <div class="summary">
|
|
<p>
|
|
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.
|
|
</p>
|
|
<p>
|
|
If the election is successful, Berkeley DB notifies the
|
|
application of the results of the election by means of either the
|
|
<a href="T_BerkeleyDB_NotificationEvent.htm">REP_ELECTED</a> or
|
|
<a href="T_BerkeleyDB_NotificationEvent.htm">REP_NEWMASTER</a> events (see
|
|
<a href="P_BerkeleyDB_DatabaseEnvironment_EventNotify.htm">EventNotify</a>for 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.
|
|
</p>
|
|
<p>
|
|
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.
|
|
</p>
|
|
<p>
|
|
Before calling this method, the <a href="P_BerkeleyDB_DatabaseEnvironment_RepTransport.htm">RepTransport</a> delegate
|
|
must already have been configured to send replication messages.
|
|
</p>
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_DatabaseEnvironment_ReplicationSystemStats.htm">ReplicationSystemStats</a></td><td>Overloaded. </td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_RepMgrChannel.htm">RepMgrChannel</a></td><td><div class="summary">
|
|
Create DbChannel with given eid.
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_RepmgrSetIncomingQueueMax.htm">RepmgrSetIncomingQueueMax</a></td><td><div class="summary">
|
|
Set a byte-count limit on the maximum amount of dynamic memory
|
|
used by the Replication Manager incoming queue.
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_DatabaseEnvironment_RepMgrSite.htm">RepMgrSite</a></td><td>Overloaded. </td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_RepMgrSiteConfig.htm">RepMgrSiteConfig</a></td><td><div class="summary">
|
|
Configure a site in the replication manager.
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_DatabaseEnvironment_RepMgrStartClient.htm">RepMgrStartClient</a></td><td>Overloaded. <div class="summary">
|
|
<p>
|
|
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:
|
|
</p>
|
|
<ol><li>
|
|
Configure the local site in the replication group,
|
|
<a href="P_BerkeleyDB_DatabaseEnvironment_RepMgrLocalSite.htm">RepMgrLocalSite</a>.
|
|
</li><li>
|
|
Call <a href="M_BerkeleyDB_DatabaseEnvironment_RepMgrSiteConfig.htm">RepMgrSiteConfig(DbSiteConfig)</a> to configure the remote
|
|
site(s) in the replication group.
|
|
</li><li>Configure the message acknowledgment policy
|
|
(<a href="P_BerkeleyDB_DatabaseEnvironment_RepMgrAckPolicy.htm">RepMgrAckPolicy</a>) which provides the replication group's
|
|
transactional needs.
|
|
</li><li>
|
|
Configure the local site's election priority,
|
|
<a href="P_BerkeleyDB_DatabaseEnvironment_RepPriority.htm">RepPriority</a>.
|
|
</li><li>
|
|
Call <a href="M_BerkeleyDB_DatabaseEnvironment_RepMgrStartClient.htm">RepMgrStartClient(Int32)</a> or
|
|
<a href="M_BerkeleyDB_DatabaseEnvironment_RepMgrStartMaster.htm">RepMgrStartMaster(Int32)</a> to start the replication
|
|
application.
|
|
</li></ol>
|
|
<p>
|
|
For more information on building replication manager applications,
|
|
please see the Replication Getting Started Guide included in the
|
|
Berkeley DB documentation.
|
|
</p>
|
|
<p>
|
|
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.
|
|
</p>
|
|
<p>
|
|
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; <a href="M_BerkeleyDB_DatabaseEnvironment_RepMgrStartClient.htm">RepMgrStartClient(Int32)</a> (and
|
|
<a href="M_BerkeleyDB_DatabaseEnvironment_RepMgrStartMaster.htm">RepMgrStartMaster(Int32)</a>) automatically open the socket in
|
|
the first process to call it, and skips this step in the later calls
|
|
from other processes.
|
|
</p>
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_RepMgrStartMaster.htm">RepMgrStartMaster</a></td><td><div class="summary">
|
|
Start the replication manager as a master site, and do not call for
|
|
an election.
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_DatabaseEnvironment_RepMgrSystemStats.htm">RepMgrSystemStats</a></td><td>Overloaded. </td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_RepProcessMessage.htm">RepProcessMessage</a></td><td><div class="summary">
|
|
Process an incoming replication message sent by a member of the
|
|
replication group to the local database environment.
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_RepSetClockskew.htm">RepSetClockskew</a></td><td><div class="summary">
|
|
Set the clock skew ratio among replication group members based on
|
|
the fastest and slowest measurements among the group for use with
|
|
master leases.
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_RepSetRetransmissionRequest.htm">RepSetRetransmissionRequest</a></td><td><div class="summary">
|
|
Set a threshold for the minimum and maximum time that a client waits
|
|
before requesting retransmission of a missing message.
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_RepSetTransmitLimit.htm">RepSetTransmitLimit</a></td><td><div class="summary">
|
|
Set a byte-count limit on the amount of data that is
|
|
transmitted from a site in response to a single message processed by
|
|
<a href="M_BerkeleyDB_DatabaseEnvironment_RepProcessMessage.htm">RepProcessMessage(DatabaseEntry, DatabaseEntry, Int32)</a>. The limit is not a hard limit, and
|
|
the record that exceeds the limit is the last record to be sent.
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_RepSetTransport.htm">RepSetTransport</a></td><td><div class="summary">
|
|
Initialize the communication infrastructure for a database
|
|
environment participating in a replicated application.
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_DatabaseEnvironment_RepStartClient.htm">RepStartClient</a></td><td>Overloaded. <div class="summary">
|
|
<p>
|
|
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.
|
|
</p>
|
|
<p>
|
|
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.
|
|
</p>
|
|
<p>
|
|
Before calling this method, the <a href="P_BerkeleyDB_DatabaseEnvironment_RepTransport.htm">RepTransport</a> delegate
|
|
must already have been configured to send replication messages.
|
|
</p>
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_DatabaseEnvironment_RepStartMaster.htm">RepStartMaster</a></td><td>Overloaded. <div class="summary">
|
|
<p>
|
|
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.
|
|
</p>
|
|
<p>
|
|
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.
|
|
</p>
|
|
<p>
|
|
Before calling this method, the <a href="P_BerkeleyDB_DatabaseEnvironment_RepTransport.htm">RepTransport</a> delegate
|
|
must already have been configured to send replication messages.
|
|
</p>
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_RepSync.htm">RepSync</a></td><td><div class="summary">
|
|
Force master synchronization to begin for this client.
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_ResetFileID.htm">ResetFileID</a></td><td><div class="summary">
|
|
Allow database files to be copied and used in the same database
|
|
environment as the original.
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_ResetLSN.htm">ResetLSN</a></td><td><div class="summary">
|
|
Allow database files to be moved from one transactional database
|
|
environment to another.
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_SetMaxSequentialWrites.htm">SetMaxSequentialWrites</a></td><td><div class="summary">
|
|
Limit the number of sequential write operations scheduled by the
|
|
library when flushing dirty pages from the cache.
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_DatabaseEnvironment_SyncMemPool.htm">SyncMemPool</a></td><td>Overloaded. </td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/7bxwbwt2" target="_blank">ToString</a></td><td><div class="summary">
|
|
Returns a <a href="http://msdn2.microsoft.com/en-us/library/s1wwdcbf" target="_blank">String</a> that represents the current <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.
|
|
</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_DatabaseEnvironment_TransactionSystemStats.htm">TransactionSystemStats</a></td><td>Overloaded. </td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_DatabaseEnvironment_TrickleCleanMemPool.htm">TrickleCleanMemPool</a></td><td><div class="summary">
|
|
Ensure that a specified percent of the pages in the cache are clean,
|
|
by writing dirty pages to their backing files.
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_DatabaseEnvironment_WriteToLog.htm">WriteToLog</a></td><td>Overloaded. <div class="summary">
|
|
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.
|
|
</div><div class="summary">
|
|
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.
|
|
</div></td></tr></table></div><h1 class="heading"><span onclick="ExpandCollapse(seeAlsoToggle)" style="cursor:default;" onkeypress="ExpandCollapse_CheckKey(seeAlsoToggle, event)" tabindex="0"><img id="seeAlsoToggle" class="toggle" name="toggleSwitch" src="../icons/collapse_all.gif" />See Also</span></h1><div id="seeAlsoSection" class="section" name="collapseableSection" style=""><div class="seeAlsoStyle"><a href="T_BerkeleyDB_DatabaseEnvironment.htm">DatabaseEnvironment Class</a></div><div class="seeAlsoStyle"><a href="N_BerkeleyDB.htm">BerkeleyDB Namespace</a></div></div></div><div id="footer"><div class="footerLine"><img width="100%" height="3px" src="../icons/footer.gif" title="Footer image" /></div><A NAME="feedback"></A><span id="fb" class="feedbackcss"> </span>
|
|
Report Feedback on this item in the Oracle Technology Network Forum <p />Copyright (c) 2008, 2016 Oracle. All rights reserved.</div></div></body></html>
|