docs/csharp/html/M_BerkeleyDB_DatabaseEnvironment_Backup.htm

   1 <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>Backup Method </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="M_BerkeleyDB_DatabaseEnvironment_Backup" /><meta name="guid" content="M_BerkeleyDB_DatabaseEnvironment_Backup" /><xml><MSHelp:Attr Name="AssetID" Value="M:BerkeleyDB.DatabaseEnvironment.Backup(System.String,BerkeleyDB.BackupOptions)" /><MSHelp:TOCTitle Title="Backup Method " /><MSHelp:RLTitle Title="DatabaseEnvironment.Backup Method  (BerkeleyDB)" /><MSHelp:Keyword Index="A" Term="M:BerkeleyDB.DatabaseEnvironment.Backup(System.String,BerkeleyDB.BackupOptions)" /><MSHelp:Keyword Index="A" Term="frlrfBerkeleyDBDatabaseEnvironmentClassBackupTopic" /><MSHelp:Keyword Index="K" Term="Backup method" /><MSHelp:Keyword Index="K" Term="DatabaseEnvironment.Backup method" /><MSHelp:Keyword Index="F" Term="Backup" /><MSHelp:Keyword Index="F" Term="DatabaseEnvironment.Backup" /><MSHelp:Keyword Index="F" Term="BerkeleyDB.DatabaseEnvironment.Backup" /><MSHelp:Attr Name="APIType" Value="Managed" /><MSHelp:Attr Name="APILocation" Value="libdb_dotnet53.dll" /><MSHelp:Attr Name="APIName" Value="BerkeleyDB.DatabaseEnvironment.Backup" /><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="Abstract" Value="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 fi ..." /><MSHelp:Attr Name="AssemblyVersion" Value="5.3.21.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></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><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<span class="languageSpecificText"><span class="cs">.</span><span class="vb">.</span><span class="cpp">::</span><span class="nu">.</span></span>Backup Method </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>  \r
   2   <span id="headfeedbackarea" class="feedbackhead">\r
   3       <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');">\r
   4         \r
   5         Send Feedback\r
   6       </a>\r
   7         </span>\r
   8 </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><div class="summary">\r
   9             Perform a hot back up of the open environment.\r
  10             <p>\r
  11             All files used by the environment are backed up, so long as the \r
  12             normal rules for file placement are followed. For information on how\r
  13             files are normally placed relative to the environment directory, see\r
  14             the "Berkeley DB File Naming" section in the Berkeley DB Reference \r
  15             Guide.\r
  16             </p><p>\r
  17             By default, data directories and the log directory specified \r
  18             relative to the home directory will be recreated relative to the \r
  19             target directory. If absolute path names are used, then use the \r
  20             <a href="F_BerkeleyDB_BackupOptions_SingleDir.htm">SingleDir</a> method.\r
  21             </p><p>\r
  22             This method provides the same functionality as the db_hotbackup\r
  23             utility.  However, this method does not perform the housekeeping\r
  24             actions performed by that utility. In particular, you may want to\r
  25             run a checkpoint before calling this method. To run a checkpoint, \r
  26             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 \r
  27             more information on checkpoints, see the "Checkpoint" section in the\r
  28             Berkeley DB Reference Guide.\r
  29             </p><p>\r
  30             To back up a single database file within the environment, use the\r
  31             <a href="M_BerkeleyDB_DatabaseEnvironment_BackupDatabase.htm">BackupDatabase(String, String, Boolean)</a> method.\r
  32             </p><p>\r
  33             In addition to the configuration options available using the \r
  34             <a href="T_BerkeleyDB_BackupOptions.htm">BackupOptions</a> class, additional tuning modifications \r
  35             can be made using the <a href="P_BerkeleyDB_DatabaseEnvironment_BackupReadCount.htm">BackupReadCount</a>,\r
  36             <a href="P_BerkeleyDB_DatabaseEnvironment_BackupReadSleepDuration.htm">BackupReadSleepDuration</a>,\r
  37             <a href="P_BerkeleyDB_DatabaseEnvironment_BackupBufferSize.htm">BackupBufferSize</a>, and\r
  38             <a href="P_BerkeleyDB_DatabaseEnvironment_BackupWriteDirect.htm">BackupWriteDirect</a> properties. \r
  39             Alternatively, you can write your own custom hot back up facility \r
  40             using the <a href="T_BerkeleyDB_IBackup.htm">IBackup</a> interface.\r
  41             </p></div><p />\r
  42     <b>Namespace:</b> \r
  43    <a href="N_BerkeleyDB.htm">BerkeleyDB</a><br />\r
  44     <b>Assembly:</b>\r
  45    <span sdata="assembly">libdb_dotnet53</span> (in libdb_dotnet53.dll) Version: 5.3.21.0<h1 class="heading"><span onclick="ExpandCollapse(syntaxToggle)" style="cursor:default;" onkeypress="ExpandCollapse_CheckKey(syntaxToggle, event)" tabindex="0"><img id="syntaxToggle" class="toggle" name="toggleSwitch" src="../icons/collapse_all.gif" />Syntax</span></h1><div id="syntaxSection" class="section" name="collapseableSection" style=""><div id="syntaxCodeBlocks" class="code"><span codeLanguage="CSharp"><table><tr><th>C#</th></tr><tr><td><pre xml:space="preserve"><span class="keyword">public</span> <span class="keyword">void</span> <span class="identifier">Backup</span>(\r
  46         <a href="http://msdn2.microsoft.com/en-us/library/s1wwdcbf" target="_blank">string</a> <span class="parameter">target</span>,\r
  47         <a href="T_BerkeleyDB_BackupOptions.htm">BackupOptions</a> <span class="parameter">opt</span>\r
  48 )</pre></td></tr></table></span><span codeLanguage="VisualBasicDeclaration"><table><tr><th>Visual Basic (Declaration)</th></tr><tr><td><pre xml:space="preserve"><span class="keyword">Public</span> <span class="keyword">Sub</span> <span class="identifier">Backup</span> ( _\r
  49         <span class="parameter">target</span> <span class="keyword">As</span> <a href="http://msdn2.microsoft.com/en-us/library/s1wwdcbf" target="_blank">String</a>, _\r
  50         <span class="parameter">opt</span> <span class="keyword">As</span> <a href="T_BerkeleyDB_BackupOptions.htm">BackupOptions</a> _\r
  51 )</pre></td></tr></table></span><span codeLanguage="ManagedCPlusPlus"><table><tr><th>Visual C++</th></tr><tr><td><pre xml:space="preserve"><span class="keyword">public</span>:\r
  52 <span class="keyword">void</span> <span class="identifier">Backup</span>(\r
  53         <a href="http://msdn2.microsoft.com/en-us/library/s1wwdcbf" target="_blank">String</a>^ <span class="parameter">target</span>, \r
  54         <a href="T_BerkeleyDB_BackupOptions.htm">BackupOptions</a>^ <span class="parameter">opt</span>\r
  55 )</pre></td></tr></table></span></div><div id="parameters"><h4 class="subHeading">Parameters</h4><dl paramName="target"><dt><span class="parameter">target</span></dt><dd>Type: <a href="http://msdn2.microsoft.com/en-us/library/s1wwdcbf" target="_blank">System<span class="languageSpecificText"><span class="cs">.</span><span class="vb">.</span><span class="cpp">::</span><span class="nu">.</span></span>String</a><br />Identifies the directory in which the back up \r
  56             will be placed. Any subdirectories required to contain the back up\r
  57             must be placed relative to this directory. Note that if an \r
  58             <a href="T_BerkeleyDB_IBackup.htm">IBackup</a> is configured for the environment, then the\r
  59             value specified to this parameter is passed on to the \r
  60             <a href="M_BerkeleyDB_IBackup_Open.htm">Open(String, String)</a> method.  If this parameter is null, then\r
  61             the target must be specified to the <a href="M_BerkeleyDB_IBackup_Open.htm">Open(String, String)</a>\r
  62             method.\r
  63             <p>\r
  64             This directory, and any required subdirectories, will be created for\r
  65             you if you specify <a href="T_BerkeleyDB_CreatePolicy.htm">IF_NEEDED</a> or \r
  66             <a href="T_BerkeleyDB_CreatePolicy.htm">ALWAYS</a> for the \r
  67             <a href="F_BerkeleyDB_BackupOptions_Creation.htm">Creation</a> property.\r
  68             </p></dd></dl><dl paramName="opt"><dt><span class="parameter">opt</span></dt><dd>Type: <a href="T_BerkeleyDB_BackupOptions.htm">BerkeleyDB<span class="languageSpecificText"><span class="cs">.</span><span class="vb">.</span><span class="cpp">::</span><span class="nu">.</span></span>BackupOptions</a><br />The <a href="T_BerkeleyDB_BackupOptions.htm">BackupOptions</a> instance used to\r
  69             configure the hot back up.</dd></dl></div></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>\r
  70 Report Feedback on this item in the Oracle Technology Network Forum <p />Copyright (c) 2008, 2012 Oracle. All rights reserved.</div></div></body></html>