Distributed Index Handler 12.13

# DREINITIAL

Allows you to delete all data from your IDOL Server data index, and to reset the data index.

By default, `DREINITIAL` also clears the contents of the index queue, including any queued index actions. You can preserve the index queue by using the PreserveQueue parameter, or by setting the `PreserveOnInitial` configuration parameter in the child server configuration file.

You can also use `DREINITIAL` to restore a backup file (created by using the DREBACKUP index action) to an IDOL Server, using the following index action:

    http://IDOLhost:indexPort/DREINITIAL?Path=path

where,

`IDOLhost` | is the IP address or host name of the machine on which DIH is installed.
`indexPort` | is the Distributed Index Handler index port (specified by the DIHPort parameter in the configuration file `[Server]` section).
`path` | is the path to the location of the IDOL Server backup, created by DREBACKUP.

NOTE: If you use `DREINITIAL` to restore from a backup, the index action is added to the backup event list. You can control the length of this list by using the `BackupListLength` configuration parameter in the IDOL Server configuration file.

The `DREINITIAL` index action initializes or restores only the index data files, and does not affect your configuration file. When you initialize the index, or restore from a backup, it does not overwrite any configuration file changes you have made.

NOTE: When you restore from a backup using `DREINITIAL`, IDOL Server does not reindex the data.

When you want to update a configuration parameter that requires you to reindex your data, you can use DREEXPORTIDX or DREEXPORTXML to export an IDX or XML file. You can then initialize your index, make your configuration changes and index the IDX or XML file back into IDOL Server.

Because the `DREINITIAL` index action resets the index, the index action always returns its index ID as 1. To allow you to track the process, Micro Focus recommends that you set the InitialID parameter in the `DREINITIAL` index action. The IDOL Server `GetStatus` action reports the InitialID of the last `DREINITIAL` that it processed, which allows you to check whether the `DREINITIAL` index action has been completed. The InitialID also ensures that if the server receives the same request multiple times, it processes only the first one.

## Examples

    http://12.3.4.56:9071/DREINITIAL?

This index action resets the IDOL Server data index.

    http://12.3.4.56:9071/DREINITIAL?Path=E:\DataIndex_Backup

This index action restores the files backed up on `E:\DataIndex_Backup` to IDOL Server.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
ArchiveCleanupCutOffTime | The latest time for which you want to keep archives.
BackupTime | The time when the backup specified by the `Path` parameter was created.
HostDetails | Whether the restoration must use a backup directory based on a specific host and port combination.
InitialID | The ID of the `DREINITIAL` index action to process when multiple actions are sent.
Path | The full path to the data backup.
PreserveQueue | Whether to preserve the index queue when you initialize the index.
ReplayArchivePath | The path of the archive that contains the index commands to replay.
RestoreTime | The time to which you want to restore your index.

This index action accepts the following standard index action parameters.

Parameter | Description
--- | ---
IgnoreMaxPendingItems | Whether to ignore the IndexQueueMaxPendingItems limit for this index action.
IndexUID | An identification code for any document tracking events.
NoArchive | Turn off configured archiving for the index action.
Priority | The priority for the index job.

© Copyright 2022 Micro Focus or one of its affiliates
Version 12.13 | Last updated October 2022

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to swpdl.idoldocsfeedback@microfocus.com.

We appreciate your feedback!

Product: IDOL Distributed Index Handler 12.13

Topic Title: DREINITIAL