Help Center

Menu

collection-update.step.[stepTechnicalName].run

Background

This is used to control the execution of specific steps during a data source/search package update or during a commit, merge, or vacuum for a push data source.

To skip a step, you need to find the technical name of the step. All steps processed during the update are output in update-<ID>.log. The technical name is inserted next to the step description in brackets.

The technical name of the step is included as well in the name of step’s log file following the pattern Step-<stepTechnicalName>.log. Note, the log file is created only for the executed steps (and not for skipped steps).

Setting the key

Set this configuration key in the search package or data source configuration.

Use the configuration key editor to add or edit the collection-update.step.[stepTechnicalName].run key, and set the value. This can be set to any valid Boolean value.

Default value

By default, these values are assumed to be true.

Examples

To skip building spelling for the search package, set:

collection-update.step.BuildSpellingForMeta.run=false

And in update.log, you could see the output

...
Starting: Builds the meta index.
    Creating spelling suggestions. (BuildSpellingForMeta)
        skipped because config option:'collection-update.step.BuildSpellingForMeta.run' was set to 'false'., in 0.1s
    Downloading query completion CSV files. (BuildAutoCompletionGatherRemoteCSV)
        completed in 0.591s
    Building query completion index. (BuildAutoCompletionForMeta)
        completed in 0.494s
...

Notes

Care must be taken when skipping steps, as some later steps may have dependencies on previous steps.

Care must also be taken on upgrades, as the technical name for steps may change without notice.