dtSearch Text Retrieval Engine .NET interface

IndexJob Properties

The properties of the IndexJob class are listed below. For a complete list of IndexJob class members, see the IndexJob Members topic.

Public Instance Properties

ActionAdd Add documents to an existing index. If ActionCreate is not set, the index must already exist or the IndexJob will fail.
ActionCompress Remove obsolete information from the index.
ActionCreate Create a new index. If an index already exists in the specified directory, the index will be destroyed and replaced with a new, empty index.
ActionMerge Merge the indexes listed in IndexesToMerge into the index in IndexPath.
ActionRemoveDeleted Check that each file in the index still exists on disk and remove from the index any files that no longer exist.
ActionRemoveListed Remove the files listed in the text file identified by ToRemoveListName from the index.
ActionVerify Scan all index structures in the index to verify that the index is not damaged.
AutoCommitIntervalMB Number of megabytes to index before committing the index update.
CreateAccentSensitive Create accent sensitive index, so accents on letters will be treated as significant when searching
CreateCaseSensitive Create case sensitive index, so apple and Apple will be two different words.
CreateRelativePaths Use relative rather than absolute paths when storing document locations.
DataSourceToIndex DataSource object to index.
Errors Contains any error messages generated during the indexing job.
ExcludeFilters Filters specifying documents not to index in the selected folders.
FoldersToIndex List of folders (or files) to index (add <+> after a folder name to include subfolders).
IncludeFilters Filters specifying documents to index in the FoldersToIndex.
IndexesToMerge Indexes to merge into the target index, which is IndexPath. (ActionMerge must be true for the merge to occur.) For each index, provide the full path to the index.
IndexingFlags Flags controlling the indexing of documents.
IndexPath Full path of the folder where the index is located.
MaxMemToUseMB Maximum amount of memory that the indexer will use for workspace (in megabytes). By default, the indexer will calculate how much memory to use based on the size of the document collection being indexed and the amount of physical RAM available (no more than 50% of the amount of physical RAM installed will be used). At least 10 Mb is needed.
StatusHandler Object to receive status update notifications during indexing. Can be used to provide a progress display and to provide an opportunity to cancel an index update.
StoredFields Fields to be stored in the index for each document and returned as document properties in SearchResults.
TempFileDir Folder to use instead of the index folder for temporary files during indexing.
ToRemoveListName Name of file containing list of files to remove from the index.

See Also

IndexJob Class | dtSearch.Engine Namespace | DataSource | "Building and Maintaining Indexes"