Product DocsMenu

Manually Backing Up and Restoring the Index

Notes:

Like other information system, it is a disaster recovery plan best practice to regularly back up your Coveo index to minimize search down time in the case of an unplanned major issue. Backing up your Coveo index is especially important when it includes sources with a large number of documents that can take a significant amount of time and computing resources to rebuild from scratch.

You must back up the index while the index is in read-only mode or when the CES service is stopped. In both cases, the index files are not locked by a CES process so you can integrally copy all index files. It is recommended to use the read-only mode so that end-users can continue to send queries and receive search results during the backup process. When the CES service is stopped, end-users cannot perform queries. When restoring the index, you however must stop the CES service.

Tip: You can use the system schedules to automatically set your index in read-only mode at specific times (see Modifying System Schedules) and synchronize an automated index backup.

Important:

Note: When you run CES in a virtual environment, you can also consider creating snapshots of the virtual machine (VM) on which CES runs to back up the index and the complete CES installation. Before creating a VM snapshot, you must however ensure that the index is switched to the read-only mode (see Toggling the Index Between the Read-Write and Read-Only Modes).

To back up the index

  1. Using an administrator account, connect to the Coveo Master server.

  2. Put the index in the read-only mode (see Toggling the Index Between the Read-Write and Read-Only Modes).

  3. Copy the content of the original [Index_Path] folder (C:\CES7\ by default).

    Note: In read-only mode, exclude the files in the C:\CES7\Temp\ subfolder from the backed up content as the files in this folder are used by the index as a temporary cache for user queries and will be locked by CES. These file are not required to perform an integral index copy.

  4. Paste the copied content in a backup location of your choice.

  5. When the paste process is completed, put the index back in the read-write mode (see Toggling the Index Between the Read-Write and Read-Only Modes).

To restore the index from a backup copy

  1. Using an administrator account, connect to the Coveo Master server.

  2. Stop the CES service (see Stopping the CES Service).

    Important: Restoring a backup copy of an index while indexing or while in read-only mode will most likely result in a corrupted index.

  3. Delete all files and folders under the [Index_Path] folder (C:\CES7\ by default).

    It is mandatory to delete the existing index files. Otherwise, the transactions generated by the current index will remain in the subfolder while the new index files are being copied. Later on, CES will try to apply these transactions and this will most likely result in a corrupted index.

    Note: When you have sufficient disk space on your Coveo Master server to hold two versions of the index, you can simply rename the [Index_Path] folder rather than deleting its content.

  4. Restore the index backup files to the [Index_Path] folder.

  5. Restart the CES service (see Starting the CES Service).

People who viewed this topic also viewed