| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.3"/> |
| <title>Lucene.Net: Lucene.Net.Index.SnapshotDeletionPolicy Class Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/search.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { searchBox.OnSelectItem(0); }); |
| </script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectlogo"><img alt="Logo" src="lucene-net-icon-128x128.png"/></td> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname">Lucene.Net |
|  <span id="projectnumber">3.0.3</span> |
| </div> |
| <div id="projectbrief">Lucene.Net is a .NET port of the Java Lucene Indexing Library</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.3 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="Index.html"><span>Main Page</span></a></li> |
| <li><a href="namespaces.html"><span>Packages</span></a></li> |
| <li class="current"><a href="annotated.html"><span>Classes</span></a></li> |
| <li><a href="files.html"><span>Files</span></a></li> |
| <li> |
| <div id="MSearchBox" class="MSearchBoxInactive"> |
| <span class="left"> |
| <img id="MSearchSelect" src="search/mag_sel.png" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| alt=""/> |
| <input type="text" id="MSearchField" value="Search" accesskey="S" |
| onfocus="searchBox.OnSearchFieldFocus(true)" |
| onblur="searchBox.OnSearchFieldFocus(false)" |
| onkeyup="searchBox.OnSearchFieldChange(event)"/> |
| </span><span class="right"> |
| <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> |
| </span> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div id="navrow2" class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="annotated.html"><span>Class List</span></a></li> |
| <li><a href="classes.html"><span>Class Index</span></a></li> |
| <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.html"><span>Class Members</span></a></li> |
| </ul> |
| </div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Properties</a></div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespace_lucene.html">Lucene</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net.html">Net</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_index.html">Index</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_snapshot_deletion_policy.html">SnapshotDeletionPolicy</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="class_lucene_1_1_net_1_1_index_1_1_snapshot_deletion_policy-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Index.SnapshotDeletionPolicy Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_index_deletion_policy.html" title="Expert: policy for deletion of stale index commits.">IndexDeletionPolicy</a> that wraps around any other <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_index_deletion_policy.html" title="Expert: policy for deletion of stale index commits.">IndexDeletionPolicy</a> and adds the ability to hold and later release a single "snapshot" of an index. While the snapshot is held, the <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_writer.html" title="An IndexWriter creates and maintains an index. The create argument to the constructor determines whet...">IndexWriter</a> will not remove any files associated with it even if the index is otherwise being actively, arbitrarily changed. Because we wrap another arbitrary <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_index_deletion_policy.html" title="Expert: policy for deletion of stale index commits.">IndexDeletionPolicy</a>, this gives you the freedom to continue using whatever <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_index_deletion_policy.html" title="Expert: policy for deletion of stale index commits.">IndexDeletionPolicy</a> you would normally want to use with your index. Note that you can re-use a single instance of <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_snapshot_deletion_policy.html" title="A IndexDeletionPolicy that wraps around any other IndexDeletionPolicy and adds the ability to hold an...">SnapshotDeletionPolicy</a> across multiple writers as long as they are against the same index Directory. Any snapshot held when a writer is closed will "survive" when the next writer is opened. |
| <a href="class_lucene_1_1_net_1_1_index_1_1_snapshot_deletion_policy.html#details">More...</a></p> |
| |
| <p>Inherits <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_index_deletion_policy.html">Lucene.Net.Index.IndexDeletionPolicy</a>.</p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:adfd3196b2be9c745bba4c93dcda47efd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_snapshot_deletion_policy.html#adfd3196b2be9c745bba4c93dcda47efd">SnapshotDeletionPolicy</a> (<a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_index_deletion_policy.html">IndexDeletionPolicy</a> primary)</td></tr> |
| <tr class="separator:adfd3196b2be9c745bba4c93dcda47efd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acd222cd7383e88ccbcb151af8c8c5826"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_snapshot_deletion_policy.html#acd222cd7383e88ccbcb151af8c8c5826">OnInit< T ></a> (IList< T > commits)</td></tr> |
| <tr class="memdesc:acd222cd7383e88ccbcb151af8c8c5826"><td class="mdescLeft"> </td><td class="mdescRight">This is called once when a writer is first instantiated to give the policy a chance to remove old commit points. <a href="#acd222cd7383e88ccbcb151af8c8c5826"></a><br/></td></tr> |
| <tr class="separator:acd222cd7383e88ccbcb151af8c8c5826"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac1c9a28aca785e3a0f462a0948b8444f"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_snapshot_deletion_policy.html#ac1c9a28aca785e3a0f462a0948b8444f">OnCommit< T ></a> (IList< T > commits)</td></tr> |
| <tr class="memdesc:ac1c9a28aca785e3a0f462a0948b8444f"><td class="mdescLeft"> </td><td class="mdescRight"> <a href="#ac1c9a28aca785e3a0f462a0948b8444f"></a><br/></td></tr> |
| <tr class="separator:ac1c9a28aca785e3a0f462a0948b8444f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a30061ef8caae9b9c71b9ff5acbce98a2"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_commit.html">IndexCommit</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_snapshot_deletion_policy.html#a30061ef8caae9b9c71b9ff5acbce98a2">Snapshot</a> ()</td></tr> |
| <tr class="memdesc:a30061ef8caae9b9c71b9ff5acbce98a2"><td class="mdescLeft"> </td><td class="mdescRight">Take a snapshot of the most recent commit to the index. You must call release() to free this snapshot. Note that while the snapshot is held, the files it references will not be deleted, which will consume additional disk space in your index. If you take a snapshot at a particularly bad time (say just before you call optimize()) then in the worst case this could consume an extra 1X of your total index size, until you release the snapshot. <a href="#a30061ef8caae9b9c71b9ff5acbce98a2"></a><br/></td></tr> |
| <tr class="separator:a30061ef8caae9b9c71b9ff5acbce98a2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7466c765b1e3112a702919349e53b62b"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_snapshot_deletion_policy.html#a7466c765b1e3112a702919349e53b62b">Release</a> ()</td></tr> |
| <tr class="memdesc:a7466c765b1e3112a702919349e53b62b"><td class="mdescLeft"> </td><td class="mdescRight">Release the currently held snapshot. <a href="#a7466c765b1e3112a702919349e53b62b"></a><br/></td></tr> |
| <tr class="separator:a7466c765b1e3112a702919349e53b62b"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>A <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_index_deletion_policy.html" title="Expert: policy for deletion of stale index commits.">IndexDeletionPolicy</a> that wraps around any other <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_index_deletion_policy.html" title="Expert: policy for deletion of stale index commits.">IndexDeletionPolicy</a> and adds the ability to hold and later release a single "snapshot" of an index. While the snapshot is held, the <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_writer.html" title="An IndexWriter creates and maintains an index. The create argument to the constructor determines whet...">IndexWriter</a> will not remove any files associated with it even if the index is otherwise being actively, arbitrarily changed. Because we wrap another arbitrary <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_index_deletion_policy.html" title="Expert: policy for deletion of stale index commits.">IndexDeletionPolicy</a>, this gives you the freedom to continue using whatever <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_index_deletion_policy.html" title="Expert: policy for deletion of stale index commits.">IndexDeletionPolicy</a> you would normally want to use with your index. Note that you can re-use a single instance of <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_snapshot_deletion_policy.html" title="A IndexDeletionPolicy that wraps around any other IndexDeletionPolicy and adds the ability to hold an...">SnapshotDeletionPolicy</a> across multiple writers as long as they are against the same index Directory. Any snapshot held when a writer is closed will "survive" when the next writer is opened. </p> |
| <p><b>WARNING</b>: This API is a new and experimental and may suddenly change.</p> |
| |
| <p>Definition at line <a class="el" href="_snapshot_deletion_policy_8cs_source.html#l00044">44</a> of file <a class="el" href="_snapshot_deletion_policy_8cs_source.html">SnapshotDeletionPolicy.cs</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="adfd3196b2be9c745bba4c93dcda47efd"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Index.SnapshotDeletionPolicy.SnapshotDeletionPolicy </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_index_deletion_policy.html">IndexDeletionPolicy</a> </td> |
| <td class="paramname"><em>primary</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_snapshot_deletion_policy_8cs_source.html#l00051">51</a> of file <a class="el" href="_snapshot_deletion_policy_8cs_source.html">SnapshotDeletionPolicy.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="ac1c9a28aca785e3a0f462a0948b8444f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void Lucene.Net.Index.SnapshotDeletionPolicy.OnCommit< T > </td> |
| <td>(</td> |
| <td class="paramtype">IList< T > </td> |
| <td class="paramname"><em>commits</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p></p> |
| <p>This is called each time the writer completed a commit. This gives the policy a chance to remove old commit points with each commit.</p> |
| <p>The policy may now choose to delete old commit points by calling method <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_commit.html#aff47e6a2b3b8fca0b391a4ed4a19347e" title="Delete this commit point. This only applies when using the commit point in the context of IndexWriter...">IndexCommit.Delete()</a> of <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_commit.html" title="Expert: represents a single commit into an index as seen by the IndexDeletionPolicy or IndexReader...">IndexCommit</a>.</p> |
| <p>This method is only called when <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_writer.html#ad1df12452bb45f153d9d06e1c160e2ff" title="Commits all pending changes (added & deleted documents, optimizations, segment merges, added indexes, etc.) to the index, and syncs all referenced index files, such that a reader will see the changes and the index updates will survive an OS or machine crash or power loss. Note that this does not wait for any running background merges to finish. This may be a costly operation, so you should test the cost in your application and do it only when really necessary.">IndexWriter.Commit()</a> or <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_writer.html#abe4383aeee76431a2b30b10e5ffb4b87" title="Commits all changes to an index and closes all associated files. Note that this may be a costly opera...">IndexWriter.Close()</a> is called, or possibly not at all if the <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_writer.html#a6585064853f33355bf4b450ec88fd727" title="Close the IndexWriter without committing any changes that have occurred since the last commit (or sin...">IndexWriter.Rollback()</a> is called.</p> |
| <p><u>Note:</u> the last CommitPoint is the most recent one, i.e. the "front index state". Be careful not to delete it, unless you know for sure what you are doing, and unless you can afford to lose the index content while doing that.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">commits</td><td>List of <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_commit.html" title="Expert: represents a single commit into an index as seen by the IndexDeletionPolicy or IndexReader...">IndexCommit</a>, sorted by age (the 0th one is the oldest commit). </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implements <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_index_deletion_policy.html#ae76463710c22a8e4ee337f22ac11a680">Lucene.Net.Index.IndexDeletionPolicy</a>.</p> |
| <div class="typeconstraint"> |
| <dl><dt><b>Type Constraints</b><dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"><em>T</em></td><td> :</td><td valign="top"><em>IndexCommit</em></td><td> </td></tr> |
| </table> |
| </dl> |
| </div> |
| |
| <p>Definition at line <a class="el" href="_snapshot_deletion_policy_8cs_source.html#l00065">65</a> of file <a class="el" href="_snapshot_deletion_policy_8cs_source.html">SnapshotDeletionPolicy.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="acd222cd7383e88ccbcb151af8c8c5826"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void Lucene.Net.Index.SnapshotDeletionPolicy.OnInit< T > </td> |
| <td>(</td> |
| <td class="paramtype">IList< T > </td> |
| <td class="paramname"><em>commits</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>This is called once when a writer is first instantiated to give the policy a chance to remove old commit points.</p> |
| <p>The writer locates all index commits present in the index directory and calls this method. The policy may choose to delete some of the commit points, doing so by calling method <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_commit.html#aff47e6a2b3b8fca0b391a4ed4a19347e" title="Delete this commit point. This only applies when using the commit point in the context of IndexWriter...">IndexCommit.Delete()</a> of <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_commit.html" title="Expert: represents a single commit into an index as seen by the IndexDeletionPolicy or IndexReader...">IndexCommit</a>.</p> |
| <p><u>Note:</u> the last CommitPoint is the most recent one, i.e. the "front index state". Be careful not to delete it, unless you know for sure what you are doing, and unless you can afford to lose the index content while doing that.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">commits</td><td>List of current <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_commit.html">point-in-time commits</a>, sorted by age (the 0th one is the oldest commit). </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implements <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_index_deletion_policy.html#ae7b18e03b1a5b492c34e0bd88ae66ccf">Lucene.Net.Index.IndexDeletionPolicy</a>.</p> |
| <div class="typeconstraint"> |
| <dl><dt><b>Type Constraints</b><dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"><em>T</em></td><td> :</td><td valign="top"><em>IndexCommit</em></td><td> </td></tr> |
| </table> |
| </dl> |
| </div> |
| |
| <p>Definition at line <a class="el" href="_snapshot_deletion_policy_8cs_source.html#l00056">56</a> of file <a class="el" href="_snapshot_deletion_policy_8cs_source.html">SnapshotDeletionPolicy.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a7466c765b1e3112a702919349e53b62b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void Lucene.Net.Index.SnapshotDeletionPolicy.Release </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Release the currently held snapshot. </p> |
| |
| <p>Definition at line <a class="el" href="_snapshot_deletion_policy_8cs_source.html#l00102">102</a> of file <a class="el" href="_snapshot_deletion_policy_8cs_source.html">SnapshotDeletionPolicy.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a30061ef8caae9b9c71b9ff5acbce98a2"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_commit.html">IndexCommit</a> Lucene.Net.Index.SnapshotDeletionPolicy.Snapshot </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Take a snapshot of the most recent commit to the index. You must call release() to free this snapshot. Note that while the snapshot is held, the files it references will not be deleted, which will consume additional disk space in your index. If you take a snapshot at a particularly bad time (say just before you call optimize()) then in the worst case this could consume an extra 1X of your total index size, until you release the snapshot. </p> |
| |
| <p>Definition at line <a class="el" href="_snapshot_deletion_policy_8cs_source.html#l00084">84</a> of file <a class="el" href="_snapshot_deletion_policy_8cs_source.html">SnapshotDeletionPolicy.cs</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>core/Index/<a class="el" href="_snapshot_deletion_policy_8cs_source.html">SnapshotDeletionPolicy.cs</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 3 2013 02:12:55 for Lucene.Net by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.3 |
| </small></address> |
| </body> |
| </html> |
