Using the CheckIndex Tool

Owned by Heather Geyer
Aug 10, 2022
2 min read

Voyager has a suite of command-line tools that you can use to check and repair the index, start and stop the Voyager service, configure user Security and other network functions.  Checking and repairing the index is one of the most commonly used tools, however the usage and syntax changed with Voyager 1.9.9. Both the previous and current tools are described below.

Checking the Index - Voyager Versions 1.9.8.3 and Earlier

In Voyager versions 1.9.8.3 and earlier, use the CheckIndex tool.

To run the CheckIndex tool:

  • Stop the Voyager service

  • Go to [Voyager Installation Dir]/app/util

  • Open a command window

  • Enter VoyagerCommandLine

  • Enter checkIndex (case is important)

  • The tool will show a list of sub-folders within the data folder (fields, history, jobs, list, mime, tasks, v0, vfs)

  • If there is an issue, it is most likely with the v0  (index) sub-folder

  • Enter checkIndex 

  • At the command prompt, enter v0 and press Return

  • If the index is not corrupt, you will see No problems were detected with this index

  • If you see a FAILED message when the test is complete, the index is corrupt

  • To fix the index, enter checkIndex again

  • At the command prompt, enter v0 -fix and press Enter

  • Type Y to answer Do you want to continue?

  • The tool will fix the corrupt index by deleting the files/documents that were corrupt

  • Restart the Voyager service

Checking the Index - Voyager Versions 1.9.9 and later

In Voyager version 1.9.9 and later, you access the checkindex function from the [Voyager Installation Dir]/cli/bin directory. 

To check your index:

  • Go to [Voyager Installation Dir]/cli/bin 

  • To check the v0 (index) directory, enter voyager index check v0 and press Return

  • If the index is corrupt, enter the following command to fix it: voyager index check v0 --fix

  • Fixing an index may result in deletion of some documents - to continue, press Y