Export a Lucene Index from a Running Production Instance

Introduction

Goal

Export the Lucene index folder from a running production instance using the Lucene Export Service.

Background

When moving a Bloomreach Experience Manager instance from one environment to another, it may be desirable to move its Lucene index along with it to prevent the need for (time-consuming) reindexing. However, to backup a Lucene index folder normally requires that the application is not running. The optional Lucene Export feature adds a Repository JAX-RS service which enables on-the-fly exporting of the Lucene index from a running production instance.

This page describes how to use the Lucene Export service.

To understand how the Lucene Export service works, see Lucene Export Explained.

Prerequisites

• Before you can use the Lucene Export Service, it must be added to the project and a new project distribution must be created and deployed.
• The Lucene Export Service is only supported in clustered configurations.

Export a Lucene Index

Download the exported Lucene index folder as a zip file from the following URL:

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

(where {hostname} is the host name of your environment)

Import a Lucene Index

To import the exported Lucene index into an environment, extract the contents of the zip file (the _1, _2, _3, etc. folders, and indexRevision.properties file) in the folder:

{storageRoot}/workspaces/default/index/

(where {storageRoot} is the configured repository storage directory location)

After successful startup of the application, the file indexRevision.properties should disappear automatically.