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

reference (migration step)

Sets references (${ref.<name>}) for the steps and migrations after it in the run.

Download as PDF

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

On this page

reference

Sets references (${ref.<name>}) for the steps and migrations after it in the run.

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

Keys

KeyTypeDefaultWhat it is
setmaprequiredname => value: the references to set

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
*every name the step sets, with its value

Undoing

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

It touches no cache.

Example

- type: reference
  set:
    news_parent: ${idmap.node.news}

Generated by ./console exp:help:examples from settings/migration.ini, kernel/classes/migration/steps/expmigrationstepreference.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