Export a Lucene Index from a Running Production Instance

Info: This feature in Bloomreach Content requires a standard or premium license. Contact Bloomreach for details.

Info: Available since Hippo CMS 12.1.0.

Overview

This page explains how to export the Lucene index folder from a running production instance using the Lucene Export Service.

Exporting the Lucene index allows you to migrate a Bloomreach Content instance between environments without requiring a full reindex. Normally, backing up a Lucene index folder requires stopping the application. The Lucene Export feature provides a Repository JAX-RS service that enables you to export the Lucene index while the application is running.

For details about how the Lucene Export service operates, see Lucene Export Explained.

When to Use

Use the Lucene Export Service when you need to migrate or back up the Lucene index from a running production environment, and you want to avoid downtime for reindexing.

Prerequisites

The Lucene Export Service must be added to your project.
You must create and deploy a new project distribution that includes the service.
The Lucene Export Service is supported only in clustered configurations.

Exporting the Lucene Index

To export the Lucene index, download the exported index folder as a zip file from the following URL:

https://{hostname}/cms/ws/indexexport

Replace {hostname} with the hostname of your environment.

Importing the Lucene Index

To import the exported Lucene index into another environment:

Extract the contents of the zip file. This will include folders named _1, _2, _3, and the file indexRevision.properties.
Copy these folders and the properties file into the following directory:

{storageRoot}/workspaces/default/index/

{storageRoot} refers to your configured repository storage directory location.

Start the application. After a successful startup, the indexRevision.properties file should be removed automatically.

Verification

After importing and starting the application, confirm that the indexRevision.properties file no longer exists in the index directory. This indicates the import was successful and the index is in use.