<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>BTreeDatabase 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_BTreeDatabase" /><meta name="guid" content="Methods_T_BerkeleyDB_BTreeDatabase" /><xml><MSHelp:Attr Name="AssetID" Value="Methods.T:BerkeleyDB.BTreeDatabase" /><MSHelp:TOCTitle Title="BTreeDatabase Methods " /><MSHelp:RLTitle Title="BTreeDatabase Methods (BerkeleyDB)" /><MSHelp:Keyword Index="A" Term="Methods.T:BerkeleyDB.BTreeDatabase" /><MSHelp:Keyword Index="A" Term="frlrfBerkeleyDBBTreeDatabaseMethodsTopic" /><MSHelp:Keyword Index="K" Term="BTreeDatabase 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="4.8.24.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">BTreeDatabase Methods </span></td></tr><tr id="headerTableRow3"><td align="left"><a href="T_BerkeleyDB_BTreeDatabase.htm">BTreeDatabase Class</a> <a href="#seeAlsoToggle" onclick="OpenSection(seeAlsoToggle)">See Also</a>
<span id="headfeedbackarea" class="feedbackhead">
<a href="javascript:SubmitFeedback('','','','','','','Customer%20Feedback');">
</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_BTreeDatabase.htm">BTreeDatabase</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;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_BTreeDatabase_Close.htm">Close</a></td><td>Overloaded. <div class="summary">
<p>
Although closing a database will close 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 will not happen if you close a database
while cursors are still opened.
</p>
<p>
The same rule, for the same reasons, hold true for
<a href="T_BerkeleyDB_Transaction.htm">Transaction</a> objects. Simply make sure you resolve
all your transaction objects before closing your database handle.
</p>
<p>
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 <a href="M_BerkeleyDB_BaseDatabase_Sync.htm">Sync<span class="languageSpecificText"><span class="cs">()</span><span class="cpp">()</span><span class="nu">()</span></span></a> before exiting, to
ensure that any data cached in main memory are reflected in the
underlying file system.
</p>
<p>
When called on a database that is the primary database for a
secondary index, the primary database should be closed only after
all secondary indices referencing it have been closed.
</p>
<p>
When multiple threads are using the object concurrently, only a
single thread may call the Close method.
</p>
<p>
The object may not be accessed again after Close is called,
regardless of its outcome.
</p>
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_BTreeDatabase_Compact.htm">Compact</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_BTreeDatabase_Cursor.htm">Cursor</a></td><td>Overloaded. </td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_BTreeDatabase_Delete.htm">Delete</a></td><td>Overloaded. </td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_BaseDatabase_Dispose.htm">Dispose</a></td><td><div class="summary">
Release the resources held by this object, and close the database if
it's still open.
</div> (Inherited from <a href="T_BerkeleyDB_BaseDatabase.htm">BaseDatabase</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/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;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_BTreeDatabase_Exists.htm">Exists</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_BTreeDatabase_FastStats.htm">FastStats</a></td><td>Overloaded. <div class="summary">
<p>
Among other things, this method makes it possible for applications
to request key and record counts without incurring the performance
penalty of traversing the entire database.
</p>
<p>
The statistical information is described by the
<a href="T_BerkeleyDB_BTreeStats.htm">BTreeStats</a>, <a href="T_BerkeleyDB_HashStats.htm">HashStats</a>,
<a href="T_BerkeleyDB_QueueStats.htm">QueueStats</a>, and <a href="T_BerkeleyDB_RecnoStats.htm">RecnoStats</a> classes.
</p>
</div></td></tr><tr data="public;declared;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_BTreeDatabase_Get.htm">Get</a></td><td>Overloaded. </td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_BTreeDatabase_GetBoth.htm">GetBoth</a></td><td>Overloaded. </td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_BTreeDatabase_GetBothMultiple.htm">GetBothMultiple</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/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;declared;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_BTreeDatabase_GetMultiple.htm">GetMultiple</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/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;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_Database_Join.htm">Join</a></td><td><div class="summary">
Create a specialized join cursor for use in performing equality or
natural joins on secondary indices.
</div> (Inherited from <a href="T_BerkeleyDB_Database.htm">Database</a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_BTreeDatabase_KeyRange.htm">KeyRange</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="Overload_BerkeleyDB_BTreeDatabase_Open.htm">Open</a></td><td>Overloaded. </td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_BTreeDatabase_PrintFastStats.htm">PrintFastStats</a></td><td>Overloaded. <div class="summary">
The statistical information is described by the
<a href="T_BerkeleyDB_BTreeStats.htm">BTreeStats</a>, <a href="T_BerkeleyDB_HashStats.htm">HashStats</a>,
<a href="T_BerkeleyDB_QueueStats.htm">QueueStats</a>, and <a href="T_BerkeleyDB_RecnoStats.htm">RecnoStats</a> classes.
</div></td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_BTreeDatabase_PrintStats.htm">PrintStats</a></td><td>Overloaded. <div class="summary">
The statistical information is described by the
<a href="T_BerkeleyDB_BTreeStats.htm">BTreeStats</a>, <a href="T_BerkeleyDB_HashStats.htm">HashStats</a>,
<a href="T_BerkeleyDB_QueueStats.htm">QueueStats</a>, and <a href="T_BerkeleyDB_RecnoStats.htm">RecnoStats</a> classes.
</div></td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_BTreeDatabase_Put.htm">Put</a></td><td>Overloaded. <div class="summary">
<p>
If the database supports duplicates, add the new data value at the
end of the duplicate set. If the database supports sorted
duplicates, the new data value is inserted at the correct sorted
location.
</p>
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_BTreeDatabase_PutNoDuplicate.htm">PutNoDuplicate</a></td><td>Overloaded. </td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_BTreeDatabase_PutNoOverwrite.htm">PutNoOverwrite</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_BTreeDatabase_Stats.htm">Stats</a></td><td>Overloaded. <div class="summary">
The statistical information is described by
<a href="T_BerkeleyDB_BTreeStats.htm">BTreeStats</a>.
</div></td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="M_BerkeleyDB_BaseDatabase_Sync.htm">Sync</a></td><td><div class="summary">
Flush any cached information to disk.
</div> (Inherited from <a href="T_BerkeleyDB_BaseDatabase.htm">BaseDatabase</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/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;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_BTreeDatabase_Truncate.htm">Truncate</a></td><td>Overloaded. <div class="summary">
When called on a database configured with secondary indices,
Truncate will truncate the primary database and all secondary
indices. A count of the records discarded from the primary database
is returned.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" title="Public method" /></td><td><a href="Overload_BerkeleyDB_BTreeDatabase_TruncateUnusedPages.htm">TruncateUnusedPages</a></td><td>Overloaded. </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_BTreeDatabase.htm">BTreeDatabase 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" style="display: none;"> </span>
Report Feedback on this item in the Oracle Technology Network Forum <p />Copyright (c) 1996-2009 Oracle. All rights reserved.</div></div></body></html>
