New database update system that uses the database structure defined in dbstructure.php

[friendica.git] / update.php

diff --git a/update.php b/update.php
index 4f3f4daec63e6e781f8af8c08a4da39a85f37bf4..9303e5d19cdba01a51fb4a287d4fd13ed7de4705 100644 (file)
--- a/update.php
+++ b/update.php
@@ -10,26 +10,25 @@ define( 'UPDATE_VERSION' , 1170 );
  * copying the latest files from the source code repository will always perform a clean
  * and painless upgrade.
  *
- * Each function in this file is named update_nnnn() where nnnn is an increasing number 
+ * Each function in this file is named update_nnnn() where nnnn is an increasing number
  * which began counting at 1000.
- * 
+ *
  * At the top of the file "boot.php" is a define for DB_UPDATE_VERSION. Any time there is a change
  * to the database schema or one which requires an upgrade path from the existing application,
  * the DB_UPDATE_VERSION and the UPDATE_VERSION at the top of this file are incremented.
  *
  * The current DB_UPDATE_VERSION is stored in the config area of the database. If the application starts up
- * and DB_UPDATE_VERSION is greater than the last stored build number, we will process every update function 
- * in order from the currently stored value to the new DB_UPDATE_VERSION. This is expected to bring the system 
+ * and DB_UPDATE_VERSION is greater than the last stored build number, we will process every update function
+ * in order from the currently stored value to the new DB_UPDATE_VERSION. This is expected to bring the system
  * up to current without requiring re-installation or manual intervention.
  *
  * Once the upgrade functions have completed, the current DB_UPDATE_VERSION is stored as the current value.
- * The DB_UPDATE_VERSION will always be one greater than the last numbered script in this file. 
+ * The DB_UPDATE_VERSION will always be one greater than the last numbered script in this file.
  *
  * If you change the database schema, the following are required:
- *    1. Update the file database.sql to match the new schema.
- *    2. Update this file by adding a new function at the end with the number of the current DB_UPDATE_VERSION.
- *       This function should modify the current database schema and perform any other steps necessary
- *       to ensure that upgrade is silent and free from requiring interaction.
+ *    1. Update the file include/dbstructure.php to match the new schema.
+ *    2. If there is a need for a post procession, update this file by adding a new function at the end with the number of the current DB_UPDATE_VERSION.
+ *       This function should perform some post procession steps but no database updates.
  *    3. Increment the DB_UPDATE_VERSION in boot.php *AND* the UPDATE_VERSION in this file to match it
  *    4. TEST the upgrade prior to checkin and filing a pull request.
  *