Class OpenIndexTask

Open an index writer.

Inheritance

object

PerfTask

OpenIndexTask

Implements

IDisposable

Inherited Members

PerfTask.m_logStep

PerfTask.m_params

PerfTask.NEW_LINE

PerfTask.SetRunInBackground(int)

PerfTask.RunInBackground

PerfTask.BackgroundDeltaPriority

PerfTask.Stop

PerfTask.StopNow()

PerfTask.Clone()

PerfTask.Dispose()

PerfTask.Dispose(bool)

PerfTask.RunAndMaybeStats(bool)

PerfTask.GetName()

PerfTask.SetName(string)

PerfTask.RunData

PerfTask.Depth

PerfTask.ToString()

PerfTask.GetLogMessage(int)

PerfTask.ShouldNeverLogAtStart

PerfTask.ShouldNotRecordStats

PerfTask.Setup()

PerfTask.TearDown()

PerfTask.Params

PerfTask.DisableCounting

PerfTask.AlgLineNum

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Lucene.Net.Benchmarks.ByTask.Tasks

Assembly: Lucene.Net.Benchmark.dll

Syntax

public class OpenIndexTask : PerfTask, IDisposable

Remarks

Other side effects: index writer object in perfRunData is set.

Relevant properties:

• merge.factor
• max.buffered
• max.field.length
• ram.flush.mb[default 0]

Accepts a param specifying the commit point as previously saved with CommitIndexTask. If you specify this, it rolls the index back to that commit on opening the Lucene.Net.Index.IndexWriter.

Constructors

OpenIndexTask(PerfRunData)

Open an index writer.

Declaration

public OpenIndexTask(PerfRunData runData)

Parameters

Type	Name	Description
PerfRunData	runData

Remarks

Other side effects: index writer object in perfRunData is set.

Relevant properties:

• merge.factor
• max.buffered
• max.field.length
• ram.flush.mb[default 0]

Accepts a param specifying the commit point as previously saved with CommitIndexTask. If you specify this, it rolls the index back to that commit on opening the Lucene.Net.Index.IndexWriter.

Fields

DEFAULT_MAX_BUFFERED

Open an index writer.

Declaration

public static readonly int DEFAULT_MAX_BUFFERED

Field Value

Type	Description
int

Remarks

Other side effects: index writer object in perfRunData is set.

Relevant properties:

• merge.factor
• max.buffered
• max.field.length
• ram.flush.mb[default 0]

Accepts a param specifying the commit point as previously saved with CommitIndexTask. If you specify this, it rolls the index back to that commit on opening the Lucene.Net.Index.IndexWriter.

DEFAULT_MERGE_PFACTOR

Open an index writer.

Declaration

public static readonly int DEFAULT_MERGE_PFACTOR

Field Value

Type	Description
int

Remarks

Other side effects: index writer object in perfRunData is set.

Relevant properties:

• merge.factor
• max.buffered
• max.field.length
• ram.flush.mb[default 0]

Accepts a param specifying the commit point as previously saved with CommitIndexTask. If you specify this, it rolls the index back to that commit on opening the Lucene.Net.Index.IndexWriter.

DEFAULT_RAM_FLUSH_MB

Open an index writer.

Declaration

public static readonly double DEFAULT_RAM_FLUSH_MB

Field Value

Type	Description
double

Remarks

Other side effects: index writer object in perfRunData is set.

Relevant properties:

• merge.factor
• max.buffered
• max.field.length
• ram.flush.mb[default 0]

Accepts a param specifying the commit point as previously saved with CommitIndexTask. If you specify this, it rolls the index back to that commit on opening the Lucene.Net.Index.IndexWriter.

Properties

SupportsParams

Sub classes that support parameters must override this method to return true if this task supports command line params.

Declaration

public override bool SupportsParams { get; }

Property Value

Type	Description
bool

Overrides

PerfTask.SupportsParams

Remarks

Other side effects: index writer object in perfRunData is set.

Relevant properties:

• merge.factor
• max.buffered
• max.field.length
• ram.flush.mb[default 0]

Accepts a param specifying the commit point as previously saved with CommitIndexTask. If you specify this, it rolls the index back to that commit on opening the Lucene.Net.Index.IndexWriter.

Methods

DoLogic()

Perform the task once (ignoring repetitions specification). Return number of work items done by this task. For indexing that can be number of docs added. For warming that can be number of scanned items, etc.

Declaration

public override int DoLogic()

Returns

Type	Description
int	Number of work items done by this task.

Overrides

PerfTask.DoLogic()

Remarks

Other side effects: index writer object in perfRunData is set.

Relevant properties:

• merge.factor
• max.buffered
• max.field.length
• ram.flush.mb[default 0]

Accepts a param specifying the commit point as previously saved with CommitIndexTask. If you specify this, it rolls the index back to that commit on opening the Lucene.Net.Index.IndexWriter.

SetParams(string)

Set the params of this task.

Declaration

public override void SetParams(string @params)

Parameters

Type	Name	Description
string	params

Overrides

PerfTask.SetParams(string)

Remarks

Other side effects: index writer object in perfRunData is set.

Relevant properties:

• merge.factor
• max.buffered
• max.field.length
• ram.flush.mb[default 0]

Accepts a param specifying the commit point as previously saved with CommitIndexTask. If you specify this, it rolls the index back to that commit on opening the Lucene.Net.Index.IndexWriter.

Exceptions

Type	Condition
NotSupportedException	For tasks supporting command line parameters.

Implements

IDisposable