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 [RecordingSettings]

The settings of [RecordingSettings] in migration.ini: Recording, EventList, UserKeepAttributeList, MaxEvents

Download as PDF

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

On this page

migration.ini [RecordingSettings]

The block [RecordingSettings] of settings/migration.ini, with 4 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).

Recording

Recordings of changes (./console exp:migration:record:start, Setup > Migrations > Recording): what is changed in
the administration, the website sidebar or a command while a recording runs is kept as the steps of a YAML
migration, for ./console exp:migration:generate --from-recording=<id>. A session recording keeps one user's own
changes; a site-wide recording keeps every change of every user. The recording sees the kernel's operations
(content published, a node moved, a class stored, a role changed, a setting written ...), not web requests.

disabled: nothing is recorded and no recording can be started.

Default: enabled.

<?php /* #?ini charset="utf-8"?
# settings/override/migration.ini.append.php
[RecordingSettings]
Recording=enabled
*/ ?>

EventList

The audit events a recording keeps, by name (the kernel's audit taxonomy). Empty: every event a migration step can
repeat (the list of expMigrationRecordingEvent::STEPS, in guides/migrations-generators-and-recording.md).

Default: an empty list.

<?php /* #?ini charset="utf-8"?
# settings/override/migration.ini.append.php
[RecordingSettings]
# an empty "EventList[]" first replaces the shipped list; without it the items are added
EventList[]
*/ ?>

UserKeepAttributeList

The attributes of user objects that are not personal data and may be recorded (identifiers, e.g. a "signature"
a site uses for a team account). Empty: none. The account (login, e-mail, password) is never recorded, whatever
this says: a generated migration names it by a secret reference.

Default: an empty list.

<?php /* #?ini charset="utf-8"?
# settings/override/migration.ini.append.php
[RecordingSettings]
# an empty "UserKeepAttributeList[]" first replaces the shipped list; without it the items are added
UserKeepAttributeList[]
*/ ?>

MaxEvents

The most events one recording keeps; the recording keeps running but adds nothing more, and says so. 0: no limit.

Default: 10000.

<?php /* #?ini charset="utf-8"?
# settings/override/migration.ini.append.php
[RecordingSettings]
MaxEvents=10000
*/ ?>

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