In order to upgrade an index from an earlier version of LucidWorks Enterprise to v2.0, the Index Upgrade Tool should be run. This tool is found under $LWE_HOME/app/migration-tools/ in a .jar file called IndexUpgradeTool.jar.
The tool will support upgrading an index from v1.7 or v1.8 to v2.0. Earlier versions are not supported.
 | It is recommended to run this Upgrade Tool only after consultation with Lucid Imagination Support to be sure you understand the full ramifications of running this tool on your local, customized, index. |
Lucid Imagination regularly reviews how our term indexing and query interpretation with our "lucid" query parser operates and may make changes from time to time. In some cases, this means that queries may not behave the same between releases. In particular, for v2.0, we have changed the way we handle indexing "CamelCase" terms from documents and processing queries entered in that format. Previously, these terms were indexed as single terms, but we have changed this so now they will be indexed as multi-term phrases. This means queries entered in CamelCase will also be interpreted as multi-term phrase queries. However, the index upgrade tool does not convert these terms to multi-term phrases, so moving forward there may be a mix of terms in the index, such as "SharePoint" and "Share Point". While we have provided this index upgrade tool to help you avoid re-indexing your data, it is recommended to do so with every migration to a new version.
Before running the tool, you should make sure LucidWorks Enterprise is not running to ensure there are no indexing processes taking place while performing the upgrade.
To run the tool, open a command line interface, navigate to the $LWE_HOME/app/migration_tools directory and input the command:
java -jar IndexUpgradeTool.jar [options] <sourcedir> <destinationdir>
The <sourcedir> parameter is the existing index that will be moved to the <destinationdir>. In v1.7 and v1.8, the <sourcedir> is found at $LWE_HOME/solr/cores/collection/data/index, where collection is the name of the collection whose indexes are being upgraded. In v2.0, the directory structure has changed, so the <destinationdir> would be $LWE_HOME/data/solr/cores/collection/data/index.
 | The IndexUpgradeTool can upgrade the index for one collection at a time. If there are multiple collection in the origin LucidWorks Enterprise, these would each need to be converted separately. |
There is currently one option that can be used with the tool, which is -checkindex. This will run Lucene's checkindex tool to validate that the index is correct. This is a good idea to do, especially for systems already in production, but will add time to the upgrade process.
 | About Spell Check and Auto-Complete Indexes From Prior Versions Before LucidWorks Enterprise v2.0, when spell checking and/or auto-complete was enabled a separate index was created. In v2.0, the spell check feature can use data from the 'spell' field in the main index and creation of a separate index is no longer required. For this reason, the spell check index is not upgraded, although the 'spell' field from the main index will be converted as part of the main index upgrade. The auto-complete feature still uses a separate index in v2.0. However, this index is not upgraded as part of this process. After upgrading the main index, the auto-complete index will need to be re-populated by running the autocomplete job with either the Admin UI or the Activities API. |
