blob: fa5c2155070a20b6d943091e32ee8871ec363fef [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class LiveIndexWriterConfig
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class LiveIndexWriterConfig
| 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.LiveIndexWriterConfig">
<h1 id="Lucene_Net_Index_LiveIndexWriterConfig" data-uid="Lucene.Net.Index.LiveIndexWriterConfig" class="text-break">Class LiveIndexWriterConfig
</h1>
<div class="markdown level0 summary"><p>Holds all the configuration used by <a class="xref" href="Lucene.Net.Index.IndexWriter.html">IndexWriter</a> with few setters for
settings that can be changed on an <a class="xref" href="Lucene.Net.Index.IndexWriter.html">IndexWriter</a> instance &quot;live&quot;.</p>
<p>@since 4.0</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"><span class="xref">LiveIndexWriterConfig</span></div>
<div class="level2"><a class="xref" href="Lucene.Net.Index.IndexWriterConfig.html">IndexWriterConfig</a></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<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_LiveIndexWriterConfig_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[Serializable]
public class LiveIndexWriterConfig</code></pre>
</div>
<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_LiveIndexWriterConfig_Analyzer.md&amp;value=---%0Auid%3A%20Lucene.Net.Index.LiveIndexWriterConfig.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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/LiveIndexWriterConfig.cs/#L210">View Source</a>
</span>
<a id="Lucene_Net_Index_LiveIndexWriterConfig_Analyzer_" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.Analyzer*"></a>
<h4 id="Lucene_Net_Index_LiveIndexWriterConfig_Analyzer" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.Analyzer">Analyzer</h4>
<div class="markdown level1 summary"><p>Gets the default analyzer to use for indexing documents. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual Analyzer Analyzer { 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><a class="xref" href="Lucene.Net.Analysis.Analyzer.html">Analyzer</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_LiveIndexWriterConfig_CheckIntegrityAtMerge.md&amp;value=---%0Auid%3A%20Lucene.Net.Index.LiveIndexWriterConfig.CheckIntegrityAtMerge%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/LiveIndexWriterConfig.cs/#L573">View Source</a>
</span>
<a id="Lucene_Net_Index_LiveIndexWriterConfig_CheckIntegrityAtMerge_" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.CheckIntegrityAtMerge*"></a>
<h4 id="Lucene_Net_Index_LiveIndexWriterConfig_CheckIntegrityAtMerge" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.CheckIntegrityAtMerge">CheckIntegrityAtMerge</h4>
<div class="markdown level1 summary"><p>Gets or sets if <a class="xref" href="Lucene.Net.Index.IndexWriter.html">IndexWriter</a> should call <a class="xref" href="Lucene.Net.Index.AtomicReader.html#Lucene_Net_Index_AtomicReader_CheckIntegrity">CheckIntegrity()</a>
on existing segments before merging them into a new one.
<p>
Use <code>true</code> to enable this safety check, which can help
reduce the risk of propagating index corruption from older segments
into new ones, at the expense of slower merging.
</p></p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual bool CheckIntegrityAtMerge { 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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_LiveIndexWriterConfig_Codec.md&amp;value=---%0Auid%3A%20Lucene.Net.Index.LiveIndexWriterConfig.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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/LiveIndexWriterConfig.cs/#L483">View Source</a>
</span>
<a id="Lucene_Net_Index_LiveIndexWriterConfig_Codec_" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.Codec*"></a>
<h4 id="Lucene_Net_Index_LiveIndexWriterConfig_Codec" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.Codec">Codec</h4>
<div class="markdown level1 summary"><p>Returns the current <a class="xref" href="Lucene.Net.Codecs.Codec.html">Codec</a>. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual Codec Codec { 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><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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_LiveIndexWriterConfig_IndexCommit.md&amp;value=---%0Auid%3A%20Lucene.Net.Index.LiveIndexWriterConfig.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/LiveIndexWriterConfig.cs/#L461">View Source</a>
</span>
<a id="Lucene_Net_Index_LiveIndexWriterConfig_IndexCommit_" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.IndexCommit*"></a>
<h4 id="Lucene_Net_Index_LiveIndexWriterConfig_IndexCommit" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.IndexCommit">IndexCommit</h4>
<div class="markdown level1 summary"><p>Gets the <a class="xref" href="Lucene.Net.Index.LiveIndexWriterConfig.html#Lucene_Net_Index_LiveIndexWriterConfig_IndexCommit">IndexCommit</a> as specified in
<a class="xref" href="Lucene.Net.Index.IndexWriterConfig.html#Lucene_Net_Index_IndexWriterConfig_IndexCommit">IndexCommit</a> setter or the default,
<code>null</code> which specifies to open the latest index commit point.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual IndexCommit IndexCommit { 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><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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_LiveIndexWriterConfig_IndexDeletionPolicy.md&amp;value=---%0Auid%3A%20Lucene.Net.Index.LiveIndexWriterConfig.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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/LiveIndexWriterConfig.cs/#L454">View Source</a>
</span>
<a id="Lucene_Net_Index_LiveIndexWriterConfig_IndexDeletionPolicy_" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.IndexDeletionPolicy*"></a>
<h4 id="Lucene_Net_Index_LiveIndexWriterConfig_IndexDeletionPolicy" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.IndexDeletionPolicy">IndexDeletionPolicy</h4>
<div class="markdown level1 summary"><p>Gets the <a class="xref" href="Lucene.Net.Index.IndexDeletionPolicy.html">IndexDeletionPolicy</a> specified in
<a class="xref" href="Lucene.Net.Index.IndexWriterConfig.html#Lucene_Net_Index_IndexWriterConfig_IndexDeletionPolicy">IndexDeletionPolicy</a> setter or
the default <a class="xref" href="Lucene.Net.Index.KeepOnlyLastCommitDeletionPolicy.html">KeepOnlyLastCommitDeletionPolicy</a></p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual IndexDeletionPolicy IndexDeletionPolicy { 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><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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_LiveIndexWriterConfig_InfoStream.md&amp;value=---%0Auid%3A%20Lucene.Net.Index.LiveIndexWriterConfig.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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/LiveIndexWriterConfig.cs/#L542">View Source</a>
</span>
<a id="Lucene_Net_Index_LiveIndexWriterConfig_InfoStream_" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.InfoStream*"></a>
<h4 id="Lucene_Net_Index_LiveIndexWriterConfig_InfoStream" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.InfoStream">InfoStream</h4>
<div class="markdown level1 summary"><p>Returns <a class="xref" href="Lucene.Net.Util.InfoStream.html">InfoStream</a> used for debugging.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual InfoStream InfoStream { 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><a class="xref" href="Lucene.Net.Util.InfoStream.html">InfoStream</a></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Lucene_Net_Index_LiveIndexWriterConfig_InfoStream_seealso">See Also</h5>
<div class="seealso">
<div><a class="xref" href="Lucene.Net.Index.IndexWriterConfig.html#Lucene_Net_Index_IndexWriterConfig_SetInfoStream_Lucene_Net_Util_InfoStream_">SetInfoStream(InfoStream)</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_LiveIndexWriterConfig_MaxBufferedDeleteTerms.md&amp;value=---%0Auid%3A%20Lucene.Net.Index.LiveIndexWriterConfig.MaxBufferedDeleteTerms%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/LiveIndexWriterConfig.cs/#L289">View Source</a>
</span>
<a id="Lucene_Net_Index_LiveIndexWriterConfig_MaxBufferedDeleteTerms_" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.MaxBufferedDeleteTerms*"></a>
<h4 id="Lucene_Net_Index_LiveIndexWriterConfig_MaxBufferedDeleteTerms" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.MaxBufferedDeleteTerms">MaxBufferedDeleteTerms</h4>
<div class="markdown level1 summary"><p>Gets or sets a value that determines the maximum number of delete-by-term operations that will be
buffered before both the buffered in-memory delete terms and queries are
applied and flushed.
<p>
Disabled by default (writer flushes by RAM usage).
<p>
NOTE: this setting won&apos;t trigger a segment flush.</p>
<p><p>
Takes effect immediately, but only the next time a document is added,
updated or deleted. Also, if you only delete-by-query, this setting has no
effect, i.e. delete queries are buffered until the next segment is flushed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual int MaxBufferedDeleteTerms { 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 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.ArgumentException</span></td>
<td><p>if maxBufferedDeleteTerms is enabled but smaller than 1</p>
</td>
</tr>
</tbody>
</table>
<h5 id="Lucene_Net_Index_LiveIndexWriterConfig_MaxBufferedDeleteTerms_seealso">See Also</h5>
<div class="seealso">
<div><a class="xref" href="Lucene.Net.Index.LiveIndexWriterConfig.html#Lucene_Net_Index_LiveIndexWriterConfig_RAMBufferSizeMB">RAMBufferSizeMB</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_LiveIndexWriterConfig_MaxBufferedDocs.md&amp;value=---%0Auid%3A%20Lucene.Net.Index.LiveIndexWriterConfig.MaxBufferedDocs%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/LiveIndexWriterConfig.cs/#L388">View Source</a>
</span>
<a id="Lucene_Net_Index_LiveIndexWriterConfig_MaxBufferedDocs_" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.MaxBufferedDocs*"></a>
<h4 id="Lucene_Net_Index_LiveIndexWriterConfig_MaxBufferedDocs" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.MaxBufferedDocs">MaxBufferedDocs</h4>
<div class="markdown level1 summary"><p>Gets or sets a value that determines the minimal number of documents required before the buffered
in-memory documents are flushed as a new Segment. Large values generally
give faster indexing.</p>
<p><p>
When this is set, the writer will flush every maxBufferedDocs added
documents. Pass in <a class="xref" href="Lucene.Net.Index.IndexWriterConfig.html#Lucene_Net_Index_IndexWriterConfig_DISABLE_AUTO_FLUSH">DISABLE_AUTO_FLUSH</a> to prevent
triggering a flush due to number of buffered documents. Note that if
flushing by RAM usage is also enabled, then the flush will be triggered by
whichever comes first.</p>
<p><p>
Disabled by default (writer flushes by RAM usage).</p>
<p><p>
Takes effect immediately, but only the next time a document is added,
updated or deleted.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual int MaxBufferedDocs { 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 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.ArgumentException</span></td>
<td><p>if maxBufferedDocs is enabled but smaller than 2, or it disables
maxBufferedDocs when ramBufferSizeMB is already disabled </p>
</td>
</tr>
</tbody>
</table>
<h5 id="Lucene_Net_Index_LiveIndexWriterConfig_MaxBufferedDocs_seealso">See Also</h5>
<div class="seealso">
<div><a class="xref" href="Lucene.Net.Index.LiveIndexWriterConfig.html#Lucene_Net_Index_LiveIndexWriterConfig_RAMBufferSizeMB">RAMBufferSizeMB</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_LiveIndexWriterConfig_MaxThreadStates.md&amp;value=---%0Auid%3A%20Lucene.Net.Index.LiveIndexWriterConfig.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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/LiveIndexWriterConfig.cs/#L501">View Source</a>
</span>
<a id="Lucene_Net_Index_LiveIndexWriterConfig_MaxThreadStates_" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.MaxThreadStates*"></a>
<h4 id="Lucene_Net_Index_LiveIndexWriterConfig_MaxThreadStates" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.MaxThreadStates">MaxThreadStates</h4>
<div class="markdown level1 summary"><p>Returns 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>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual int MaxThreadStates { 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.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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_LiveIndexWriterConfig_MergedSegmentWarmer.md&amp;value=---%0Auid%3A%20Lucene.Net.Index.LiveIndexWriterConfig.MergedSegmentWarmer%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/LiveIndexWriterConfig.cs/#L410">View Source</a>
</span>
<a id="Lucene_Net_Index_LiveIndexWriterConfig_MergedSegmentWarmer_" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.MergedSegmentWarmer*"></a>
<h4 id="Lucene_Net_Index_LiveIndexWriterConfig_MergedSegmentWarmer" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.MergedSegmentWarmer">MergedSegmentWarmer</h4>
<div class="markdown level1 summary"><p>Gets or sets the merged segment warmer. See <a class="xref" href="Lucene.Net.Index.IndexWriter.IndexReaderWarmer.html">IndexWriter.IndexReaderWarmer</a>.
<p>
Takes effect on the next merge.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual IndexWriter.IndexReaderWarmer MergedSegmentWarmer { 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.IndexWriter.IndexReaderWarmer.html">IndexWriter.IndexReaderWarmer</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_LiveIndexWriterConfig_MergePolicy.md&amp;value=---%0Auid%3A%20Lucene.Net.Index.LiveIndexWriterConfig.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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/LiveIndexWriterConfig.cs/#L489">View Source</a>
</span>
<a id="Lucene_Net_Index_LiveIndexWriterConfig_MergePolicy_" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.MergePolicy*"></a>
<h4 id="Lucene_Net_Index_LiveIndexWriterConfig_MergePolicy" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.MergePolicy">MergePolicy</h4>
<div class="markdown level1 summary"><p>Returns the current <a class="xref" href="Lucene.Net.Index.MergePolicy.html">MergePolicy</a> in use by this writer.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual MergePolicy MergePolicy { 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><a class="xref" href="Lucene.Net.Index.MergePolicy.html">MergePolicy</a></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Lucene_Net_Index_LiveIndexWriterConfig_MergePolicy_seealso">See Also</h5>
<div class="seealso">
<div><a class="xref" href="Lucene.Net.Index.IndexWriterConfig.html#Lucene_Net_Index_IndexWriterConfig_MergePolicy">MergePolicy</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_LiveIndexWriterConfig_MergeScheduler.md&amp;value=---%0Auid%3A%20Lucene.Net.Index.LiveIndexWriterConfig.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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/LiveIndexWriterConfig.cs/#L473">View Source</a>
</span>
<a id="Lucene_Net_Index_LiveIndexWriterConfig_MergeScheduler_" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.MergeScheduler*"></a>
<h4 id="Lucene_Net_Index_LiveIndexWriterConfig_MergeScheduler" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.MergeScheduler">MergeScheduler</h4>
<div class="markdown level1 summary"><p>Returns the <a class="xref" href="Lucene.Net.Index.IMergeScheduler.html">IMergeScheduler</a> that was set by
<a class="xref" href="Lucene.Net.Index.IndexWriterConfig.html#Lucene_Net_Index_IndexWriterConfig_MergeScheduler">MergeScheduler</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 virtual IMergeScheduler MergeScheduler { 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><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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_LiveIndexWriterConfig_OpenMode.md&amp;value=---%0Auid%3A%20Lucene.Net.Index.LiveIndexWriterConfig.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/LiveIndexWriterConfig.cs/#L447">View Source</a>
</span>
<a id="Lucene_Net_Index_LiveIndexWriterConfig_OpenMode_" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.OpenMode*"></a>
<h4 id="Lucene_Net_Index_LiveIndexWriterConfig_OpenMode" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.OpenMode">OpenMode</h4>
<div class="markdown level1 summary"><p>Gets the <a class="xref" href="Lucene.Net.Index.OpenMode.html">OpenMode</a> set by <a class="xref" href="Lucene.Net.Index.IndexWriterConfig.html#Lucene_Net_Index_IndexWriterConfig_OpenMode">OpenMode</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 virtual OpenMode OpenMode { 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><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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_LiveIndexWriterConfig_RAMBufferSizeMB.md&amp;value=---%0Auid%3A%20Lucene.Net.Index.LiveIndexWriterConfig.RAMBufferSizeMB%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/LiveIndexWriterConfig.cs/#L348">View Source</a>
</span>
<a id="Lucene_Net_Index_LiveIndexWriterConfig_RAMBufferSizeMB_" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.RAMBufferSizeMB*"></a>
<h4 id="Lucene_Net_Index_LiveIndexWriterConfig_RAMBufferSizeMB" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.RAMBufferSizeMB">RAMBufferSizeMB</h4>
<div class="markdown level1 summary"><p>Gets or sets a value that determines the amount of RAM that may be used for buffering added documents
and deletions before they are flushed to the <a class="xref" href="Lucene.Net.Store.Directory.html">Directory</a>. Generally for
faster indexing performance it&apos;s best to flush by RAM usage instead of
document count and use as large a RAM buffer as you can.
<p>
When this is set, the writer will flush whenever buffered documents and
deletions use this much RAM. Pass in
<a class="xref" href="Lucene.Net.Index.IndexWriterConfig.html#Lucene_Net_Index_IndexWriterConfig_DISABLE_AUTO_FLUSH">DISABLE_AUTO_FLUSH</a> to prevent triggering a flush
due to RAM usage. Note that if flushing by document count is also enabled,
then the flush will be triggered by whichever comes first.
<p>
The maximum RAM limit is inherently determined by the runtime&apos;s available
memory. Yet, an <a class="xref" href="Lucene.Net.Index.IndexWriter.html">IndexWriter</a> session can consume a significantly
larger amount of memory than the given RAM limit since this limit is just
an indicator when to flush memory resident documents to the <a class="xref" href="Lucene.Net.Store.Directory.html">Directory</a>.
Flushes are likely happen concurrently while other threads adding documents
to the writer. For application stability the available memory in the runtime
should be significantly larger than the RAM buffer used for indexing.
<p>
<strong>NOTE</strong>: the account of RAM usage for pending deletions is only
approximate. Specifically, if you delete by <a class="xref" href="Lucene.Net.Search.Query.html">Query</a>, Lucene currently has no
way to measure the RAM usage of individual Queries so the accounting will
under-estimate and you should compensate by either calling <a class="xref" href="Lucene.Net.Index.IndexWriter.html#Lucene_Net_Index_IndexWriter_Commit">Commit()</a>
periodically yourself, or by setting <a class="xref" href="Lucene.Net.Index.LiveIndexWriterConfig.html#Lucene_Net_Index_LiveIndexWriterConfig_MaxBufferedDeleteTerms">MaxBufferedDeleteTerms</a>
to flush and apply buffered deletes by count instead of RAM usage (for each
buffered delete <a class="xref" href="Lucene.Net.Search.Query.html">Query</a> a constant number of bytes is used to estimate RAM
usage). Note that enabling <a class="xref" href="Lucene.Net.Index.LiveIndexWriterConfig.html#Lucene_Net_Index_LiveIndexWriterConfig_MaxBufferedDeleteTerms">MaxBufferedDeleteTerms</a> will not
trigger any segment flushes.
<p>
<strong>NOTE</strong>: It&apos;s not guaranteed that all memory resident documents are
flushed once this limit is exceeded. Depending on the configured
<span class="xref">Lucene.Net.Index.LiveIndexWriterConfig.FlushPolicy</span> only a subset of the buffered documents are flushed and
therefore only parts of the RAM buffer is released.
<p>
<p>The default value is <a class="xref" href="Lucene.Net.Index.IndexWriterConfig.html#Lucene_Net_Index_IndexWriterConfig_DEFAULT_RAM_BUFFER_SIZE_MB">DEFAULT_RAM_BUFFER_SIZE_MB</a>.</p>
<p><p>
Takes effect immediately, but only the next time a document is added,
updated or deleted.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual double RAMBufferSizeMB { 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.Double</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.ArgumentException</span></td>
<td><p>if ramBufferSizeMB is enabled but non-positive, or it disables
ramBufferSizeMB when maxBufferedDocs is already disabled </p>
</td>
</tr>
</tbody>
</table>
<h5 id="Lucene_Net_Index_LiveIndexWriterConfig_RAMBufferSizeMB_seealso">See Also</h5>
<div class="seealso">
<div><a class="xref" href="Lucene.Net.Index.IndexWriterConfig.html#Lucene_Net_Index_IndexWriterConfig_RAMPerThreadHardLimitMB">RAMPerThreadHardLimitMB</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_LiveIndexWriterConfig_RAMPerThreadHardLimitMB.md&amp;value=---%0Auid%3A%20Lucene.Net.Index.LiveIndexWriterConfig.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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/LiveIndexWriterConfig.cs/#L533">View Source</a>
</span>
<a id="Lucene_Net_Index_LiveIndexWriterConfig_RAMPerThreadHardLimitMB_" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.RAMPerThreadHardLimitMB*"></a>
<h4 id="Lucene_Net_Index_LiveIndexWriterConfig_RAMPerThreadHardLimitMB" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.RAMPerThreadHardLimitMB">RAMPerThreadHardLimitMB</h4>
<div class="markdown level1 summary"><p>Returns the max amount of memory each <span class="xref">Lucene.Net.Index.DocumentsWriterPerThread</span> can
consume until forcefully flushed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual int RAMPerThreadHardLimitMB { 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.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Lucene_Net_Index_LiveIndexWriterConfig_RAMPerThreadHardLimitMB_seealso">See Also</h5>
<div class="seealso">
<div><a class="xref" href="Lucene.Net.Index.IndexWriterConfig.html#Lucene_Net_Index_IndexWriterConfig_RAMPerThreadHardLimitMB">RAMPerThreadHardLimitMB</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_LiveIndexWriterConfig_ReaderTermsIndexDivisor.md&amp;value=---%0Auid%3A%20Lucene.Net.Index.LiveIndexWriterConfig.ReaderTermsIndexDivisor%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/LiveIndexWriterConfig.cs/#L432">View Source</a>
</span>
<a id="Lucene_Net_Index_LiveIndexWriterConfig_ReaderTermsIndexDivisor_" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.ReaderTermsIndexDivisor*"></a>
<h4 id="Lucene_Net_Index_LiveIndexWriterConfig_ReaderTermsIndexDivisor" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.ReaderTermsIndexDivisor">ReaderTermsIndexDivisor</h4>
<div class="markdown level1 summary"><p>Gets or sets the termsIndexDivisor passed to any readers that <a class="xref" href="Lucene.Net.Index.IndexWriter.html">IndexWriter</a> opens,
for example when applying deletes or creating a near-real-time reader in
<a class="xref" href="Lucene.Net.Index.DirectoryReader.html#Lucene_Net_Index_DirectoryReader_Open_Lucene_Net_Index_IndexWriter_System_Boolean_">Open(IndexWriter, Boolean)</a>. If you pass -1, the
terms index won&apos;t be loaded by the readers. This is only useful in advanced
situations when you will only .Next() through all terms; attempts to seek
will hit an exception.</p>
<p><p>
Takes effect immediately, but only applies to readers opened after this
call
<p>
<strong>NOTE:</strong> divisor settings &gt; 1 do not apply to all <a class="xref" href="Lucene.Net.Codecs.PostingsFormat.html">PostingsFormat</a>
implementations, including the default one in this release. It only makes
sense for terms indexes that can efficiently re-sample terms at load time.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual int ReaderTermsIndexDivisor { 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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_LiveIndexWriterConfig_Similarity.md&amp;value=---%0Auid%3A%20Lucene.Net.Index.LiveIndexWriterConfig.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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/LiveIndexWriterConfig.cs/#L467">View Source</a>
</span>
<a id="Lucene_Net_Index_LiveIndexWriterConfig_Similarity_" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.Similarity*"></a>
<h4 id="Lucene_Net_Index_LiveIndexWriterConfig_Similarity" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.Similarity">Similarity</h4>
<div class="markdown level1 summary"><p>Expert: returns 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>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual Similarity Similarity { 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><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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_LiveIndexWriterConfig_TermIndexInterval.md&amp;value=---%0Auid%3A%20Lucene.Net.Index.LiveIndexWriterConfig.TermIndexInterval%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/LiveIndexWriterConfig.cs/#L265">View Source</a>
</span>
<a id="Lucene_Net_Index_LiveIndexWriterConfig_TermIndexInterval_" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.TermIndexInterval*"></a>
<h4 id="Lucene_Net_Index_LiveIndexWriterConfig_TermIndexInterval" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.TermIndexInterval">TermIndexInterval</h4>
<div class="markdown level1 summary"><p>Expert: Gets or sets the interval between indexed terms. Large values cause less
memory to be used by <a class="xref" href="Lucene.Net.Index.IndexReader.html">IndexReader</a>, but slow random-access to terms. Small
values cause more memory to be used by an <a class="xref" href="Lucene.Net.Index.IndexReader.html">IndexReader</a>, and speed
random-access to terms.
<p>
This parameter determines the amount of computation required per query
term, regardless of the number of documents that contain that term. In
particular, it is the maximum number of other terms that must be scanned
before a term is located and its frequency and position information may be
processed. In a large index with user-entered query terms, query processing
time is likely to be dominated not by term lookup but rather by the
processing of frequency and positional data. In a small index or when many
uncommon query terms are generated (e.g., by wildcard queries) term lookup
may become a dominant cost.
<p>
In particular, <code>numUniqueTerms/interval</code> terms are read into
memory by an <a class="xref" href="Lucene.Net.Index.IndexReader.html">IndexReader</a>, and, on average, <code>interval/2</code> terms
must be scanned for each random term access.</p>
<p><p>
Takes effect immediately, but only applies to newly flushed/merged
segments.</p>
<p><p>
<strong>NOTE:</strong> this parameter does not apply to all <a class="xref" href="Lucene.Net.Codecs.PostingsFormat.html">PostingsFormat</a> implementations,
including the default one in this release. It only makes sense for term indexes
that are implemented as a fixed gap between terms. For example,
<a class="xref" href="Lucene.Net.Codecs.Lucene41.Lucene41PostingsFormat.html">Lucene41PostingsFormat</a> implements the term index instead based upon how
terms share prefixes. To configure its parameters (the minimum and maximum size
for a block), you would instead use <a class="xref" href="Lucene.Net.Codecs.Lucene41.Lucene41PostingsFormat.html#Lucene_Net_Codecs_Lucene41_Lucene41PostingsFormat__ctor_System_Int32_System_Int32_">Lucene41PostingsFormat(Int32, Int32)</a>.
which can also be configured on a per-field basis:</p>
<pre><code>public class MyLucene45Codec : Lucene45Codec
{
//customize Lucene41PostingsFormat, passing minBlockSize=50, maxBlockSize=100
private readonly PostingsFormat tweakedPostings = new Lucene41PostingsFormat(50, 100);
public override PostingsFormat GetPostingsFormatForField(string field)
{
if (field.Equals(&quot;fieldWithTonsOfTerms&quot;, StringComparison.Ordinal))
return tweakedPostings;
else
return base.GetPostingsFormatForField(field);
}
}
...
iwc.Codec = new MyLucene45Codec();</code></pre>
<p>Note that other implementations may have their own parameters, or no parameters at all.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual int TermIndexInterval { 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_LiveIndexWriterConfig_TermIndexInterval_seealso">See Also</h5>
<div class="seealso">
<div><a class="xref" href="Lucene.Net.Index.IndexWriterConfig.html#Lucene_Net_Index_IndexWriterConfig_DEFAULT_TERM_INDEX_INTERVAL">DEFAULT_TERM_INDEX_INTERVAL</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_LiveIndexWriterConfig_UseCompoundFile.md&amp;value=---%0Auid%3A%20Lucene.Net.Index.LiveIndexWriterConfig.UseCompoundFile%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/LiveIndexWriterConfig.cs/#L558">View Source</a>
</span>
<a id="Lucene_Net_Index_LiveIndexWriterConfig_UseCompoundFile_" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.UseCompoundFile*"></a>
<h4 id="Lucene_Net_Index_LiveIndexWriterConfig_UseCompoundFile" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.UseCompoundFile">UseCompoundFile</h4>
<div class="markdown level1 summary"><p>Gets or sets if the <a class="xref" href="Lucene.Net.Index.IndexWriter.html">IndexWriter</a> should pack newly written segments in a
compound file. Default is <code>true</code>.
<p>
Use <code>false</code> for batch indexing with very large RAM buffer
settings.
</p>
<p>
<strong>Note: To control compound file usage during segment merges see
<a class="xref" href="Lucene.Net.Index.MergePolicy.html#Lucene_Net_Index_MergePolicy_NoCFSRatio">NoCFSRatio</a> and
<a class="xref" href="Lucene.Net.Index.MergePolicy.html#Lucene_Net_Index_MergePolicy_MaxCFSSegmentSizeMB">MaxCFSSegmentSizeMB</a>. This setting only
applies to newly created segments.</strong>
</p></p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual bool UseCompoundFile { 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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_LiveIndexWriterConfig_UseReaderPooling.md&amp;value=---%0Auid%3A%20Lucene.Net.Index.LiveIndexWriterConfig.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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/LiveIndexWriterConfig.cs/#L520">View Source</a>
</span>
<a id="Lucene_Net_Index_LiveIndexWriterConfig_UseReaderPooling_" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.UseReaderPooling*"></a>
<h4 id="Lucene_Net_Index_LiveIndexWriterConfig_UseReaderPooling" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.UseReaderPooling">UseReaderPooling</h4>
<div class="markdown level1 summary"><p>Returns <code>true</code> if <a class="xref" href="Lucene.Net.Index.IndexWriter.html">IndexWriter</a> should pool readers even if
<a class="xref" href="Lucene.Net.Index.DirectoryReader.html#Lucene_Net_Index_DirectoryReader_Open_Lucene_Net_Index_IndexWriter_System_Boolean_">Open(IndexWriter, Boolean)</a> has not been called.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual bool UseReaderPooling { 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.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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_LiveIndexWriterConfig_WriteLockTimeout.md&amp;value=---%0Auid%3A%20Lucene.Net.Index.LiveIndexWriterConfig.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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/LiveIndexWriterConfig.cs/#L479">View Source</a>
</span>
<a id="Lucene_Net_Index_LiveIndexWriterConfig_WriteLockTimeout_" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.WriteLockTimeout*"></a>
<h4 id="Lucene_Net_Index_LiveIndexWriterConfig_WriteLockTimeout" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.WriteLockTimeout">WriteLockTimeout</h4>
<div class="markdown level1 summary"><p>Returns allowed timeout when acquiring the write lock.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual long WriteLockTimeout { 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.Int64</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Lucene_Net_Index_LiveIndexWriterConfig_WriteLockTimeout_seealso">See Also</h5>
<div class="seealso">
<div><a class="xref" href="Lucene.Net.Index.IndexWriterConfig.html#Lucene_Net_Index_IndexWriterConfig_WriteLockTimeout">WriteLockTimeout</a></div>
</div>
<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_LiveIndexWriterConfig_ToString.md&amp;value=---%0Auid%3A%20Lucene.Net.Index.LiveIndexWriterConfig.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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/LiveIndexWriterConfig.cs/#L579">View Source</a>
</span>
<a id="Lucene_Net_Index_LiveIndexWriterConfig_ToString_" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.ToString*"></a>
<h4 id="Lucene_Net_Index_LiveIndexWriterConfig_ToString" data-uid="Lucene.Net.Index.LiveIndexWriterConfig.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><span class="xref">System.Object.ToString()</span></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>
</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_LiveIndexWriterConfig.md&amp;value=---%0Auid%3A%20Lucene.Net.Index.LiveIndexWriterConfig%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/LiveIndexWriterConfig.cs/#L39" 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>