Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,059 of 9,059 pages
About the help in other languages
All help pages

search (migration step)

Reindexes objects in the search engine (the ones named or the ones the run changed), or every object.

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/examples/migration-steps/search.md

On this page

search

Reindexes objects in the search engine (the ones named or the ones the run changed), or every object.

A step of a YAML migration with type: search. The class expMigrationStepSearch (kernel/classes/migration/steps/expmigrationstepsearch.php) is registered in settings/migration.ini [StepSettings] StepTypeList[search].

Modes

mode: is one of reindex, full; without it, reindex.

Keys

KeyTypeModesDefaultWhat it is
objectslistreindexthe objects (id, remote:, path:); without: the objects the run created or changed so far
classeslistfullonly the objects of these classes (identifiers)
queueboolalltruetrue: queued for the cronjob indexcontent; false: indexed at once

Besides these, every step takes the keys of the engine: type, mode, if, references, environments, engines and comment (the file format). A key of type identifier names a node, an object or another part of the installation by id, remote id, path or name (identifiers).

Values for references

references: { <name>: <value> } keeps a value of the step's result as ${ref.<name>} for the steps and migrations after it:

ValueWhat it is
counthow many objects were queued or indexed

Undoing

Every step of this type undoes itself when its migration is rolled back without down:.

It touches no cache.

Example

- type: search
  mode: reindex
  objects: [ "remote:home" ]
  queue: false

Generated by ./console exp:help:examples from settings/migration.ini, kernel/classes/migration/steps/expmigrationstepsearch.php. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x