Clarify update.php doc and mention Database\PostUpdate

This commit is contained in:
Hypolite Petovan 2020-01-19 09:24:46 -05:00
parent db518e7ef2
commit bac5159f6f
2 changed files with 10 additions and 7 deletions

View file

@ -10,11 +10,14 @@ use Friendica\DI;
use Friendica\Model\Contact; use Friendica\Model\Contact;
use Friendica\Model\Item; use Friendica\Model\Item;
use Friendica\Model\ItemURI; use Friendica\Model\ItemURI;
use Friendica\Model\UserItem;
use Friendica\Model\PermissionSet; use Friendica\Model\PermissionSet;
use Friendica\Model\UserItem;
/** /**
* Post update functions * These database-intensive post update routines are meant to be executed in the background by the cronjob.
*
* If there is a need for a intensive migration after a database structure change, update this file
* by adding a new method at the end with the number of the new DB_UPDATE_VERSION.
*/ */
class PostUpdate class PostUpdate
{ {

View file

@ -15,15 +15,15 @@ use Friendica\Util\DateTimeFormat;
use Friendica\Worker\Delivery; use Friendica\Worker\Delivery;
/** /**
* update.php - automatic post-databse structure change updates
* *
* update.php - automatic system update * These functions are responsible for doing critical post update changes to the data (not the structure) in the database.
*
* This function is responsible for doing post update changes to the data
* (not the structure) in the database.
* *
* Database structure changes are done in static/dbstructure.config.php * Database structure changes are done in static/dbstructure.config.php
* *
* If there is a need for a post process to a structure change, update this file * For non-critical database migrations, please add a method in the Database\PostUpdate class
*
* If there is a need for a post update to a structure change, update this file
* by adding a new function at the end with the number of the new DB_UPDATE_VERSION. * by adding a new function at the end with the number of the new DB_UPDATE_VERSION.
* *
* The numbered script in this file has to be exactly like the DB_UPDATE_VERSION * The numbered script in this file has to be exactly like the DB_UPDATE_VERSION