| commit | author | age | ||
| 532ae5 | 1 | |
| L | 2 | --------------------------------------------------------------------------------- |
| 3 | - Developer README | |
| 4 | --------------------------------------------------------------------------------- | |
| 5 | ||
| 6 | When you add or modify a database field or table in the ISPConfig database, | |
| 7 | then follow these steps: | |
| 8 | ||
| 9 | 1) Add the field or table in the ispconfig3.sql file. This file contains the | |
| 10 | complete database dump which is used when ISPConfig gets installed. | |
| 11 | ||
| 12 | 2) Create a new file in the "incremental" subfolder wich contains the alter | |
| 13 | table, or if it is a complete new table then the add table, statement(s) in | |
| 14 | MySQL syntax which is/are required to modify the current ispconfig database | |
| 15 | during update. The naming scheme of the sql patch update files is | |
| 16 | upd_0001.sql, upd_0002.sql, upd_0003.sql etc. Ensure that the number that | |
| 17 | you choose for the new file is a +1 increment of the number of the last | |
| 18 | existing file and that the number is formatted with 4 digits. | |
| 19 | ||
| 20 | A patch file may contain one or more alter table statements. Every patch file | |
| 21 | gets executed once in the database, so do not modify older (already released) | |
| 22 | patch files, they will not get executed again if the update was already run | |
| 23 | once on a system. | |
| 24 | ||
| 25 | After a patch has been executed, the dbversion field in the server table gets | |
| 26 | increeased to the version number of the last installed patch. | |
| 27 | ||
| 28 | If you like to run a patch file again for testing purposes on your dev machine, | |
| 29 | then set the number in "dbversion" field of the server table to be lower then | |
| 30 | the number of your patch. | |
| 31 | ||
| 32 | Note: Incremental patches are supported for installed ISPConfig versions > 3.0.3. | |
| 33 | If the installed version is < 3.0.3, then the full update method is used. | |
| 34 | In other words, ISPConfig 3.0.3 is the patch release (dbversion) 0 as the | |
| 35 | incremental update feature has been introduced in 3.0.3. | |
| 36 | ||
| 37 | ||
| 38 | ||
| 39 | ||
