| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class PersistentSnapshotDeletionPolicy |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class PersistentSnapshotDeletionPolicy |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation "> |
| <meta name="generator" content="docfx 2.56.0.0"> |
| |
| <link rel="shortcut icon" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/favicon.ico"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.css"> |
| <meta property="docfx:navrel" content="toc.html"> |
| <meta property="docfx:tocrel" content="core/toc.html"> |
| |
| <meta property="docfx:rel" content="https://lucenenet.apache.org/docs/4.8.0-beta00009/"> |
| |
| </head> |
| <body data-spy="scroll" data-target="#affix" data-offset="120"> |
| <div id="wrapper"> |
| <header> |
| |
| <nav id="autocollapse" class="navbar ng-scope" role="navigation"> |
| <div class="container"> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| |
| <a class="navbar-brand" href="/"> |
| <img id="logo" class="svg" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/lucene-net-color.png" alt=""> |
| </a> |
| </div> |
| <div class="collapse navbar-collapse" id="navbar"> |
| <form class="navbar-form navbar-right" role="search" id="search"> |
| <div class="form-group"> |
| <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off"> |
| </div> |
| </form> |
| </div> |
| </div> |
| </nav> |
| |
| <div class="subnav navbar navbar-default"> |
| <div class="container hide-when-search"> |
| <ul class="level0 breadcrumb"> |
| <li> |
| <a href="https://lucenenet.apache.org/docs/4.8.0-beta00009/">API</a> |
| <span id="breadcrumb"> |
| <ul class="breadcrumb"> |
| <li></li> |
| </ul> |
| </span> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </header> |
| <div class="container body-content"> |
| |
| <div id="search-results"> |
| <div class="search-list"></div> |
| <div class="sr-items"> |
| <p><i class="glyphicon glyphicon-refresh index-loading"></i></p> |
| </div> |
| <ul id="pagination"></ul> |
| </div> |
| </div> |
| <div role="main" class="container body-content hide-when-search"> |
| |
| <div class="sidenav hide-when-search"> |
| <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a> |
| <div class="sidetoggle collapse" id="sidetoggle"> |
| <div id="sidetoc"></div> |
| </div> |
| </div> |
| <div class="article row grid-right"> |
| <div class="col-md-10"> |
| <article class="content wrap" id="_content" data-uid="Lucene.Net.Index.PersistentSnapshotDeletionPolicy"> |
| |
| |
| <h1 id="Lucene_Net_Index_PersistentSnapshotDeletionPolicy" data-uid="Lucene.Net.Index.PersistentSnapshotDeletionPolicy" class="text-break">Class PersistentSnapshotDeletionPolicy |
| </h1> |
| <div class="markdown level0 summary"><p>A <a class="xref" href="Lucene.Net.Index.SnapshotDeletionPolicy.html">SnapshotDeletionPolicy</a> which adds a persistence layer so that |
| snapshots can be maintained across the life of an application. The snapshots |
| are persisted in a <a class="xref" href="Lucene.Net.Store.Directory.html">Directory</a> and are committed as soon as |
| <a class="xref" href="Lucene.Net.Index.PersistentSnapshotDeletionPolicy.html#Lucene_Net_Index_PersistentSnapshotDeletionPolicy_Snapshot">Snapshot()</a> or <a class="xref" href="Lucene.Net.Index.PersistentSnapshotDeletionPolicy.html#Lucene_Net_Index_PersistentSnapshotDeletionPolicy_Release_Lucene_Net_Index_IndexCommit_">Release(IndexCommit)</a> is called. |
| <p> |
| <strong>NOTE:</strong> Sharing <a class="xref" href="Lucene.Net.Index.PersistentSnapshotDeletionPolicy.html">PersistentSnapshotDeletionPolicy</a>s that write to |
| the same directory across <a class="xref" href="Lucene.Net.Index.IndexWriter.html">IndexWriter</a>s will corrupt snapshots. You |
| should make sure every <a class="xref" href="Lucene.Net.Index.IndexWriter.html">IndexWriter</a> has its own |
| <a class="xref" href="Lucene.Net.Index.PersistentSnapshotDeletionPolicy.html">PersistentSnapshotDeletionPolicy</a> and that they all write to a |
| different <a class="xref" href="Lucene.Net.Store.Directory.html">Directory</a>. It is OK to use the same |
| <a class="xref" href="Lucene.Net.Store.Directory.html">Directory</a> that holds the index.</p> |
| <p><p> This class adds a <a class="xref" href="Lucene.Net.Index.PersistentSnapshotDeletionPolicy.html#Lucene_Net_Index_PersistentSnapshotDeletionPolicy_Release_System_Int64_">Release(Int64)</a> method to |
| release commits from a previous snapshot's <a class="xref" href="Lucene.Net.Index.IndexCommit.html#Lucene_Net_Index_IndexCommit_Generation">Generation</a>. |
| <p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></div> |
| <div class="markdown level0 conceptual"></div> |
| <div class="inheritance"> |
| <h5>Inheritance</h5> |
| <div class="level0"><span class="xref">System.Object</span></div> |
| <div class="level1"><a class="xref" href="Lucene.Net.Index.IndexDeletionPolicy.html">IndexDeletionPolicy</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Index.SnapshotDeletionPolicy.html">SnapshotDeletionPolicy</a></div> |
| <div class="level3"><span class="xref">PersistentSnapshotDeletionPolicy</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.SnapshotDeletionPolicy.html#Lucene_Net_Index_SnapshotDeletionPolicy_m_refCounts">SnapshotDeletionPolicy.m_refCounts</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.SnapshotDeletionPolicy.html#Lucene_Net_Index_SnapshotDeletionPolicy_m_indexCommits">SnapshotDeletionPolicy.m_indexCommits</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.SnapshotDeletionPolicy.html#Lucene_Net_Index_SnapshotDeletionPolicy_m_lastCommit">SnapshotDeletionPolicy.m_lastCommit</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.SnapshotDeletionPolicy.html#Lucene_Net_Index_SnapshotDeletionPolicy_OnCommit__1_System_Collections_Generic_IList___0__">SnapshotDeletionPolicy.OnCommit<T>(IList<T>)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.SnapshotDeletionPolicy.html#Lucene_Net_Index_SnapshotDeletionPolicy_OnInit__1_System_Collections_Generic_IList___0__">SnapshotDeletionPolicy.OnInit<T>(IList<T>)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.SnapshotDeletionPolicy.html#Lucene_Net_Index_SnapshotDeletionPolicy_ReleaseGen_System_Int64_">SnapshotDeletionPolicy.ReleaseGen(Int64)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.SnapshotDeletionPolicy.html#Lucene_Net_Index_SnapshotDeletionPolicy_IncRef_Lucene_Net_Index_IndexCommit_">SnapshotDeletionPolicy.IncRef(IndexCommit)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.SnapshotDeletionPolicy.html#Lucene_Net_Index_SnapshotDeletionPolicy_GetSnapshots">SnapshotDeletionPolicy.GetSnapshots()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.SnapshotDeletionPolicy.html#Lucene_Net_Index_SnapshotDeletionPolicy_SnapshotCount">SnapshotDeletionPolicy.SnapshotCount</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.SnapshotDeletionPolicy.html#Lucene_Net_Index_SnapshotDeletionPolicy_GetIndexCommit_System_Int64_">SnapshotDeletionPolicy.GetIndexCommit(Int64)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.SnapshotDeletionPolicy.html#Lucene_Net_Index_SnapshotDeletionPolicy_Clone">SnapshotDeletionPolicy.Clone()</a> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetHashCode()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetType()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.MemberwiseClone()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ToString()</span> |
| </div> |
| </div> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Index.html">Lucene.Net.Index</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.dll</h6> |
| <h5 id="Lucene_Net_Index_PersistentSnapshotDeletionPolicy_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class PersistentSnapshotDeletionPolicy : SnapshotDeletionPolicy</code></pre> |
| </div> |
| <h3 id="constructors">Constructors |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_PersistentSnapshotDeletionPolicy__ctor_Lucene_Net_Index_IndexDeletionPolicy_Lucene_Net_Store_Directory_.md&value=---%0Auid%3A%20Lucene.Net.Index.PersistentSnapshotDeletionPolicy.%23ctor(Lucene.Net.Index.IndexDeletionPolicy%2CLucene.Net.Store.Directory)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/PersistentSnapshotDeletionPolicy.cs/#L80">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_PersistentSnapshotDeletionPolicy__ctor_" data-uid="Lucene.Net.Index.PersistentSnapshotDeletionPolicy.#ctor*"></a> |
| <h4 id="Lucene_Net_Index_PersistentSnapshotDeletionPolicy__ctor_Lucene_Net_Index_IndexDeletionPolicy_Lucene_Net_Store_Directory_" data-uid="Lucene.Net.Index.PersistentSnapshotDeletionPolicy.#ctor(Lucene.Net.Index.IndexDeletionPolicy,Lucene.Net.Store.Directory)">PersistentSnapshotDeletionPolicy(IndexDeletionPolicy, Directory)</h4> |
| <div class="markdown level1 summary"><p><a class="xref" href="Lucene.Net.Index.PersistentSnapshotDeletionPolicy.html">PersistentSnapshotDeletionPolicy</a> wraps another |
| <a class="xref" href="Lucene.Net.Index.IndexDeletionPolicy.html">IndexDeletionPolicy</a> to enable flexible |
| snapshotting, passing <a class="xref" href="Lucene.Net.Index.OpenMode.html#Lucene_Net_Index_OpenMode_CREATE_OR_APPEND">CREATE_OR_APPEND</a> |
| by default.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public PersistentSnapshotDeletionPolicy(IndexDeletionPolicy primary, Directory dir)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Index.IndexDeletionPolicy.html">IndexDeletionPolicy</a></td> |
| <td><span class="parametername">primary</span></td> |
| <td><p>the <a class="xref" href="Lucene.Net.Index.IndexDeletionPolicy.html">IndexDeletionPolicy</a> that is used on non-snapshotted |
| commits. Snapshotted commits, by definition, are not deleted until |
| explicitly released via <a class="xref" href="Lucene.Net.Index.PersistentSnapshotDeletionPolicy.html#Lucene_Net_Index_PersistentSnapshotDeletionPolicy_Release_Lucene_Net_Index_IndexCommit_">Release(IndexCommit)</a>. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Store.Directory.html">Directory</a></td> |
| <td><span class="parametername">dir</span></td> |
| <td><p>the <a class="xref" href="Lucene.Net.Store.Directory.html">Directory</a> which will be used to persist the snapshots |
| information. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_PersistentSnapshotDeletionPolicy__ctor_Lucene_Net_Index_IndexDeletionPolicy_Lucene_Net_Store_Directory_Lucene_Net_Index_OpenMode_.md&value=---%0Auid%3A%20Lucene.Net.Index.PersistentSnapshotDeletionPolicy.%23ctor(Lucene.Net.Index.IndexDeletionPolicy%2CLucene.Net.Store.Directory%2CLucene.Net.Index.OpenMode)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/PersistentSnapshotDeletionPolicy.cs/#L100">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_PersistentSnapshotDeletionPolicy__ctor_" data-uid="Lucene.Net.Index.PersistentSnapshotDeletionPolicy.#ctor*"></a> |
| <h4 id="Lucene_Net_Index_PersistentSnapshotDeletionPolicy__ctor_Lucene_Net_Index_IndexDeletionPolicy_Lucene_Net_Store_Directory_Lucene_Net_Index_OpenMode_" data-uid="Lucene.Net.Index.PersistentSnapshotDeletionPolicy.#ctor(Lucene.Net.Index.IndexDeletionPolicy,Lucene.Net.Store.Directory,Lucene.Net.Index.OpenMode)">PersistentSnapshotDeletionPolicy(IndexDeletionPolicy, Directory, OpenMode)</h4> |
| <div class="markdown level1 summary"><p><a class="xref" href="Lucene.Net.Index.PersistentSnapshotDeletionPolicy.html">PersistentSnapshotDeletionPolicy</a> wraps another |
| <a class="xref" href="Lucene.Net.Index.IndexDeletionPolicy.html">IndexDeletionPolicy</a> to enable flexible snapshotting.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public PersistentSnapshotDeletionPolicy(IndexDeletionPolicy primary, Directory dir, OpenMode mode)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Index.IndexDeletionPolicy.html">IndexDeletionPolicy</a></td> |
| <td><span class="parametername">primary</span></td> |
| <td><p>the <a class="xref" href="Lucene.Net.Index.IndexDeletionPolicy.html">IndexDeletionPolicy</a> that is used on non-snapshotted |
| commits. Snapshotted commits, by definition, are not deleted until |
| explicitly released via <a class="xref" href="Lucene.Net.Index.PersistentSnapshotDeletionPolicy.html#Lucene_Net_Index_PersistentSnapshotDeletionPolicy_Release_Lucene_Net_Index_IndexCommit_">Release(IndexCommit)</a>. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Store.Directory.html">Directory</a></td> |
| <td><span class="parametername">dir</span></td> |
| <td><p>the <a class="xref" href="Lucene.Net.Store.Directory.html">Directory</a> which will be used to persist the snapshots |
| information. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Index.OpenMode.html">OpenMode</a></td> |
| <td><span class="parametername">mode</span></td> |
| <td><p>specifies whether a new index should be created, deleting all |
| existing snapshots information (immediately), or open an existing |
| index, initializing the class with the snapshots information. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="fields">Fields |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_PersistentSnapshotDeletionPolicy_SNAPSHOTS_PREFIX.md&value=---%0Auid%3A%20Lucene.Net.Index.PersistentSnapshotDeletionPolicy.SNAPSHOTS_PREFIX%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/PersistentSnapshotDeletionPolicy.cs/#L56">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Index_PersistentSnapshotDeletionPolicy_SNAPSHOTS_PREFIX" data-uid="Lucene.Net.Index.PersistentSnapshotDeletionPolicy.SNAPSHOTS_PREFIX">SNAPSHOTS_PREFIX</h4> |
| <div class="markdown level1 summary"><p>Prefix used for the save file. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static readonly string SNAPSHOTS_PREFIX</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="properties">Properties |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_PersistentSnapshotDeletionPolicy_LastSaveFile.md&value=---%0Auid%3A%20Lucene.Net.Index.PersistentSnapshotDeletionPolicy.LastSaveFile%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/PersistentSnapshotDeletionPolicy.cs/#L284">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_PersistentSnapshotDeletionPolicy_LastSaveFile_" data-uid="Lucene.Net.Index.PersistentSnapshotDeletionPolicy.LastSaveFile*"></a> |
| <h4 id="Lucene_Net_Index_PersistentSnapshotDeletionPolicy_LastSaveFile" data-uid="Lucene.Net.Index.PersistentSnapshotDeletionPolicy.LastSaveFile">LastSaveFile</h4> |
| <div class="markdown level1 summary"><p>Returns the file name the snapshots are currently |
| saved to, or <code>null</code> if no snapshots have been saved.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual string LastSaveFile { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="methods">Methods |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_PersistentSnapshotDeletionPolicy_Release_Lucene_Net_Index_IndexCommit_.md&value=---%0Auid%3A%20Lucene.Net.Index.PersistentSnapshotDeletionPolicy.Release(Lucene.Net.Index.IndexCommit)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/PersistentSnapshotDeletionPolicy.cs/#L159">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_PersistentSnapshotDeletionPolicy_Release_" data-uid="Lucene.Net.Index.PersistentSnapshotDeletionPolicy.Release*"></a> |
| <h4 id="Lucene_Net_Index_PersistentSnapshotDeletionPolicy_Release_Lucene_Net_Index_IndexCommit_" data-uid="Lucene.Net.Index.PersistentSnapshotDeletionPolicy.Release(Lucene.Net.Index.IndexCommit)">Release(IndexCommit)</h4> |
| <div class="markdown level1 summary"><p>Deletes a snapshotted commit. Once this method returns, the snapshot |
| information is persisted in the directory.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public override void Release(IndexCommit commit)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Index.IndexCommit.html">IndexCommit</a></td> |
| <td><span class="parametername">commit</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Index.SnapshotDeletionPolicy.html#Lucene_Net_Index_SnapshotDeletionPolicy_Release_Lucene_Net_Index_IndexCommit_">SnapshotDeletionPolicy.Release(IndexCommit)</a></div> |
| <h5 id="Lucene_Net_Index_PersistentSnapshotDeletionPolicy_Release_Lucene_Net_Index_IndexCommit__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Index.SnapshotDeletionPolicy.html#Lucene_Net_Index_SnapshotDeletionPolicy_Release_Lucene_Net_Index_IndexCommit_">Release</a>(<a class="xref" href="Lucene.Net.Index.IndexCommit.html">IndexCommit</a>)</div> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_PersistentSnapshotDeletionPolicy_Release_System_Int64_.md&value=---%0Auid%3A%20Lucene.Net.Index.PersistentSnapshotDeletionPolicy.Release(System.Int64)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/PersistentSnapshotDeletionPolicy.cs/#L195">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_PersistentSnapshotDeletionPolicy_Release_" data-uid="Lucene.Net.Index.PersistentSnapshotDeletionPolicy.Release*"></a> |
| <h4 id="Lucene_Net_Index_PersistentSnapshotDeletionPolicy_Release_System_Int64_" data-uid="Lucene.Net.Index.PersistentSnapshotDeletionPolicy.Release(System.Int64)">Release(Int64)</h4> |
| <div class="markdown level1 summary"><p>Deletes a snapshotted commit by generation. Once this method returns, the snapshot |
| information is persisted in the directory.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void Release(long gen)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int64</span></td> |
| <td><span class="parametername">gen</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Index_PersistentSnapshotDeletionPolicy_Release_System_Int64__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Index.IndexCommit.html#Lucene_Net_Index_IndexCommit_Generation">Generation</a></div> |
| <div><a class="xref" href="Lucene.Net.Index.SnapshotDeletionPolicy.html#Lucene_Net_Index_SnapshotDeletionPolicy_Release_Lucene_Net_Index_IndexCommit_">Release</a>(<a class="xref" href="Lucene.Net.Index.IndexCommit.html">IndexCommit</a>)</div> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_PersistentSnapshotDeletionPolicy_Snapshot.md&value=---%0Auid%3A%20Lucene.Net.Index.PersistentSnapshotDeletionPolicy.Snapshot%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/PersistentSnapshotDeletionPolicy.cs/#L123">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_PersistentSnapshotDeletionPolicy_Snapshot_" data-uid="Lucene.Net.Index.PersistentSnapshotDeletionPolicy.Snapshot*"></a> |
| <h4 id="Lucene_Net_Index_PersistentSnapshotDeletionPolicy_Snapshot" data-uid="Lucene.Net.Index.PersistentSnapshotDeletionPolicy.Snapshot">Snapshot()</h4> |
| <div class="markdown level1 summary"><p>Snapshots the last commit. Once this method returns, the |
| snapshot information is persisted in the directory.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public override IndexCommit Snapshot()</code></pre> |
| </div> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Index.IndexCommit.html">IndexCommit</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Index.SnapshotDeletionPolicy.html#Lucene_Net_Index_SnapshotDeletionPolicy_Snapshot">SnapshotDeletionPolicy.Snapshot()</a></div> |
| <h5 id="Lucene_Net_Index_PersistentSnapshotDeletionPolicy_Snapshot_seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Index.SnapshotDeletionPolicy.html#Lucene_Net_Index_SnapshotDeletionPolicy_Snapshot">Snapshot</a>()</div> |
| </div> |
| </article> |
| </div> |
| |
| <div class="hidden-sm col-md-2" role="complementary"> |
| <div class="sideaffix"> |
| <div class="contribution"> |
| <ul class="nav"> |
| <li> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_PersistentSnapshotDeletionPolicy.md&value=---%0Auid%3A%20Lucene.Net.Index.PersistentSnapshotDeletionPolicy%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a> |
| </li> |
| <li> |
| <a href="https://github.com/apache/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/PersistentSnapshotDeletionPolicy.cs/#L52" class="contribution-link">View Source</a> |
| </li> |
| </ul> |
| </div> |
| <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix"> |
| <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> --> |
| </nav> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <footer> |
| <div class="grad-bottom"></div> |
| <div class="footer"> |
| <div class="container"> |
| <span class="pull-right"> |
| <a href="#top">Back to top</a> |
| </span> |
| Copyright © 2020 Licensed to the Apache Software Foundation (ASF) |
| |
| </div> |
| </div> |
| </footer> |
| </div> |
| |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.js"></script> |
| </body> |
| </html> |
