dtsIndexJob Structure

Describes an indexing task to be performed.

struct dtsIndexJob : public dtsJobBase {
  char indexName[IndexNameLen];
  char indexPath[FileNameLen];
  short allowConcurrentAccess;
  dtsIndexJobAction action;
  dtsIndexJobCreateFlags createFlags;
  struct dtsFileSpec toAdd;
  char toRemoveList[FileNameLen];
  const char * tempFileDir;
  struct dtsDataSource * dataSourceToIndex;
  const char * storedFields;
  long indexingFlags;
  long maxTextToCache;
  long autoCommitIntervalMB;
  long maxMemToUseMB;
  void DTPROC (* pOnIndexWordFn)(void *pOnIndexWordData, struct dtsOnIndexWordInfo *info);
  void * pOnIndexWordData;
  long startingDocId;
};

File

dtsearch.h

Remarks

Call dtssDoIndexJob to execute a dtsIndexJob.

Data Members

dtsIndexJob Structure

Data Member	Description
action	Specifies whether to create, add documents to, compress, or remove items from the index.
allowConcurrentAccess	Obsolete. Concurrent access is always supported.
autoCommitIntervalMB	Automatically commit index changes to disk after this many megabytes have been indexed
createFlags	Specifies whether the index to create should be case-sensitive, accent-sensitive, or use relative paths
dataSourceToIndex	Pointer to a dtsDataSource. Initialize to NULL if you are indexing files selected with the toAdd member. The dataSourceToIndex member is useful if you need to index data that is not readily available as a disk file, such as records from a SQL database
indexingFlags	Flags controlling the indexing process. See IndexingFlags enumeration
indexName	Name of the index to create. An index name is not necessary to access an index (the index path is always sufficient).
indexPath	Directory where the index is located. The index will consist of a series of files named index*.ix
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
maxTextToCache	Maximum size of a document to cache in the index, if caching is enabled for this index
pOnIndexWordData	Data to pass to pOnIndexWordFn
pOnIndexWordFn	The pOnIndexWordFn can be used to provide a callback to modify the text of words as they are being indexed. See dtsOnIndexWordInfo for more information.
startingDocId	If non-zero, the first doc id to assign to documents in this index.
storedFields	Used to specify that the text in certain fields should be collected, stored in the index, and returned in searches.
tempFileDir	Folder to use instead of the index folder for temporary files during indexing. During indexing, the dtSearch Engine may need to create temporary files to store word lists that are too large to fit into memory. By default, these files will be placed in the index folder. Use this setting to specify a different location for the word lists. The indexer will automatically delete the word list files when the index update completes.
toAdd	Specifies files to be added to the index if action.add is true
toRemoveList	Name of file containing a list of files to be deleted from the index

Group

Classes

Methods

dtsIndexJob Structure

Method	Description
clear	Clear all data in a dtsIndexJob
copy	Copy another dtsIndexJob (shallow copy)

Legend

	Data Member
	Method

Links

Data Members, Classes, Legend, Members, Methods