Indices

From VYRE

Jump to: navigation, search

Contents

Indices

Overview

Indices are used by Unify for all searching that is performed within the system using Lucene[[1]]. They are created and placed on each of the severs (deliveries and admin) using them for searching increases performance and reduces the number of database calls.

Maintaining Indices

For many reasons indexes can become out of sync which will mean items might not appear in the search results and can cause strange behaviour between delivery servers (different values for the same item). If this occurs there are a few places you can check and things you can do to clean up the indexes.

Checking status of indices

Checking the indices can be done from within the Content module under the settings branch, then by selecting the Indices option. The page will display a list of all the content stores with values for the following criteria -

  • "Active Items:" The number of items that are active, based on the database.
  • "Indexed Items:" The number of items that are in the index as active.
  • "Checked Out Items:" The number of items that are checked out, based on the database.
  • "Indexed Checked Out Items:" The number of items that are in the index as checked out.

If any of the values are out of sync then the row will be displayed in red so it is easy to see, they can be out of sync for a number of reasons, if a server was shut down for a long period of time or the xml files for the items can be corrupt (see maintaining content index integrity).

There will be tab for each of the servers that are in the cluster, which will display the status of each of the indices.

Cleaning the indices

If the indices are out of sync there are a number of ways to resolve the issue. Below outlines the different options and when they should be used.

To run the options select the checkbox next to the collection store that needs to be re-indexed then click the submit button at the top of the page.

Please note that to perform a re-index across a number of servers the checkbox will need to be ticked for each server. Indexing should also be done with consideration to the number of items in the store and the effect it can have to performance (should only be a slight performance hit but should not be done at times of high traffic or heavy load).

Re-index all items

This option goes through each of the items currently in the index and then re-indexes them. This option should be used if an item's metadata or content is not correct, for example the status should be live but is being returned when searching for a staus of draft.

This will keep the other items in the indices however will not add any items that are not in the index. It can be run with little effect to end users.

Re-build index

This option deletes the indices and then rebuilds the indices based on the database.

This will update all the items and add any items that where not in the indices before (unless the items are corrupt). This option will cause all the items to "disappear" from any search results, and will appear slowly when they are added to the indices

Optimize index

When the indices are in use the files can become split over a number of files, this option brings the indices back to one file and improves the speed of searching the indices.

Viewing the indices

If you need to check the actual values that are stored in the indices the tool Luke[[2]] allows the items to be checked one by one. You will need to retreive the files from the server (see below)

Location of indices

To retrieve the indice files access to the servers will be required.

To find the location of the indices

  • Go to the Configuration module
  • Select the Clusters option under System Configuration
  • Select the edit option at the top of the page.
  • The location of the indices is in the "Search index folder path:" input.

See also

Rebuilding a corrupted index (filestores, datastores and user realms)

Personal tools