Class CreateIndexTask

Creates an index.

Inheritance

object

PerfTask

CreateIndexTask

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.SupportsParams

PerfTask.SetParams(string)

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 CreateIndexTask : PerfTask, IDisposable

Remarks

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

Relevant properties:

• merge.factor(default 10)
• max.buffered(default no flush)
• compound(default true)
• ram.flush.mb[default 0]
• merge.policy(default Lucene.Net.Index.LogByteSizeMergePolicy, Lucene.Net)
• merge.scheduler(default Lucene.Net.Index.ConcurrentMergeScheduler, Lucene.Net)
• concurrent.merge.scheduler.max.thread.count(defaults per ConcurrentMergeScheduler)
• concurrent.merge.scheduler.max.merge.count(defaults per ConcurrentMergeScheduler)
• default.codec

This task also supports a "writer.info.stream" property with the following values:

• SystemOutSets Lucene.Net.Index.IndexWriterConfig.SetInfoStream(Lucene.Net.Util.InfoStream) to Lucene.Net.Util.SystemConsole.Out.
• SystemErrSets Lucene.Net.Index.IndexWriterConfig.SetInfoStream(Lucene.Net.Util.InfoStream) to Lucene.Net.Util.SystemConsole.Error
• <file_name> Attempts to create a file given that name and sets Lucene.Net.Index.IndexWriterConfig.SetInfoStream(Lucene.Net.Util.InfoStream) to that file. If this denotes an invalid file name, or some error occurs, an exception will be thrown.

Constructors

CreateIndexTask(PerfRunData)

Creates an index.

Declaration

public CreateIndexTask(PerfRunData runData)

Parameters

Type	Name	Description
PerfRunData	runData

Remarks

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

Relevant properties:

• merge.factor(default 10)
• max.buffered(default no flush)
• compound(default true)
• ram.flush.mb[default 0]
• merge.policy(default Lucene.Net.Index.LogByteSizeMergePolicy, Lucene.Net)
• merge.scheduler(default Lucene.Net.Index.ConcurrentMergeScheduler, Lucene.Net)
• concurrent.merge.scheduler.max.thread.count(defaults per ConcurrentMergeScheduler)
• concurrent.merge.scheduler.max.merge.count(defaults per ConcurrentMergeScheduler)
• default.codec

This task also supports a "writer.info.stream" property with the following values:

• SystemOutSets Lucene.Net.Index.IndexWriterConfig.SetInfoStream(Lucene.Net.Util.InfoStream) to Lucene.Net.Util.SystemConsole.Out.
• SystemErrSets Lucene.Net.Index.IndexWriterConfig.SetInfoStream(Lucene.Net.Util.InfoStream) to Lucene.Net.Util.SystemConsole.Error
• <file_name> Attempts to create a file given that name and sets Lucene.Net.Index.IndexWriterConfig.SetInfoStream(Lucene.Net.Util.InfoStream) to that file. If this denotes an invalid file name, or some error occurs, an exception will be thrown.

Methods

ConfigureWriter(Config, PerfRunData, OpenMode, IndexCommit)

Creates an index.

Declaration

public static IndexWriter ConfigureWriter(Config config, PerfRunData runData, OpenMode mode, IndexCommit commit)

Parameters

Type	Name	Description
Config	config
PerfRunData	runData
OpenMode	mode
IndexCommit	commit

Returns

Type	Description
IndexWriter

Remarks

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

Relevant properties:

• merge.factor(default 10)
• max.buffered(default no flush)
• compound(default true)
• ram.flush.mb[default 0]
• merge.policy(default Lucene.Net.Index.LogByteSizeMergePolicy, Lucene.Net)
• merge.scheduler(default Lucene.Net.Index.ConcurrentMergeScheduler, Lucene.Net)
• concurrent.merge.scheduler.max.thread.count(defaults per ConcurrentMergeScheduler)
• concurrent.merge.scheduler.max.merge.count(defaults per ConcurrentMergeScheduler)
• default.codec

This task also supports a "writer.info.stream" property with the following values:

• SystemOutSets Lucene.Net.Index.IndexWriterConfig.SetInfoStream(Lucene.Net.Util.InfoStream) to Lucene.Net.Util.SystemConsole.Out.
• SystemErrSets Lucene.Net.Index.IndexWriterConfig.SetInfoStream(Lucene.Net.Util.InfoStream) to Lucene.Net.Util.SystemConsole.Error
• <file_name> Attempts to create a file given that name and sets Lucene.Net.Index.IndexWriterConfig.SetInfoStream(Lucene.Net.Util.InfoStream) to that file. If this denotes an invalid file name, or some error occurs, an exception will be thrown.

CreateWriterConfig(Config, PerfRunData, OpenMode, IndexCommit)

Creates an index.

Declaration

public static IndexWriterConfig CreateWriterConfig(Config config, PerfRunData runData, OpenMode mode, IndexCommit commit)

Parameters

Type	Name	Description
Config	config
PerfRunData	runData
OpenMode	mode
IndexCommit	commit

Returns

Type	Description
IndexWriterConfig

Remarks

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

Relevant properties:

• merge.factor(default 10)
• max.buffered(default no flush)
• compound(default true)
• ram.flush.mb[default 0]
• merge.policy(default Lucene.Net.Index.LogByteSizeMergePolicy, Lucene.Net)
• merge.scheduler(default Lucene.Net.Index.ConcurrentMergeScheduler, Lucene.Net)
• concurrent.merge.scheduler.max.thread.count(defaults per ConcurrentMergeScheduler)
• concurrent.merge.scheduler.max.merge.count(defaults per ConcurrentMergeScheduler)
• default.codec

This task also supports a "writer.info.stream" property with the following values:

• SystemOutSets Lucene.Net.Index.IndexWriterConfig.SetInfoStream(Lucene.Net.Util.InfoStream) to Lucene.Net.Util.SystemConsole.Out.
• SystemErrSets Lucene.Net.Index.IndexWriterConfig.SetInfoStream(Lucene.Net.Util.InfoStream) to Lucene.Net.Util.SystemConsole.Error
• <file_name> Attempts to create a file given that name and sets Lucene.Net.Index.IndexWriterConfig.SetInfoStream(Lucene.Net.Util.InfoStream) to that file. If this denotes an invalid file name, or some error occurs, an exception will be thrown.

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(default 10)
• max.buffered(default no flush)
• compound(default true)
• ram.flush.mb[default 0]
• merge.policy(default Lucene.Net.Index.LogByteSizeMergePolicy, Lucene.Net)
• merge.scheduler(default Lucene.Net.Index.ConcurrentMergeScheduler, Lucene.Net)
• concurrent.merge.scheduler.max.thread.count(defaults per ConcurrentMergeScheduler)
• concurrent.merge.scheduler.max.merge.count(defaults per ConcurrentMergeScheduler)
• default.codec

This task also supports a "writer.info.stream" property with the following values:

• SystemOutSets Lucene.Net.Index.IndexWriterConfig.SetInfoStream(Lucene.Net.Util.InfoStream) to Lucene.Net.Util.SystemConsole.Out.
• SystemErrSets Lucene.Net.Index.IndexWriterConfig.SetInfoStream(Lucene.Net.Util.InfoStream) to Lucene.Net.Util.SystemConsole.Error
• <file_name> Attempts to create a file given that name and sets Lucene.Net.Index.IndexWriterConfig.SetInfoStream(Lucene.Net.Util.InfoStream) to that file. If this denotes an invalid file name, or some error occurs, an exception will be thrown.

GetIndexDeletionPolicy(Config)

Creates an index.

Declaration

public static IndexDeletionPolicy GetIndexDeletionPolicy(Config config)

Parameters

Type	Name	Description
Config	config

Returns

Type	Description
IndexDeletionPolicy

Remarks

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

Relevant properties:

• merge.factor(default 10)
• max.buffered(default no flush)
• compound(default true)
• ram.flush.mb[default 0]
• merge.policy(default Lucene.Net.Index.LogByteSizeMergePolicy, Lucene.Net)
• merge.scheduler(default Lucene.Net.Index.ConcurrentMergeScheduler, Lucene.Net)
• concurrent.merge.scheduler.max.thread.count(defaults per ConcurrentMergeScheduler)
• concurrent.merge.scheduler.max.merge.count(defaults per ConcurrentMergeScheduler)
• default.codec

This task also supports a "writer.info.stream" property with the following values:

• SystemOutSets Lucene.Net.Index.IndexWriterConfig.SetInfoStream(Lucene.Net.Util.InfoStream) to Lucene.Net.Util.SystemConsole.Out.
• SystemErrSets Lucene.Net.Index.IndexWriterConfig.SetInfoStream(Lucene.Net.Util.InfoStream) to Lucene.Net.Util.SystemConsole.Error
• <file_name> Attempts to create a file given that name and sets Lucene.Net.Index.IndexWriterConfig.SetInfoStream(Lucene.Net.Util.InfoStream) to that file. If this denotes an invalid file name, or some error occurs, an exception will be thrown.

Implements

IDisposable