Entity Update

About Entity Update Module

The main objective of the module Entity Update is allowed module developer and site administrators to update entity types schema even entities have data.
The update can execute by drush command (recommended), from web browser or Programmatically.

The module also allow to view entity types list, entity types update status
and show the contents of an entity type.

CAUTION
- The entity update may damage your database, therefor 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 conscience what you are doing. You are the responsible of your work.

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

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 1.2

- Update a selected entity type.
Use the web browser for:
- View entity types list.
- View entity schema update status.
- View entities list.
- Run Entity update (Not recommended for production sites, use drush upe)

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.