Describes an indexing task to be performed.
File
File: dtsearch.h
Syntax
C++
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 (* pOnIndexWordFn)(void *pOnIndexWordData, struct dtsOnIndexWordInfo *info);
void * pOnIndexWordData;
long startingDocId;
char storedFieldDelimiterChar;
const char * enumerableFields;
const char * createCompatibleIndexPath;
};
Data Members
Data Member |
Description |
---|---|
Specifies whether to create, add documents to, compress, or remove items from the index. | |
Obsolete. Concurrent access is always supported. | |
Automatically commit index changes to disk after this many megabytes have been indexed | |
Path to an index to use as a model when creating an index to ensure that the new index has options that are compatible with the other index. | |
Specifies whether the index to create should be case-sensitive, accent-sensitive, or use relative paths | |
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 | |
Used to specify that the text in certain fields should be stored in the index in a way that permits unique field values to be enumerated quickly. | |
Name of the index to create. An index name is not necessary to access an index (the index path is always sufficient). | |
Directory where the index is located. The index will consist of a series of files named index*.ix | |
Flags controlling the indexing process. See IndexingFlags enumeration | |
MaxMemToUseMB controls the size of the memory buffers that dtSearch can use to sort words during indexing. | |
Maximum size of a document to cache in the index, if caching is enabled for this index | |
Data to pass to 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. | |
If non-zero, the first doc id to assign to documents in this index. | |
Delimiter inserted between multiple instances of a stored field found in a single document. Overrides Options.storedFieldDelimiterChar if both are specified. | |
Used to specify that the text in certain fields should be collected, stored in the index, and returned in searches. | |
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. | |
Specifies files to be added to the index if action.add is true | |
Name of file containing a list of files to be deleted from the index |
Group
Members
Data Members
Data Member |
Description |
---|---|
Specifies whether to create, add documents to, compress, or remove items from the index. | |
Obsolete. Concurrent access is always supported. | |
Automatically commit index changes to disk after this many megabytes have been indexed | |
Path to an index to use as a model when creating an index to ensure that the new index has options that are compatible with the other index. | |
Specifies whether the index to create should be case-sensitive, accent-sensitive, or use relative paths | |
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 | |
Used to specify that the text in certain fields should be stored in the index in a way that permits unique field values to be enumerated quickly. | |
Name of the index to create. An index name is not necessary to access an index (the index path is always sufficient). | |
Directory where the index is located. The index will consist of a series of files named index*.ix | |
Flags controlling the indexing process. See IndexingFlags enumeration | |
MaxMemToUseMB controls the size of the memory buffers that dtSearch can use to sort words during indexing. | |
Maximum size of a document to cache in the index, if caching is enabled for this index | |
Data to pass to 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. | |
If non-zero, the first doc id to assign to documents in this index. | |
Delimiter inserted between multiple instances of a stored field found in a single document. Overrides Options.storedFieldDelimiterChar if both are specified. | |
Used to specify that the text in certain fields should be collected, stored in the index, and returned in searches. | |
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. | |
Specifies files to be added to the index if action.add is true | |
Name of file containing a list of files to be deleted from the index |
Methods
Methods
Remarks
Call dtssDoIndexJob to execute a dtsIndexJob.