General processing options
The mkvdk utility provides a variety of general processing options, which the following table describes:
|
Option |
Description |
|---|---|
| -collection path |
Specifies the path of the collection to create or open. This option is required to execute the mkvdk utility. |
| -nolock |
Turns off file locking. Locking is on by default. |
| -synch |
Performs work immediately. If this option is not used, indexing work is done in the background, as time permits. |
| -about |
Shows information about the collection, such as its description and the date when it was last modified. |
| -datapath path |
Specifies the datapath to use to find documents that are added to the specified collection. All relative document paths are relative to this setting. If you do not set this option, the mkvdk utility looks for documents next to the collection directory. |
| -topicset path |
Creates a topic index for the collection, based on the specified topic set, and stores it in the collection directory. This facilitates quick and efficient searches over the collection data when using topics. |
| -mode mode |
Sets the indexing mode. Values are case-insensitive. The following are the valid settings:
The default is Generic mode. |
| -common |
Specifies the path of the Verity common directory. If you do not use this option, the Verity engine looks for the common directory in the directory containing the mkvdk executable, and then along the executable search path. The executable search path is determined by your operating system environment settings. It is the path used by the OS to find the programs you run. |
| -help |
Displays the mkvdk utility syntax options. |
| -debug |
Runs the mkvdk command in debugging mode. |
| -nooptimize |
Prevents optimization by this instance of the mkvdk utility. Using this option turns off the service-level VdkServiceType_Optimize. The service types determine the type of work the Verity engine and its self-administration features will execute on a collection. |
| -nohousekeep |
Prevents housekeeping by this instance of the mkvdk utility. Housekeeping includes deleting files that are no longer needed. Using this option turns off the service-level VdkServiceType_DBA. (Service types are described under -nooptimize.) |
| -noindex |
Prevents indexing by this instance of mkvdk. Documents are not inserted or deleted. Using this option turns off the service-level VdkServiceType_Index. (Service types are described under -nooptimize.) |
| -charmap name |
Specifies the name of the character set to which to map all strings for your application. Set this to a character set that your system can display properly. Using the search engine with the English locale, the character set that any version of Windows displays is 8859. This is NOT the name of the character set of documents being indexed, it is only the name of the character set that your display can handle properly. (The character set of the document is set in the style.dft file using the /charmap option.) Valid options are 850 and 8859. The default is no mapping. |
| -locale name |
Specifies the name of the Verity locale to be used by the mkvdk utility. The locale name must correspond to the name of an existing locale directory, which must exist in the install_dir/common/locale directory. Valid options are english, deutsch, and francais. The default is english. |
| -datefmt format |
Converts a date field value into Verity's internal data representation. You can use this option in conjunction with the mkvdk options -extract (for the field extraction feature) and -bulk (for the bulk submit feature). The named format string identifies to the date parsing routines in what order dates are written when the date string only consists of a sequence of numbers (for example, 03/03/96). Valid options are described in Date format options. The default is MDY. |
| -servlev level |
Specifies service level. The specifier, level, is a string consisting of keywords separated by hyphens, such as search-index-optimize. Valid keywords are described in Service-level keyword options. |
Examples: processing documents
The following examples show the commands for processing documents.
By default, the mkvdk command submits and indexes documents specified in the command, and services the specified collection. The following command executes the default options:
mkvdk -collection path filespec
The following command performs servicing only. Use this command to only index submitted documents and service the collection:
mkvdk -collection path
Deleting documents from a collection
The following command deletes documents from a collection:
mkvdk -delete -collection path filespec
The following command specifies bulk insertion of a list of documents:
mkvdk -collection coll -bulk -insert filespec
Where filespec is the list of files to insert. Since insert is the default, the following command is equivalent to the preceding command:
mkvdk -collection coll -bulk filespec
The following command specifies bulk deletion of a list of documents:
mkvdk -collection coll -bulk -delete filespec
Where filespec is the list of files to delete. It can be the same file used to insert documents; the only difference is that -delete is specified instead of -insert (or no specification).