All Products
Search

This Product

    OpenSearch:Restore data from an index

    Document Center

    OpenSearch:Restore data from an index

    Last Updated:Apr 24, 2026

    Background

    When you perform full indexing on data from an API data source, you can only retrieve data that was pushed within the last three days. To maintain data integrity, OpenSearch Retrieval Engine Edition lets you restore data from an index. This ensures all data from your API data source is retained in the next index version created by full indexing. The following diagram illustrates how this works.image

    Procedure

    Scenario: You need to perform full indexing on an API data source, for example, after you modify an index table or a dictionary. You must ensure that all data from the old index version is preserved in the new version.

    Steps:

    1. On the Instance Management page, navigate to O&M Center > O&M Management and click Restore Data from Index.

    1. Select an existing data source to restore.

    In the Restore Data from Index dialog box, a table lists the available data sources with the Data Source, Index Table, and Index Version to Restore columns. Select the radio button for the target data source.

    Note:

    • Only API data sources are displayed. The data source you select must have completed full indexing at least once.

    • You can restore data from only one data source at a time.

    1. If the conditions are met, click OK to submit the request.

    Note:

    • To restore data from an index, ensure that all fields are included in the summary.

    • If you submit the request when the conditions are not met, the restore process clears the content of any field that is not an attribute field or a search result field.

    1. After you submit the request, you can monitor the restore progress on the Data Source Changes tab in O&M Center > Change History:

    The page displays the progress of the Recover FSM in Index process. The process includes stages such as init, create snapshot, generate data, check gen_data status, prepare bs build data, bs build check, update finished time, and kill build task. A green checkmark is displayed after each stage is complete. You can click Details to view the execution details for each stage.

    1. When the FSM workflow on the Data Source Changes tab is complete, you can perform other operations that require full indexing, such as modifying an index table or adding a custom intervention entry. During the full indexing process, select Restore Data from Index as the data source to retain all data from the previous index version.

    Usage notes

    • The restore data from an index feature supports only API data sources.

    • To ensure the integrity of the restored data, all data fields must be configured as attribute fields or search result fields. When you restore data from an index, any field not configured as an attribute field or a search result field is cleared.