Data migration actions¶
Some migration steps can contain a special actions
property.
You can find which migration steps support actions in the table below:
create |
update |
delete |
|
---|---|---|---|
content |
✔ | ✔ | ✔ |
content_type |
✔ | ✔ | ✔ |
role |
✔ | ✔ | |
user |
✔ | ✔ | |
user_group |
✔ | ✔ | |
company |
✔ |
Actions are optional operations that can be run after the main "body" of a migration has been executed (that is, content has been created / updated, Object state has been added, and so on). Their purpose is to allow additional operations to be performed as part of this particular migration. They are executed inside the same transaction, so in the event of failure they cause database rollback to occur.
For example, when updating a content type object, some fields might be removed:
1 2 3 4 5 6 7 8 9 10 11 |
|
When executed, this migration:
- Finds content type using its identifier (
article
) - Assigns content type Group "Media"
- Removes it from content type Group "Content"
- Removes the
short_title
Field - Removes its existing drafts, if any.
Available migration actions¶
The following migration actions are available out of the box:
assign_object_state
(Content Create)assign_parent_location
(Content Create / Update)assign_section
(Content Update)hide
(Content Create / Update)reveal
(Content Create / Update)assign_content_type_group
(Content type Create / Update)remove_drafts
(Content type Update)remove_field_by_identifier
(Content type Update)unassign_content_type_group
(Content type Update)assign_role_to_user
(Role Create / Update)assign_role_to_user_group
(Role Create / Update)assign_user_to_role
(User Create / Update)assign_user_group_to_role
(User Group Create / Update)unassign_role_user_group
(User Group Update)
In contrast with Kaliop migrations, actions provide you with ability to perform additional operations and extend the migration functionality. See creating your own Actions.
Action usage examples¶
Content¶
mode: Create
1 2 3 4 |
|
mode: Update
1 2 3 4 |
|
Content types¶
mode: Create
1 2 |
|
mode: Update
1 2 3 4 5 |
|
Roles¶
mode: Create and Update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
|
Users¶
mode: Create and Update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
|
User Groups¶
mode: Create and Update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
|
Note
In the assign_user_group_to_role
action, Limitation type Section can only use Section ID.
mode: Update
1 2 3 4 |
|
Note
In the unassign_role_user_group
action, the ID is Role assignment ID from the ezuser_role
table.