Export a Lucene Index from a Running Production Instance - BloomReach Experience - Open Source CMS

This article covers a Hippo CMS version 12. There's an updated version available that covers our most recent release.

30-11-2017

Export a Lucene Index from a Running Production Instance

This Bloomreach Experience Manager feature requires a standard or premium license. Please contact BloomReach for more information.
This feature is available since Hippo CMS 12.1.0

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.

Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?