| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class IndexWriterConfig |
| | Apache Lucene.NET 4.8.0-beta00013 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class IndexWriterConfig |
| | Apache Lucene.NET 4.8.0-beta00013 Documentation "> |
| <meta name="generator" content="docfx 2.56.2.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"> |
| <span id="forkongithub"><a href="https://github.com/apache/lucenenet" target="_blank">Fork me on GitHub</a></span> |
| <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.IndexWriterConfig"> |
| |
| |
| <h1 id="Lucene_Net_Index_IndexWriterConfig" data-uid="Lucene.Net.Index.IndexWriterConfig" class="text-break">Class IndexWriterConfig |
| </h1> |
| <div class="markdown level0 summary"><p>Holds all the configuration that is used to create an <a class="xref" href="Lucene.Net.Index.IndexWriter.html">IndexWriter</a>. |
| Once <a class="xref" href="Lucene.Net.Index.IndexWriter.html">IndexWriter</a> has been created with this object, changes to this |
| object will not affect the <a class="xref" href="Lucene.Net.Index.IndexWriter.html">IndexWriter</a> instance. For that, use |
| <a class="xref" href="Lucene.Net.Index.LiveIndexWriterConfig.html">LiveIndexWriterConfig</a> that is returned from <a class="xref" href="Lucene.Net.Index.IndexWriter.html#Lucene_Net_Index_IndexWriter_Config">Config</a>.</p> |
| <p><p> |
| LUCENENET NOTE: Unlike Lucene, we use property setters instead of setter methods. |
| In C#, this allows you to initialize the <a class="xref" href="Lucene.Net.Index.IndexWriterConfig.html">IndexWriterConfig</a> |
| using the language features of C#, for example:</p> |
| <pre><code> IndexWriterConfig conf = new IndexWriterConfig(analyzer) |
| { |
| Codec = Lucene46Codec(), |
| OpenMode = OpenMode.CREATE |
| };</code></pre> |
| |
| <p>However, if you prefer to match the syntax of Lucene using chained setter methods, |
| there are extension methods in the Lucene.Net.Index.Extensions namespace. Example usage:</p> |
| <pre><code> using Lucene.Net.Index.Extensions; |
| |
| .. |
| |
| IndexWriterConfig conf = new IndexWriterConfig(analyzer) |
| .SetCodec(new Lucene46Codec()) |
| .SetOpenMode(OpenMode.CREATE);</code></pre> |
| |
| <p>@since 3.1</p> |
| </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.LiveIndexWriterConfig.html">LiveIndexWriterConfig</a></div> |
| <div class="level2"><span class="xref">IndexWriterConfig</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.LiveIndexWriterConfig.html#Lucene_Net_Index_LiveIndexWriterConfig_Analyzer">LiveIndexWriterConfig.Analyzer</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.LiveIndexWriterConfig.html#Lucene_Net_Index_LiveIndexWriterConfig_TermIndexInterval">LiveIndexWriterConfig.TermIndexInterval</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.LiveIndexWriterConfig.html#Lucene_Net_Index_LiveIndexWriterConfig_MaxBufferedDeleteTerms">LiveIndexWriterConfig.MaxBufferedDeleteTerms</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.LiveIndexWriterConfig.html#Lucene_Net_Index_LiveIndexWriterConfig_RAMBufferSizeMB">LiveIndexWriterConfig.RAMBufferSizeMB</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.LiveIndexWriterConfig.html#Lucene_Net_Index_LiveIndexWriterConfig_MaxBufferedDocs">LiveIndexWriterConfig.MaxBufferedDocs</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.LiveIndexWriterConfig.html#Lucene_Net_Index_LiveIndexWriterConfig_MergedSegmentWarmer">LiveIndexWriterConfig.MergedSegmentWarmer</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.LiveIndexWriterConfig.html#Lucene_Net_Index_LiveIndexWriterConfig_ReaderTermsIndexDivisor">LiveIndexWriterConfig.ReaderTermsIndexDivisor</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.LiveIndexWriterConfig.html#Lucene_Net_Index_LiveIndexWriterConfig_InfoStream">LiveIndexWriterConfig.InfoStream</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.LiveIndexWriterConfig.html#Lucene_Net_Index_LiveIndexWriterConfig_UseCompoundFile">LiveIndexWriterConfig.UseCompoundFile</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.LiveIndexWriterConfig.html#Lucene_Net_Index_LiveIndexWriterConfig_CheckIntegrityAtMerge">LiveIndexWriterConfig.CheckIntegrityAtMerge</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> |
| <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_IndexWriterConfig_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">[Serializable] |
| public sealed class IndexWriterConfig : LiveIndexWriterConfig</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IndexWriterConfig__ctor_Lucene_Net_Util_LuceneVersion_Lucene_Net_Analysis_Analyzer_.md&value=---%0Auid%3A%20Lucene.Net.Index.IndexWriterConfig.%23ctor(Lucene.Net.Util.LuceneVersion%2CLucene.Net.Analysis.Analyzer)%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/fix/apidocs-layout/src/Lucene.Net/Index/IndexWriterConfig.cs/#L175">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IndexWriterConfig__ctor_" data-uid="Lucene.Net.Index.IndexWriterConfig.#ctor*"></a> |
| <h4 id="Lucene_Net_Index_IndexWriterConfig__ctor_Lucene_Net_Util_LuceneVersion_Lucene_Net_Analysis_Analyzer_" data-uid="Lucene.Net.Index.IndexWriterConfig.#ctor(Lucene.Net.Util.LuceneVersion,Lucene.Net.Analysis.Analyzer)">IndexWriterConfig(LuceneVersion, Analyzer)</h4> |
| <div class="markdown level1 summary"><p>Creates a new config that with defaults that match the specified |
| <a class="xref" href="Lucene.Net.Util.LuceneVersion.html">LuceneVersion</a> as well as the default |
| <a class="xref" href="Lucene.Net.Analysis.Analyzer.html">Analyzer</a>. If <code data-dev-comment-type="paramref" class="paramref">matchVersion</code> is >= |
| <a class="xref" href="Lucene.Net.Util.LuceneVersion.html#Lucene_Net_Util_LuceneVersion_LUCENE_32">LUCENE_32</a>, <a class="xref" href="Lucene.Net.Index.TieredMergePolicy.html">TieredMergePolicy</a> is used |
| for merging; else <a class="xref" href="Lucene.Net.Index.LogByteSizeMergePolicy.html">LogByteSizeMergePolicy</a>. |
| Note that <a class="xref" href="Lucene.Net.Index.TieredMergePolicy.html">TieredMergePolicy</a> is free to select |
| non-contiguous merges, which means docIDs may not |
| remain monotonic over time. If this is a problem you |
| should switch to <a class="xref" href="Lucene.Net.Index.LogByteSizeMergePolicy.html">LogByteSizeMergePolicy</a> or |
| <a class="xref" href="Lucene.Net.Index.LogDocMergePolicy.html">LogDocMergePolicy</a>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public IndexWriterConfig(LuceneVersion matchVersion, Analyzer analyzer)</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.Util.LuceneVersion.html">LuceneVersion</a></td> |
| <td><span class="parametername">matchVersion</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Analysis.Analyzer.html">Analyzer</a></td> |
| <td><span class="parametername">analyzer</span></td> |
| <td></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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IndexWriterConfig_DEFAULT_CHECK_INTEGRITY_AT_MERGE.md&value=---%0Auid%3A%20Lucene.Net.Index.IndexWriterConfig.DEFAULT_CHECK_INTEGRITY_AT_MERGE%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/fix/apidocs-layout/src/Lucene.Net/Index/IndexWriterConfig.cs/#L136">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Index_IndexWriterConfig_DEFAULT_CHECK_INTEGRITY_AT_MERGE" data-uid="Lucene.Net.Index.IndexWriterConfig.DEFAULT_CHECK_INTEGRITY_AT_MERGE">DEFAULT_CHECK_INTEGRITY_AT_MERGE</h4> |
| <div class="markdown level1 summary"><p>Default value for calling <a class="xref" href="Lucene.Net.Index.AtomicReader.html#Lucene_Net_Index_AtomicReader_CheckIntegrity">CheckIntegrity()</a> before |
| merging segments (set to <code>false</code>). You can set this |
| to <code>true</code> for additional safety.</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 bool DEFAULT_CHECK_INTEGRITY_AT_MERGE</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.Boolean</span></td> |
| <td></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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IndexWriterConfig_DEFAULT_MAX_BUFFERED_DELETE_TERMS.md&value=---%0Auid%3A%20Lucene.Net.Index.IndexWriterConfig.DEFAULT_MAX_BUFFERED_DELETE_TERMS%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/fix/apidocs-layout/src/Lucene.Net/Index/IndexWriterConfig.cs/#L86">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Index_IndexWriterConfig_DEFAULT_MAX_BUFFERED_DELETE_TERMS" data-uid="Lucene.Net.Index.IndexWriterConfig.DEFAULT_MAX_BUFFERED_DELETE_TERMS">DEFAULT_MAX_BUFFERED_DELETE_TERMS</h4> |
| <div class="markdown level1 summary"><p>Disabled by default (because IndexWriter flushes by RAM usage 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 static readonly int DEFAULT_MAX_BUFFERED_DELETE_TERMS</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.Int32</span></td> |
| <td></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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IndexWriterConfig_DEFAULT_MAX_BUFFERED_DOCS.md&value=---%0Auid%3A%20Lucene.Net.Index.IndexWriterConfig.DEFAULT_MAX_BUFFERED_DOCS%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/fix/apidocs-layout/src/Lucene.Net/Index/IndexWriterConfig.cs/#L90">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Index_IndexWriterConfig_DEFAULT_MAX_BUFFERED_DOCS" data-uid="Lucene.Net.Index.IndexWriterConfig.DEFAULT_MAX_BUFFERED_DOCS">DEFAULT_MAX_BUFFERED_DOCS</h4> |
| <div class="markdown level1 summary"><p>Disabled by default (because IndexWriter flushes by RAM usage 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 static readonly int DEFAULT_MAX_BUFFERED_DOCS</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.Int32</span></td> |
| <td></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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IndexWriterConfig_DEFAULT_MAX_THREAD_STATES.md&value=---%0Auid%3A%20Lucene.Net.Index.IndexWriterConfig.DEFAULT_MAX_THREAD_STATES%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/fix/apidocs-layout/src/Lucene.Net/Index/IndexWriterConfig.cs/#L122">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Index_IndexWriterConfig_DEFAULT_MAX_THREAD_STATES" data-uid="Lucene.Net.Index.IndexWriterConfig.DEFAULT_MAX_THREAD_STATES">DEFAULT_MAX_THREAD_STATES</h4> |
| <div class="markdown level1 summary"><p>The maximum number of simultaneous threads that may be |
| indexing documents at once in <a class="xref" href="Lucene.Net.Index.IndexWriter.html">IndexWriter</a>; if more |
| than this many threads arrive they will wait for |
| others to finish. Default value is 8.</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 int DEFAULT_MAX_THREAD_STATES</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.Int32</span></td> |
| <td></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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IndexWriterConfig_DEFAULT_RAM_BUFFER_SIZE_MB.md&value=---%0Auid%3A%20Lucene.Net.Index.IndexWriterConfig.DEFAULT_RAM_BUFFER_SIZE_MB%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/fix/apidocs-layout/src/Lucene.Net/Index/IndexWriterConfig.cs/#L96">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Index_IndexWriterConfig_DEFAULT_RAM_BUFFER_SIZE_MB" data-uid="Lucene.Net.Index.IndexWriterConfig.DEFAULT_RAM_BUFFER_SIZE_MB">DEFAULT_RAM_BUFFER_SIZE_MB</h4> |
| <div class="markdown level1 summary"><p>Default value is 16 MB (which means flush when buffered docs consume |
| approximately 16 MB RAM).</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 double DEFAULT_RAM_BUFFER_SIZE_MB</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.Double</span></td> |
| <td></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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IndexWriterConfig_DEFAULT_RAM_PER_THREAD_HARD_LIMIT_MB.md&value=---%0Auid%3A%20Lucene.Net.Index.IndexWriterConfig.DEFAULT_RAM_PER_THREAD_HARD_LIMIT_MB%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/fix/apidocs-layout/src/Lucene.Net/Index/IndexWriterConfig.cs/#L114">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Index_IndexWriterConfig_DEFAULT_RAM_PER_THREAD_HARD_LIMIT_MB" data-uid="Lucene.Net.Index.IndexWriterConfig.DEFAULT_RAM_PER_THREAD_HARD_LIMIT_MB">DEFAULT_RAM_PER_THREAD_HARD_LIMIT_MB</h4> |
| <div class="markdown level1 summary"><p>Default value is 1945. Change using <a class="xref" href="Lucene.Net.Index.IndexWriterConfig.html#Lucene_Net_Index_IndexWriterConfig_RAMPerThreadHardLimitMB">RAMPerThreadHardLimitMB</a> setter. </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 int DEFAULT_RAM_PER_THREAD_HARD_LIMIT_MB</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.Int32</span></td> |
| <td></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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IndexWriterConfig_DEFAULT_READER_POOLING.md&value=---%0Auid%3A%20Lucene.Net.Index.IndexWriterConfig.DEFAULT_READER_POOLING%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/fix/apidocs-layout/src/Lucene.Net/Index/IndexWriterConfig.cs/#L106">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Index_IndexWriterConfig_DEFAULT_READER_POOLING" data-uid="Lucene.Net.Index.IndexWriterConfig.DEFAULT_READER_POOLING">DEFAULT_READER_POOLING</h4> |
| <div class="markdown level1 summary"><p>Default setting for <a class="xref" href="Lucene.Net.Index.IndexWriterConfig.html#Lucene_Net_Index_IndexWriterConfig_UseReaderPooling">UseReaderPooling</a>. </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 bool DEFAULT_READER_POOLING</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.Boolean</span></td> |
| <td></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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IndexWriterConfig_DEFAULT_READER_TERMS_INDEX_DIVISOR.md&value=---%0Auid%3A%20Lucene.Net.Index.IndexWriterConfig.DEFAULT_READER_TERMS_INDEX_DIVISOR%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/fix/apidocs-layout/src/Lucene.Net/Index/IndexWriterConfig.cs/#L110">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Index_IndexWriterConfig_DEFAULT_READER_TERMS_INDEX_DIVISOR" data-uid="Lucene.Net.Index.IndexWriterConfig.DEFAULT_READER_TERMS_INDEX_DIVISOR">DEFAULT_READER_TERMS_INDEX_DIVISOR</h4> |
| <div class="markdown level1 summary"><p>Default value is 1. Change using <a class="xref" href="Lucene.Net.Index.LiveIndexWriterConfig.html#Lucene_Net_Index_LiveIndexWriterConfig_ReaderTermsIndexDivisor">ReaderTermsIndexDivisor</a> setter. </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 int DEFAULT_READER_TERMS_INDEX_DIVISOR</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.Int32</span></td> |
| <td></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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IndexWriterConfig_DEFAULT_TERM_INDEX_INTERVAL.md&value=---%0Auid%3A%20Lucene.Net.Index.IndexWriterConfig.DEFAULT_TERM_INDEX_INTERVAL%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/fix/apidocs-layout/src/Lucene.Net/Index/IndexWriterConfig.cs/#L78">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Index_IndexWriterConfig_DEFAULT_TERM_INDEX_INTERVAL" data-uid="Lucene.Net.Index.IndexWriterConfig.DEFAULT_TERM_INDEX_INTERVAL">DEFAULT_TERM_INDEX_INTERVAL</h4> |
| <div class="markdown level1 summary"><p>Default value is 32. Change using <a class="xref" href="Lucene.Net.Index.LiveIndexWriterConfig.html#Lucene_Net_Index_LiveIndexWriterConfig_TermIndexInterval">TermIndexInterval</a> setter. </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 int DEFAULT_TERM_INDEX_INTERVAL</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.Int32</span></td> |
| <td></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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IndexWriterConfig_DEFAULT_USE_COMPOUND_FILE_SYSTEM.md&value=---%0Auid%3A%20Lucene.Net.Index.IndexWriterConfig.DEFAULT_USE_COMPOUND_FILE_SYSTEM%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/fix/apidocs-layout/src/Lucene.Net/Index/IndexWriterConfig.cs/#L129">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Index_IndexWriterConfig_DEFAULT_USE_COMPOUND_FILE_SYSTEM" data-uid="Lucene.Net.Index.IndexWriterConfig.DEFAULT_USE_COMPOUND_FILE_SYSTEM">DEFAULT_USE_COMPOUND_FILE_SYSTEM</h4> |
| <div class="markdown level1 summary"><p>Default value for compound file system for newly written segments |
| (set to <code>true</code>). For batch indexing with very large |
| ram buffers use <code>false</code></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 bool DEFAULT_USE_COMPOUND_FILE_SYSTEM</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.Boolean</span></td> |
| <td></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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IndexWriterConfig_DISABLE_AUTO_FLUSH.md&value=---%0Auid%3A%20Lucene.Net.Index.IndexWriterConfig.DISABLE_AUTO_FLUSH%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/fix/apidocs-layout/src/Lucene.Net/Index/IndexWriterConfig.cs/#L82">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Index_IndexWriterConfig_DISABLE_AUTO_FLUSH" data-uid="Lucene.Net.Index.IndexWriterConfig.DISABLE_AUTO_FLUSH">DISABLE_AUTO_FLUSH</h4> |
| <div class="markdown level1 summary"><p>Denotes a flush trigger is disabled. </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 int DISABLE_AUTO_FLUSH</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.Int32</span></td> |
| <td></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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IndexWriterConfig_WRITE_LOCK_TIMEOUT.md&value=---%0Auid%3A%20Lucene.Net.Index.IndexWriterConfig.WRITE_LOCK_TIMEOUT%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/fix/apidocs-layout/src/Lucene.Net/Index/IndexWriterConfig.cs/#L102">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Index_IndexWriterConfig_WRITE_LOCK_TIMEOUT" data-uid="Lucene.Net.Index.IndexWriterConfig.WRITE_LOCK_TIMEOUT">WRITE_LOCK_TIMEOUT</h4> |
| <div class="markdown level1 summary"><p>Default value for the write lock timeout (1,000 ms).</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static long WRITE_LOCK_TIMEOUT</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.Int64</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IndexWriterConfig_Codec.md&value=---%0Auid%3A%20Lucene.Net.Index.IndexWriterConfig.Codec%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/fix/apidocs-layout/src/Lucene.Net/Index/IndexWriterConfig.cs/#L325">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IndexWriterConfig_Codec_" data-uid="Lucene.Net.Index.IndexWriterConfig.Codec*"></a> |
| <h4 id="Lucene_Net_Index_IndexWriterConfig_Codec" data-uid="Lucene.Net.Index.IndexWriterConfig.Codec">Codec</h4> |
| <div class="markdown level1 summary"><p>Gets or sets the <a class="xref" href="Lucene.Net.Codecs.Codec.html">Codec</a>. |
| <p> |
| Only takes effect when <a class="xref" href="Lucene.Net.Index.IndexWriter.html">IndexWriter</a> is first created.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public Codec Codec { get; set; }</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><a class="xref" href="Lucene.Net.Codecs.Codec.html">Codec</a></td> |
| <td></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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IndexWriterConfig_DefaultWriteLockTimeout.md&value=---%0Auid%3A%20Lucene.Net.Index.IndexWriterConfig.DefaultWriteLockTimeout%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/fix/apidocs-layout/src/Lucene.Net/Index/IndexWriterConfig.cs/#L142">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IndexWriterConfig_DefaultWriteLockTimeout_" data-uid="Lucene.Net.Index.IndexWriterConfig.DefaultWriteLockTimeout*"></a> |
| <h4 id="Lucene_Net_Index_IndexWriterConfig_DefaultWriteLockTimeout" data-uid="Lucene.Net.Index.IndexWriterConfig.DefaultWriteLockTimeout">DefaultWriteLockTimeout</h4> |
| <div class="markdown level1 summary"><p>Gets or sets the default (for any instance) maximum time to wait for a write lock |
| (in milliseconds).</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static long DefaultWriteLockTimeout { get; set; }</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.Int64</span></td> |
| <td></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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IndexWriterConfig_IndexCommit.md&value=---%0Auid%3A%20Lucene.Net.Index.IndexWriterConfig.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/fix/apidocs-layout/src/Lucene.Net/Index/IndexWriterConfig.cs/#L254">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IndexWriterConfig_IndexCommit_" data-uid="Lucene.Net.Index.IndexWriterConfig.IndexCommit*"></a> |
| <h4 id="Lucene_Net_Index_IndexWriterConfig_IndexCommit" data-uid="Lucene.Net.Index.IndexWriterConfig.IndexCommit">IndexCommit</h4> |
| <div class="markdown level1 summary"><p>Expert: allows to open a certain commit point. The default is <code>null</code> which |
| opens the latest commit point.</p> |
| <p><p>Only takes effect when <a class="xref" href="Lucene.Net.Index.IndexWriter.html">IndexWriter</a> is first created.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public IndexCommit IndexCommit { get; set; }</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><a class="xref" href="Lucene.Net.Index.IndexCommit.html">IndexCommit</a></td> |
| <td></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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IndexWriterConfig_IndexDeletionPolicy.md&value=---%0Auid%3A%20Lucene.Net.Index.IndexWriterConfig.IndexDeletionPolicy%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/fix/apidocs-layout/src/Lucene.Net/Index/IndexWriterConfig.cs/#L240">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IndexWriterConfig_IndexDeletionPolicy_" data-uid="Lucene.Net.Index.IndexWriterConfig.IndexDeletionPolicy*"></a> |
| <h4 id="Lucene_Net_Index_IndexWriterConfig_IndexDeletionPolicy" data-uid="Lucene.Net.Index.IndexWriterConfig.IndexDeletionPolicy">IndexDeletionPolicy</h4> |
| <div class="markdown level1 summary"><p>Expert: allows an optional <a class="xref" href="Lucene.Net.Index.IndexDeletionPolicy.html">IndexDeletionPolicy</a> implementation to be |
| specified. You can use this to control when prior commits are deleted from |
| the index. The default policy is <a class="xref" href="Lucene.Net.Index.KeepOnlyLastCommitDeletionPolicy.html">KeepOnlyLastCommitDeletionPolicy</a> |
| which removes all prior commits as soon as a new commit is done (this |
| matches behavior before 2.2). Creating your own policy can allow you to |
| explicitly keep previous "point in time" commits alive in the index for |
| some time, to allow readers to refresh to the new commit without having the |
| old commit deleted out from under them. This is necessary on filesystems |
| like NFS that do not support "delete on last close" semantics, which |
| Lucene's "point in time" search normally relies on. |
| <p> |
| <strong>NOTE:</strong> the deletion policy cannot be <code>null</code>.</p> |
| <p><p>Only takes effect when IndexWriter is first created.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public IndexDeletionPolicy IndexDeletionPolicy { get; set; }</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><a class="xref" href="Lucene.Net.Index.IndexDeletionPolicy.html">IndexDeletionPolicy</a></td> |
| <td></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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IndexWriterConfig_MaxThreadStates.md&value=---%0Auid%3A%20Lucene.Net.Index.IndexWriterConfig.MaxThreadStates%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/fix/apidocs-layout/src/Lucene.Net/Index/IndexWriterConfig.cs/#L380">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IndexWriterConfig_MaxThreadStates_" data-uid="Lucene.Net.Index.IndexWriterConfig.MaxThreadStates*"></a> |
| <h4 id="Lucene_Net_Index_IndexWriterConfig_MaxThreadStates" data-uid="Lucene.Net.Index.IndexWriterConfig.MaxThreadStates">MaxThreadStates</h4> |
| <div class="markdown level1 summary"><p>Gets or sets the max number of simultaneous threads that may be indexing documents |
| at once in <a class="xref" href="Lucene.Net.Index.IndexWriter.html">IndexWriter</a>. Values < 1 are invalid and if passed |
| <code>maxThreadStates</code> will be set to |
| <a class="xref" href="Lucene.Net.Index.IndexWriterConfig.html#Lucene_Net_Index_IndexWriterConfig_DEFAULT_MAX_THREAD_STATES">DEFAULT_MAX_THREAD_STATES</a>.</p> |
| <p><p>Only takes effect when <a class="xref" href="Lucene.Net.Index.IndexWriter.html">IndexWriter</a> is first created.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public int MaxThreadStates { get; set; }</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.Int32</span></td> |
| <td></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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IndexWriterConfig_MergePolicy.md&value=---%0Auid%3A%20Lucene.Net.Index.IndexWriterConfig.MergePolicy%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/fix/apidocs-layout/src/Lucene.Net/Index/IndexWriterConfig.cs/#L341">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IndexWriterConfig_MergePolicy_" data-uid="Lucene.Net.Index.IndexWriterConfig.MergePolicy*"></a> |
| <h4 id="Lucene_Net_Index_IndexWriterConfig_MergePolicy" data-uid="Lucene.Net.Index.IndexWriterConfig.MergePolicy">MergePolicy</h4> |
| <div class="markdown level1 summary"><p>Expert: <a class="xref" href="Lucene.Net.Index.MergePolicy.html">MergePolicy</a> is invoked whenever there are changes to the |
| segments in the index. Its role is to select which merges to do, if any, |
| and return a <a class="xref" href="Lucene.Net.Index.MergePolicy.MergeSpecification.html">MergePolicy.MergeSpecification</a> describing the merges. |
| It also selects merges to do for <a class="xref" href="Lucene.Net.Index.IndexWriter.html#Lucene_Net_Index_IndexWriter_ForceMerge_System_Int32_">ForceMerge(Int32)</a>.</p> |
| <p><p>Only takes effect when <a class="xref" href="Lucene.Net.Index.IndexWriter.html">IndexWriter</a> is first created.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public MergePolicy MergePolicy { get; set; }</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><a class="xref" href="Lucene.Net.Index.MergePolicy.html">MergePolicy</a></td> |
| <td></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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IndexWriterConfig_MergeScheduler.md&value=---%0Auid%3A%20Lucene.Net.Index.IndexWriterConfig.MergeScheduler%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/fix/apidocs-layout/src/Lucene.Net/Index/IndexWriterConfig.cs/#L297">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IndexWriterConfig_MergeScheduler_" data-uid="Lucene.Net.Index.IndexWriterConfig.MergeScheduler*"></a> |
| <h4 id="Lucene_Net_Index_IndexWriterConfig_MergeScheduler" data-uid="Lucene.Net.Index.IndexWriterConfig.MergeScheduler">MergeScheduler</h4> |
| <div class="markdown level1 summary"><p>Expert: Gets or sets the merge scheduler used by this writer. The default is |
| <a class="xref" href="Lucene.Net.Index.ConcurrentMergeScheduler.html">ConcurrentMergeScheduler</a>. |
| <p> |
| <strong>NOTE:</strong> the merge scheduler cannot be <code>null</code>.</p> |
| <p><p>Only takes effect when <a class="xref" href="Lucene.Net.Index.IndexWriter.html">IndexWriter</a> is first created.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public IMergeScheduler MergeScheduler { get; set; }</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><a class="xref" href="Lucene.Net.Index.IMergeScheduler.html">IMergeScheduler</a></td> |
| <td></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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IndexWriterConfig_OpenMode.md&value=---%0Auid%3A%20Lucene.Net.Index.IndexWriterConfig.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/fix/apidocs-layout/src/Lucene.Net/Index/IndexWriterConfig.cs/#L210">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IndexWriterConfig_OpenMode_" data-uid="Lucene.Net.Index.IndexWriterConfig.OpenMode*"></a> |
| <h4 id="Lucene_Net_Index_IndexWriterConfig_OpenMode" data-uid="Lucene.Net.Index.IndexWriterConfig.OpenMode">OpenMode</h4> |
| <div class="markdown level1 summary"><p>Specifies <a class="xref" href="Lucene.Net.Index.OpenMode.html">OpenMode</a> of the index.</p> |
| <p><p>Only takes effect when <a class="xref" href="Lucene.Net.Index.IndexWriter.html">IndexWriter</a> is first created.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public OpenMode OpenMode { get; set; }</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><a class="xref" href="Lucene.Net.Index.OpenMode.html">OpenMode</a></td> |
| <td></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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IndexWriterConfig_RAMPerThreadHardLimitMB.md&value=---%0Auid%3A%20Lucene.Net.Index.IndexWriterConfig.RAMPerThreadHardLimitMB%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/fix/apidocs-layout/src/Lucene.Net/Index/IndexWriterConfig.cs/#L441">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IndexWriterConfig_RAMPerThreadHardLimitMB_" data-uid="Lucene.Net.Index.IndexWriterConfig.RAMPerThreadHardLimitMB*"></a> |
| <h4 id="Lucene_Net_Index_IndexWriterConfig_RAMPerThreadHardLimitMB" data-uid="Lucene.Net.Index.IndexWriterConfig.RAMPerThreadHardLimitMB">RAMPerThreadHardLimitMB</h4> |
| <div class="markdown level1 summary"><p>Expert: Gets or sets the maximum memory consumption per thread triggering a forced |
| flush if exceeded. A <span class="xref">Lucene.Net.Index.DocumentsWriterPerThread</span> is forcefully flushed |
| once it exceeds this limit even if the <a class="xref" href="Lucene.Net.Index.LiveIndexWriterConfig.html#Lucene_Net_Index_LiveIndexWriterConfig_RAMBufferSizeMB">RAMBufferSizeMB</a> has |
| not been exceeded. This is a safety limit to prevent a |
| <span class="xref">Lucene.Net.Index.DocumentsWriterPerThread</span> from address space exhaustion due to its |
| internal 32 bit signed integer based memory addressing. |
| The given value must be less that 2GB (2048MB).</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public int RAMPerThreadHardLimitMB { get; set; }</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.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Index_IndexWriterConfig_RAMPerThreadHardLimitMB_seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Index.IndexWriterConfig.html#Lucene_Net_Index_IndexWriterConfig_DEFAULT_RAM_PER_THREAD_HARD_LIMIT_MB">DEFAULT_RAM_PER_THREAD_HARD_LIMIT_MB</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IndexWriterConfig_Similarity.md&value=---%0Auid%3A%20Lucene.Net.Index.IndexWriterConfig.Similarity%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/fix/apidocs-layout/src/Lucene.Net/Index/IndexWriterConfig.cs/#L269">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IndexWriterConfig_Similarity_" data-uid="Lucene.Net.Index.IndexWriterConfig.Similarity*"></a> |
| <h4 id="Lucene_Net_Index_IndexWriterConfig_Similarity" data-uid="Lucene.Net.Index.IndexWriterConfig.Similarity">Similarity</h4> |
| <div class="markdown level1 summary"><p>Expert: set the <a class="xref" href="Lucene.Net.Search.Similarities.Similarity.html">Similarity</a> implementation used by this <a class="xref" href="Lucene.Net.Index.IndexWriter.html">IndexWriter</a>. |
| <p> |
| <strong>NOTE:</strong> the similarity cannot be <code>null</code>.</p> |
| <p><p>Only takes effect when <a class="xref" href="Lucene.Net.Index.IndexWriter.html">IndexWriter</a> is first created.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public Similarity Similarity { get; set; }</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><a class="xref" href="Lucene.Net.Search.Similarities.Similarity.html">Similarity</a></td> |
| <td></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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IndexWriterConfig_UseReaderPooling.md&value=---%0Auid%3A%20Lucene.Net.Index.IndexWriterConfig.UseReaderPooling%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/fix/apidocs-layout/src/Lucene.Net/Index/IndexWriterConfig.cs/#L410">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IndexWriterConfig_UseReaderPooling_" data-uid="Lucene.Net.Index.IndexWriterConfig.UseReaderPooling*"></a> |
| <h4 id="Lucene_Net_Index_IndexWriterConfig_UseReaderPooling" data-uid="Lucene.Net.Index.IndexWriterConfig.UseReaderPooling">UseReaderPooling</h4> |
| <div class="markdown level1 summary"><p>By default, <a class="xref" href="Lucene.Net.Index.IndexWriter.html">IndexWriter</a> does not pool the |
| <a class="xref" href="Lucene.Net.Index.SegmentReader.html">SegmentReader</a>s it must open for deletions and |
| merging, unless a near-real-time reader has been |
| obtained by calling <a class="xref" href="Lucene.Net.Index.DirectoryReader.html#Lucene_Net_Index_DirectoryReader_Open_Lucene_Net_Index_IndexWriter_System_Boolean_">Open(IndexWriter, Boolean)</a>. |
| this setting lets you enable pooling without getting a |
| near-real-time reader. NOTE: if you set this to |
| <code>false</code>, <a class="xref" href="Lucene.Net.Index.IndexWriter.html">IndexWriter</a> will still pool readers once |
| <a class="xref" href="Lucene.Net.Index.DirectoryReader.html#Lucene_Net_Index_DirectoryReader_Open_Lucene_Net_Index_IndexWriter_System_Boolean_">Open(IndexWriter, Boolean)</a> is called.</p> |
| <p><p>Only takes effect when <a class="xref" href="Lucene.Net.Index.IndexWriter.html">IndexWriter</a> is first created.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public bool UseReaderPooling { get; set; }</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.Boolean</span></td> |
| <td></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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IndexWriterConfig_WriteLockTimeout.md&value=---%0Auid%3A%20Lucene.Net.Index.IndexWriterConfig.WriteLockTimeout%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/fix/apidocs-layout/src/Lucene.Net/Index/IndexWriterConfig.cs/#L312">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IndexWriterConfig_WriteLockTimeout_" data-uid="Lucene.Net.Index.IndexWriterConfig.WriteLockTimeout*"></a> |
| <h4 id="Lucene_Net_Index_IndexWriterConfig_WriteLockTimeout" data-uid="Lucene.Net.Index.IndexWriterConfig.WriteLockTimeout">WriteLockTimeout</h4> |
| <div class="markdown level1 summary"><p>Gets or sets the maximum time to wait for a write lock (in milliseconds) for this |
| instance. You can change the default value for all instances by calling the |
| <a class="xref" href="Lucene.Net.Index.IndexWriterConfig.html#Lucene_Net_Index_IndexWriterConfig_DefaultWriteLockTimeout">DefaultWriteLockTimeout</a> setter.</p> |
| <p><p>Only takes effect when <a class="xref" href="Lucene.Net.Index.IndexWriter.html">IndexWriter</a> is first created.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public long WriteLockTimeout { get; set; }</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.Int64</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IndexWriterConfig_Clone.md&value=---%0Auid%3A%20Lucene.Net.Index.IndexWriterConfig.Clone%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/fix/apidocs-layout/src/Lucene.Net/Index/IndexWriterConfig.cs/#L180">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IndexWriterConfig_Clone_" data-uid="Lucene.Net.Index.IndexWriterConfig.Clone*"></a> |
| <h4 id="Lucene_Net_Index_IndexWriterConfig_Clone" data-uid="Lucene.Net.Index.IndexWriterConfig.Clone">Clone()</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public object Clone()</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><span class="xref">System.Object</span></td> |
| <td></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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IndexWriterConfig_SetInfoStream_Lucene_Net_Util_InfoStream_.md&value=---%0Auid%3A%20Lucene.Net.Index.IndexWriterConfig.SetInfoStream(Lucene.Net.Util.InfoStream)%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/fix/apidocs-layout/src/Lucene.Net/Index/IndexWriterConfig.cs/#L542">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IndexWriterConfig_SetInfoStream_" data-uid="Lucene.Net.Index.IndexWriterConfig.SetInfoStream*"></a> |
| <h4 id="Lucene_Net_Index_IndexWriterConfig_SetInfoStream_Lucene_Net_Util_InfoStream_" data-uid="Lucene.Net.Index.IndexWriterConfig.SetInfoStream(Lucene.Net.Util.InfoStream)">SetInfoStream(InfoStream)</h4> |
| <div class="markdown level1 summary"><p>Information about merges, deletes and a |
| message when maxFieldLength is reached will be printed |
| to this. Must not be <code>null</code>, but <a class="xref" href="Lucene.Net.Util.InfoStream.html#Lucene_Net_Util_InfoStream_NO_OUTPUT">NO_OUTPUT</a> |
| may be used to supress output.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public IndexWriterConfig SetInfoStream(InfoStream infoStream)</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.Util.InfoStream.html">InfoStream</a></td> |
| <td><span class="parametername">infoStream</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <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.IndexWriterConfig.html">IndexWriterConfig</a></td> |
| <td></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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IndexWriterConfig_SetInfoStream_System_IO_TextWriter_.md&value=---%0Auid%3A%20Lucene.Net.Index.IndexWriterConfig.SetInfoStream(System.IO.TextWriter)%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/fix/apidocs-layout/src/Lucene.Net/Index/IndexWriterConfig.cs/#L554">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IndexWriterConfig_SetInfoStream_" data-uid="Lucene.Net.Index.IndexWriterConfig.SetInfoStream*"></a> |
| <h4 id="Lucene_Net_Index_IndexWriterConfig_SetInfoStream_System_IO_TextWriter_" data-uid="Lucene.Net.Index.IndexWriterConfig.SetInfoStream(System.IO.TextWriter)">SetInfoStream(TextWriter)</h4> |
| <div class="markdown level1 summary"><p>Convenience method that uses <a class="xref" href="Lucene.Net.Util.TextWriterInfoStream.html">TextWriterInfoStream</a> to write to the passed in <span class="xref">System.IO.TextWriter</span>. |
| Must not be <code>null</code>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public IndexWriterConfig SetInfoStream(TextWriter printStream)</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.IO.TextWriter</span></td> |
| <td><span class="parametername">printStream</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <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.IndexWriterConfig.html">IndexWriterConfig</a></td> |
| <td></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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IndexWriterConfig_ToString.md&value=---%0Auid%3A%20Lucene.Net.Index.IndexWriterConfig.ToString%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/fix/apidocs-layout/src/Lucene.Net/Index/IndexWriterConfig.cs/#L606">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IndexWriterConfig_ToString_" data-uid="Lucene.Net.Index.IndexWriterConfig.ToString*"></a> |
| <h4 id="Lucene_Net_Index_IndexWriterConfig_ToString" data-uid="Lucene.Net.Index.IndexWriterConfig.ToString">ToString()</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public override string ToString()</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><span class="xref">System.String</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Index.LiveIndexWriterConfig.html#Lucene_Net_Index_LiveIndexWriterConfig_ToString">LiveIndexWriterConfig.ToString()</a></div> |
| <h3 id="extensionmethods">Extension Methods</h3> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.Extensions.IndexWriterConfigExtensions.html#Lucene_Net_Index_Extensions_IndexWriterConfigExtensions_SetTermIndexInterval_Lucene_Net_Index_LiveIndexWriterConfig_System_Int32_">IndexWriterConfigExtensions.SetTermIndexInterval(LiveIndexWriterConfig, Int32)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.Extensions.IndexWriterConfigExtensions.html#Lucene_Net_Index_Extensions_IndexWriterConfigExtensions_SetMaxBufferedDeleteTerms_Lucene_Net_Index_LiveIndexWriterConfig_System_Int32_">IndexWriterConfigExtensions.SetMaxBufferedDeleteTerms(LiveIndexWriterConfig, Int32)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.Extensions.IndexWriterConfigExtensions.html#Lucene_Net_Index_Extensions_IndexWriterConfigExtensions_SetRAMBufferSizeMB_Lucene_Net_Index_LiveIndexWriterConfig_System_Double_">IndexWriterConfigExtensions.SetRAMBufferSizeMB(LiveIndexWriterConfig, Double)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.Extensions.IndexWriterConfigExtensions.html#Lucene_Net_Index_Extensions_IndexWriterConfigExtensions_SetMaxBufferedDocs_Lucene_Net_Index_LiveIndexWriterConfig_System_Int32_">IndexWriterConfigExtensions.SetMaxBufferedDocs(LiveIndexWriterConfig, Int32)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.Extensions.IndexWriterConfigExtensions.html#Lucene_Net_Index_Extensions_IndexWriterConfigExtensions_SetMergedSegmentWarmer_Lucene_Net_Index_LiveIndexWriterConfig_Lucene_Net_Index_IndexWriter_IndexReaderWarmer_">IndexWriterConfigExtensions.SetMergedSegmentWarmer(LiveIndexWriterConfig, IndexWriter.IndexReaderWarmer)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.Extensions.IndexWriterConfigExtensions.html#Lucene_Net_Index_Extensions_IndexWriterConfigExtensions_SetReaderTermsIndexDivisor_Lucene_Net_Index_LiveIndexWriterConfig_System_Int32_">IndexWriterConfigExtensions.SetReaderTermsIndexDivisor(LiveIndexWriterConfig, Int32)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.Extensions.IndexWriterConfigExtensions.html#Lucene_Net_Index_Extensions_IndexWriterConfigExtensions_SetUseCompoundFile_Lucene_Net_Index_LiveIndexWriterConfig_System_Boolean_">IndexWriterConfigExtensions.SetUseCompoundFile(LiveIndexWriterConfig, Boolean)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.Extensions.IndexWriterConfigExtensions.html#Lucene_Net_Index_Extensions_IndexWriterConfigExtensions_SetCheckIntegrityAtMerge_Lucene_Net_Index_LiveIndexWriterConfig_System_Boolean_">IndexWriterConfigExtensions.SetCheckIntegrityAtMerge(LiveIndexWriterConfig, Boolean)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.Extensions.IndexWriterConfigExtensions.html#Lucene_Net_Index_Extensions_IndexWriterConfigExtensions_SetTermIndexInterval_Lucene_Net_Index_IndexWriterConfig_System_Int32_">IndexWriterConfigExtensions.SetTermIndexInterval(IndexWriterConfig, Int32)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.Extensions.IndexWriterConfigExtensions.html#Lucene_Net_Index_Extensions_IndexWriterConfigExtensions_SetMaxBufferedDeleteTerms_Lucene_Net_Index_IndexWriterConfig_System_Int32_">IndexWriterConfigExtensions.SetMaxBufferedDeleteTerms(IndexWriterConfig, Int32)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.Extensions.IndexWriterConfigExtensions.html#Lucene_Net_Index_Extensions_IndexWriterConfigExtensions_SetRAMBufferSizeMB_Lucene_Net_Index_IndexWriterConfig_System_Double_">IndexWriterConfigExtensions.SetRAMBufferSizeMB(IndexWriterConfig, Double)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.Extensions.IndexWriterConfigExtensions.html#Lucene_Net_Index_Extensions_IndexWriterConfigExtensions_SetMaxBufferedDocs_Lucene_Net_Index_IndexWriterConfig_System_Int32_">IndexWriterConfigExtensions.SetMaxBufferedDocs(IndexWriterConfig, Int32)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.Extensions.IndexWriterConfigExtensions.html#Lucene_Net_Index_Extensions_IndexWriterConfigExtensions_SetMergedSegmentWarmer_Lucene_Net_Index_IndexWriterConfig_Lucene_Net_Index_IndexWriter_IndexReaderWarmer_">IndexWriterConfigExtensions.SetMergedSegmentWarmer(IndexWriterConfig, IndexWriter.IndexReaderWarmer)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.Extensions.IndexWriterConfigExtensions.html#Lucene_Net_Index_Extensions_IndexWriterConfigExtensions_SetReaderTermsIndexDivisor_Lucene_Net_Index_IndexWriterConfig_System_Int32_">IndexWriterConfigExtensions.SetReaderTermsIndexDivisor(IndexWriterConfig, Int32)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.Extensions.IndexWriterConfigExtensions.html#Lucene_Net_Index_Extensions_IndexWriterConfigExtensions_SetUseCompoundFile_Lucene_Net_Index_IndexWriterConfig_System_Boolean_">IndexWriterConfigExtensions.SetUseCompoundFile(IndexWriterConfig, Boolean)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.Extensions.IndexWriterConfigExtensions.html#Lucene_Net_Index_Extensions_IndexWriterConfigExtensions_SetCheckIntegrityAtMerge_Lucene_Net_Index_IndexWriterConfig_System_Boolean_">IndexWriterConfigExtensions.SetCheckIntegrityAtMerge(IndexWriterConfig, Boolean)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.Extensions.IndexWriterConfigExtensions.html#Lucene_Net_Index_Extensions_IndexWriterConfigExtensions_SetDefaultWriteLockTimeout_Lucene_Net_Index_IndexWriterConfig_System_Int64_">IndexWriterConfigExtensions.SetDefaultWriteLockTimeout(IndexWriterConfig, Int64)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.Extensions.IndexWriterConfigExtensions.html#Lucene_Net_Index_Extensions_IndexWriterConfigExtensions_SetOpenMode_Lucene_Net_Index_IndexWriterConfig_Lucene_Net_Index_OpenMode_">IndexWriterConfigExtensions.SetOpenMode(IndexWriterConfig, OpenMode)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.Extensions.IndexWriterConfigExtensions.html#Lucene_Net_Index_Extensions_IndexWriterConfigExtensions_SetIndexDeletionPolicy_Lucene_Net_Index_IndexWriterConfig_Lucene_Net_Index_IndexDeletionPolicy_">IndexWriterConfigExtensions.SetIndexDeletionPolicy(IndexWriterConfig, IndexDeletionPolicy)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.Extensions.IndexWriterConfigExtensions.html#Lucene_Net_Index_Extensions_IndexWriterConfigExtensions_SetIndexCommit_Lucene_Net_Index_IndexWriterConfig_Lucene_Net_Index_IndexCommit_">IndexWriterConfigExtensions.SetIndexCommit(IndexWriterConfig, IndexCommit)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.Extensions.IndexWriterConfigExtensions.html#Lucene_Net_Index_Extensions_IndexWriterConfigExtensions_SetSimilarity_Lucene_Net_Index_IndexWriterConfig_Lucene_Net_Search_Similarities_Similarity_">IndexWriterConfigExtensions.SetSimilarity(IndexWriterConfig, Similarity)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.Extensions.IndexWriterConfigExtensions.html#Lucene_Net_Index_Extensions_IndexWriterConfigExtensions_SetMergeScheduler_Lucene_Net_Index_IndexWriterConfig_Lucene_Net_Index_IMergeScheduler_">IndexWriterConfigExtensions.SetMergeScheduler(IndexWriterConfig, IMergeScheduler)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.Extensions.IndexWriterConfigExtensions.html#Lucene_Net_Index_Extensions_IndexWriterConfigExtensions_SetWriteLockTimeout_Lucene_Net_Index_IndexWriterConfig_System_Int64_">IndexWriterConfigExtensions.SetWriteLockTimeout(IndexWriterConfig, Int64)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.Extensions.IndexWriterConfigExtensions.html#Lucene_Net_Index_Extensions_IndexWriterConfigExtensions_SetMergePolicy_Lucene_Net_Index_IndexWriterConfig_Lucene_Net_Index_MergePolicy_">IndexWriterConfigExtensions.SetMergePolicy(IndexWriterConfig, MergePolicy)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.Extensions.IndexWriterConfigExtensions.html#Lucene_Net_Index_Extensions_IndexWriterConfigExtensions_SetCodec_Lucene_Net_Index_IndexWriterConfig_Lucene_Net_Codecs_Codec_">IndexWriterConfigExtensions.SetCodec(IndexWriterConfig, Codec)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.Extensions.IndexWriterConfigExtensions.html#Lucene_Net_Index_Extensions_IndexWriterConfigExtensions_SetMaxThreadStates_Lucene_Net_Index_IndexWriterConfig_System_Int32_">IndexWriterConfigExtensions.SetMaxThreadStates(IndexWriterConfig, Int32)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.Extensions.IndexWriterConfigExtensions.html#Lucene_Net_Index_Extensions_IndexWriterConfigExtensions_SetReaderPooling_Lucene_Net_Index_IndexWriterConfig_System_Boolean_">IndexWriterConfigExtensions.SetReaderPooling(IndexWriterConfig, Boolean)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.Extensions.IndexWriterConfigExtensions.html#Lucene_Net_Index_Extensions_IndexWriterConfigExtensions_SetRAMPerThreadHardLimitMB_Lucene_Net_Index_IndexWriterConfig_System_Int32_">IndexWriterConfigExtensions.SetRAMPerThreadHardLimitMB(IndexWriterConfig, Int32)</a> |
| </div> |
| <h3 id="seealso">See Also</h3> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Index.IndexWriter.html#Lucene_Net_Index_IndexWriter_Config">Config</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IndexWriterConfig.md&value=---%0Auid%3A%20Lucene.Net.Index.IndexWriterConfig%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/fix/apidocs-layout/src/Lucene.Net/Index/IndexWriterConfig.cs/#L67" 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 The Apache Software Foundation, Licensed under the <a href='http://www.apache.org/licenses/LICENSE-2.0' target='_blank'>Apache License, Version 2.0</a><br> <small>Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation. <br>All other marks mentioned may be trademarks or registered trademarks of their respective owners.</small> |
| |
| </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> |
