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

migration.ini [StepSettings]

The settings of [StepSettings] in migration.ini: StepTypeList, CommandAllowList, MaxLoopIterations

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/examples/ini-settings/migration/StepSettings.md

On this page

migration.ini [StepSettings]

The block [StepSettings] of settings/migration.ini, with 3 setting(s).

Never edit settings/migration.ini itself: an update replaces it. Put the settings you change in an override, which wins over the shipped file:

  • settings/override/migration.ini.append.php for every siteaccess,
  • settings/siteaccess/<siteaccess>/migration.ini.append.php for one siteaccess,
  • extension/<extension>/settings/migration.ini.append.php in an extension (read when the extension is active).

StepTypeList

The step types of YAML migrations: StepTypeList[<name>]=<class>, where <name> is what "type:" of a step names and
the class implements expMigrationStepType. An extension registers its own in its migration.ini.append.php.

Default: a hash of 33: reference=expMigrationStepReference, assert=expMigrationStepAssert, content=expMigrationStepContent, location=expMigrationStepLocation, content_version=expMigrationStepContentVersion, content_class=expMigrationStepContentClass, content_class_group=expMigrationStepContentClassGroup, user=expMigrationStepUser, user_group=expMigrationStepUserGroup, role=expMigrationStepRole, section=expMigrationStepSection, language=expMigrationStepLanguage ....

<?php /* #?ini charset="utf-8"?
# settings/override/migration.ini.append.php
[StepSettings]
# an empty "StepTypeList[]" first replaces the shipped list; without it the items are added
StepTypeList[]
StepTypeList[reference]=expMigrationStepReference
StepTypeList[assert]=expMigrationStepAssert
StepTypeList[content]=expMigrationStepContent
StepTypeList[location]=expMigrationStepLocation
StepTypeList[content_version]=expMigrationStepContentVersion
StepTypeList[content_class]=expMigrationStepContentClass
StepTypeList[content_class_group]=expMigrationStepContentClassGroup
StepTypeList[user]=expMigrationStepUser
StepTypeList[user_group]=expMigrationStepUserGroup
StepTypeList[role]=expMigrationStepRole
StepTypeList[section]=expMigrationStepSection
StepTypeList[language]=expMigrationStepLanguage
StepTypeList[object_state_group]=expMigrationStepObjectStateGroup
StepTypeList[tag]=expMigrationStepTag
StepTypeList[url_alias]=expMigrationStepUrlAlias
StepTypeList[trash]=expMigrationStepTrash
StepTypeList[file]=expMigrationStepFile
StepTypeList[image]=expMigrationStepImage
StepTypeList[cache]=expMigrationStepCache
StepTypeList[search]=expMigrationStepSearch
# ... 13 more in the shipped file
*/ ?>

CommandAllowList

The console commands the step type command may run: exp:* commands of ./console, by name (exp:services:compile) or
with * at the end for a group (exp:static:*). Nothing else runs, and exp:migration:* and exp:upgrade* never do
(they take the lock the run holds). There is no shell: the command and its arguments are handed over as a list.

Default: a list of 4: exp:services:compile, exp:graphql:persist, exp:help:content, exp:static:build.

<?php /* #?ini charset="utf-8"?
# settings/override/migration.ini.append.php
[StepSettings]
# an empty "CommandAllowList[]" first replaces the shipped list; without it the items are added
CommandAllowList[]
CommandAllowList[]=exp:services:compile
CommandAllowList[]=exp:graphql:persist
CommandAllowList[]=exp:help:content
CommandAllowList[]=exp:static:build
*/ ?>

MaxLoopIterations

The most turns a "while" loop of a YAML migration takes when it names no "max"; one more fails the migration.

Default: 1000.

<?php /* #?ini charset="utf-8"?
# settings/override/migration.ini.append.php
[StepSettings]
MaxLoopIterations=1000
*/ ?>

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