This module allows you to update entity types and their fields, even when entities already contain data. You can perform these updates via Drush, the web browser, or programmatically. It also provides tools to view the status of entity updates and examine entity content.
The main objective of this module is to allow module developers and site administrators to update entity types schema even when entities have data.
The update can be executed via Drush (recommended), from the web browser, or programmatically.
The module also allows to view the list of entity types, the entity types update status
and show the content of an entity type.
CAUTION
- The entity update may damage your database; backup the database before any action.
- For the production sites, test twice on a non-production site and put the site into maintain mode before any execution.
- If you use this module, you are aware of what you are doing. You are responsible of what you do.
Documentation
- Entity Update documentation
- Entity Update from drush
- Entity Update usage from web browser
- Update entities programmatically
- Usage in production sites
Installation
Download via Composer and install via Drush.
composer require drupal/entity_update
drush en entity_update -y
Download and install via Drush.
drush en entity_update -y
Similar modules
The Devel Entity Updates module is similar to this module except that this module allows to:
- Update fields even entities have data
- Update from web interface
- View changes on web interface
- View entity data quickly
Actions and Displays
No need to configure the module, but you can check Entities update status via:
- Administration -> Configuration -> Development -> Entity Update.
- Link : /admin/config/development/entity-update.
Permission : Administer software updates
NEW from Version 3.0
- The version 3 is compatible from Drupal 9.4
NEW from Version 2.0
- The version 2 is compatible from Drupal 8.7
Test module
The module provide a test module entity_update_tests with configurable fields.
Configuration : /admin/config/development/entity-update/tests
Usage Examples : entity-update (Via drush)
Drush command : entity:update
Alias : upe
1. Show Entities to update
drush upe --show
2. Update without automatic database backup using basic method.
Not recommended for --all, suitable for --basic
drush upe --basic --nobackup
3. Update All Entities.
drush upe --all
4. Create entities from entity backup database.
If entity recreation failed (on drush upe --all), You can you this option to
create entities from entity backup database.
drush upe --rescue
5. Cleanup entity backup database
drush upe --clean
6. Install New Entity type after module installation or update a selected entity type.
drush upe ENTITY_TYPE_ID -y
Usage Examples : entity-check
This command allow to show entities and entity types via drush.
Drush command : entity:check
Alias : upec
1. Show The summery of an entity type.
drush upec node
2. Show all entity types.
drush upec --types
3. Show all entity types contains "block".
drush upec block --types
4. Show 5 entities from 2 of the type 'node'.
drush upec node --list --start=2 --length=5
Thank you for using Entity Update Module.