Database versioning - Revision history

Kfoster: /* Steps to add a new DB version\changes to the existing database */

2023-10-05T12:01:02Z

Steps to add a new DB version\changes to the existing database

← Older revision		Revision as of 14:01, 5 October 2023
Line 10:		Line 10:
	{{Alert\| Never use models in the update function.}}		{{Alert\| Never use models in the update function.}}

	*Open ''/application/config/version.php'' and raise the $dbversion variable by one. For example if the current DBversion is 180 make it 181.		*Open /application/config/version.php and raise the $dbversion variable by one. For example if the current DBversion is 180 make it 181.
	*Apply your change to installer/php/create-database.php and possibly ls default datasets.		*Apply your change to installer/php/create-database.php and possibly ls default datasets.
	* Create a new update patch file in /application/helpers/update/updates with the format Update_###.php where "###" is the next number in the sequence of existing patch files. This file should contain a class of the same name (Update_###) which extends DatabaseUpdateBase and has a public function "up()" which contains the DB patch code. See existing patch files for examples.		* Create a new update patch file in /application/helpers/update/updates with the format Update_###.php where "###" is the next number in the sequence of existing patch files. This file should contain a class of the same name (Update_###) which extends DatabaseUpdateBase and has a public function "up()" which contains the DB patch code. See existing patch files for examples.

Kfoster: /* Steps to add a new DB version\changes to the existing database */

2023-10-05T12:00:06Z

Steps to add a new DB version\changes to the existing database

← Older revision		Revision as of 14:00, 5 October 2023
Line 10:		Line 10:
	{{Alert\| Never use models in the update function.}}		{{Alert\| Never use models in the update function.}}

	*Open /application/config/version.php and raise the $dbversion variable by one. For example if the current DBversion is 180 make it 181.		*Open ''/application/config/version.php'' and raise the $dbversion variable by one. For example if the current DBversion is 180 make it 181.
	*Apply your change to installer/php/create-database.php and possibly ls default datasets.		*Apply your change to installer/php/create-database.php and possibly ls default datasets.
	* Create a new update patch file in /application/helpers/update/updates with the format Update_###.php where "###" is the next number in the sequence of existing patch files. This file should contain a class of the same name (Update_###) which extends DatabaseUpdateBase and has a public function "up()" which contains the DB patch code. See existing patch files for examples.		* Create a new update patch file in /application/helpers/update/updates with the format Update_###.php where "###" is the next number in the sequence of existing patch files. This file should contain a class of the same name (Update_###) which extends DatabaseUpdateBase and has a public function "up()" which contains the DB patch code. See existing patch files for examples.

Kfoster: /* Steps to add a new DB version\changes to the existing database */

2023-10-05T11:58:45Z

Steps to add a new DB version\changes to the existing database

← Older revision		Revision as of 13:58, 5 October 2023
Line 10:		Line 10:
	{{Alert\| Never use models in the update function.}}		{{Alert\| Never use models in the update function.}}

	*Open \application\config\version.php and raise the $dbversion variable by one. For example if the current DBversion is 180 make it 181.		*Open /application/config/version.php and raise the $dbversion variable by one. For example if the current DBversion is 180 make it 181.
	*Apply your change to installer/php/create-database.php and possibly ls default datasets.		*Apply your change to installer/php/create-database.php and possibly ls default datasets.
	* Create a new update patch file in \application\helpers\update\updates with the format Update_###.php where "###" is the next number in the sequence of existing patch files. This file should contain a class of the same name (Update_###) which extends DatabaseUpdateBase and has a public function "up()" which contains the DB patch code. See existing patch files for examples.		* Create a new update patch file in /application/helpers/update/updates with the format Update_###.php where "###" is the next number in the sequence of existing patch files. This file should contain a class of the same name (Update_###) which extends DatabaseUpdateBase and has a public function "up()" which contains the DB patch code. See existing patch files for examples.
	*If your update is a critical update then you need it to mark it as such. In the beginning of the function you will find a variable named $aCriticalDBVersions - add your version number to it if it is a critical database version update.		*If your update is a critical update then you need it to mark it as such. In the beginning of the function you will find a variable named $aCriticalDBVersions - add your version number to it if it is a critical database version update.
	* Run the unit tests by typing <code>phpunit --group db</code> in the root folder, to make sure you didn't introduce any syntactic errors.		* Run the unit tests by typing <code>phpunit --group db</code> in the root folder, to make sure you didn't introduce any syntactic errors.

Kfoster: /* Steps to add a new DB version\changes to the existing database */

2023-10-05T11:58:12Z

Steps to add a new DB version\changes to the existing database

← Older revision		Revision as of 13:58, 5 October 2023
Line 12:		Line 12:
	*Open \application\config\version.php and raise the $dbversion variable by one. For example if the current DBversion is 180 make it 181.		*Open \application\config\version.php and raise the $dbversion variable by one. For example if the current DBversion is 180 make it 181.
	*Apply your change to installer/php/create-database.php and possibly ls default datasets.		*Apply your change to installer/php/create-database.php and possibly ls default datasets.
	*~~Open~~ \application\helpers\update\~~updatedb_helper and~~ in the ~~end~~ of the function ~~db_upgrade_all~~() ~~add a new conditional~~ code ~~block that does the necessary updates to the database scheme of the previous version~~. ~~If you are using the proper functions the changes will be cross-DB compatible - check out how it is done in previous conditional blocks~~.		* Create a new update patch file in \application\helpers\update\updates with the format Update_###.php where "###" is the next number in the sequence of existing patch files. This file should contain a class of the same name (Update_###) which extends DatabaseUpdateBase and has a public function "up()" which contains the DB patch code. See existing patch files for examples.
	*If your update is a critical update then you need it to mark it as such. In the beginning of the function you will find a variable named $aCriticalDBVersions - add your version number to it if it is a critical database version update.		*If your update is a critical update then you need it to mark it as such. In the beginning of the function you will find a variable named $aCriticalDBVersions - add your version number to it if it is a critical database version update.
	* Run the unit tests by typing <code>phpunit --group db</code> in the root folder, to make sure you didn't introduce any syntactic errors.		* Run the unit tests by typing <code>phpunit --group db</code> in the root folder, to make sure you didn't introduce any syntactic errors.

C schmitz: /* General */

2021-12-02T16:47:47Z

General

← Older revision		Revision as of 18:47, 2 December 2021
Line 2:		Line 2:
	=General=		=General=

	This page ~~is a stump and tries to explain~~ how to raise the DBVersion number and where to make changes in the source code. These instructions apply to v 2.0 or later.		This page explains how to raise the DBVersion number and where to make changes in the source code. These instructions apply to v 2.0 or later.

	You will typically need this if you are a LimeSurvey developer and want to introduce changes to the database. Please note: Do '''~~not~~''' introduce database changes on a stable version.		You will typically need this if you are a LimeSurvey developer and want to introduce changes to the database. Please note: '''Avoid''' to introduce database changes on a stable version. This should only be done if it is necessary to fix a bug.

	==Steps to add a new DB version\changes to the existing database==		==Steps to add a new DB version\changes to the existing database==

Olle: /* Steps to add a new DB version\changes to the existing database */

2020-07-10T13:36:34Z

Steps to add a new DB version\changes to the existing database

← Older revision		Revision as of 15:36, 10 July 2020
Line 11:		Line 11:

	*Open \application\config\version.php and raise the $dbversion variable by one. For example if the current DBversion is 180 make it 181.		*Open \application\config\version.php and raise the $dbversion variable by one. For example if the current DBversion is 180 make it 181.
	*~~<strike>Open each file in \installer\sql and add the necessary changes. Make sure the changes are consistent across all three files. Pay attention~~ to the database specific field types (check out other tables for comparison/examples). For example: If you need to use field type 'text' then make it 'varchar(max)' in MSSQL.</strike> All SQL files have been removed in favour of one PHP file in installer/php/create-database.php~~. This needs to be updated~~.		*Apply your change to installer/php/create-database.php and possibly ls default datasets.
	*Open \application\helpers\update\updatedb_helper and in the end of the function db_upgrade_all() add a new conditional code block that does the necessary updates to the database scheme of the previous version. If you are using the proper functions the changes will be cross-DB compatible - check out how it is done in previous conditional blocks.		*Open \application\helpers\update\updatedb_helper and in the end of the function db_upgrade_all() add a new conditional code block that does the necessary updates to the database scheme of the previous version. If you are using the proper functions the changes will be cross-DB compatible - check out how it is done in previous conditional blocks.
	*If your update is a critical update then you need it to mark it as such. In the beginning of the function you will find a variable named $aCriticalDBVersions - add your version number to it if it is a critical database version update.		*If your update is a critical update then you need it to mark it as such. In the beginning of the function you will find a variable named $aCriticalDBVersions - add your version number to it if it is a critical database version update.

Olle: /* Steps to add a new DB version\changes to the existing database */

2020-07-10T13:35:34Z

Steps to add a new DB version\changes to the existing database

← Older revision		Revision as of 15:35, 10 July 2020
Line 11:		Line 11:

	*Open \application\config\version.php and raise the $dbversion variable by one. For example if the current DBversion is 180 make it 181.		*Open \application\config\version.php and raise the $dbversion variable by one. For example if the current DBversion is 180 make it 181.
	*<strike>Open each file in \installer\sql and add the necessary changes. Make sure the changes are consistent across all three files. Pay attention to the database specific field types (check out other tables for comparison/examples). For example: If you need to use field type 'text' then make it 'varchar(max)' in MSSQL.</strike> All SQL files have been removed in favour of one PHP file in installer/php/create-database.php.		*<strike>Open each file in \installer\sql and add the necessary changes. Make sure the changes are consistent across all three files. Pay attention to the database specific field types (check out other tables for comparison/examples). For example: If you need to use field type 'text' then make it 'varchar(max)' in MSSQL.</strike> All SQL files have been removed in favour of one PHP file in installer/php/create-database.php. This needs to be updated.
	*Open \application\helpers\update\updatedb_helper and in the end of the function db_upgrade_all() add a new conditional code block that does the necessary updates to the database scheme of the previous version. If you are using the proper functions the changes will be cross-DB compatible - check out how it is done in previous conditional blocks.		*Open \application\helpers\update\updatedb_helper and in the end of the function db_upgrade_all() add a new conditional code block that does the necessary updates to the database scheme of the previous version. If you are using the proper functions the changes will be cross-DB compatible - check out how it is done in previous conditional blocks.
	*If your update is a critical update then you need it to mark it as such. In the beginning of the function you will find a variable named $aCriticalDBVersions - add your version number to it if it is a critical database version update.		*If your update is a critical update then you need it to mark it as such. In the beginning of the function you will find a variable named $aCriticalDBVersions - add your version number to it if it is a critical database version update.

Olle: /* General */

2018-01-12T11:25:12Z

General

← Older revision		Revision as of 13:25, 12 January 2018
Line 14:		Line 14:
	*Open \application\helpers\update\updatedb_helper and in the end of the function db_upgrade_all() add a new conditional code block that does the necessary updates to the database scheme of the previous version. If you are using the proper functions the changes will be cross-DB compatible - check out how it is done in previous conditional blocks.		*Open \application\helpers\update\updatedb_helper and in the end of the function db_upgrade_all() add a new conditional code block that does the necessary updates to the database scheme of the previous version. If you are using the proper functions the changes will be cross-DB compatible - check out how it is done in previous conditional blocks.
	*If your update is a critical update then you need it to mark it as such. In the beginning of the function you will find a variable named $aCriticalDBVersions - add your version number to it if it is a critical database version update.		*If your update is a critical update then you need it to mark it as such. In the beginning of the function you will find a variable named $aCriticalDBVersions - add your version number to it if it is a critical database version update.
	*At the bottom of <code>db_update_all</code>, update the notification message ("The database has been updated from version ..."), e.g. from 260 to 261.
	* Run the unit tests by typing <code>phpunit --group db</code> in the root folder, to make sure you didn't introduce any syntactic errors.		* Run the unit tests by typing <code>phpunit --group db</code> in the root folder, to make sure you didn't introduce any syntactic errors.

Olle: /* General */

2018-01-12T11:23:58Z

General

← Older revision		Revision as of 13:23, 12 January 2018
Line 12:		Line 12:
	*Open \application\config\version.php and raise the $dbversion variable by one. For example if the current DBversion is 180 make it 181.		*Open \application\config\version.php and raise the $dbversion variable by one. For example if the current DBversion is 180 make it 181.
	*<strike>Open each file in \installer\sql and add the necessary changes. Make sure the changes are consistent across all three files. Pay attention to the database specific field types (check out other tables for comparison/examples). For example: If you need to use field type 'text' then make it 'varchar(max)' in MSSQL.</strike> All SQL files have been removed in favour of one PHP file in installer/php/create-database.php.		*<strike>Open each file in \installer\sql and add the necessary changes. Make sure the changes are consistent across all three files. Pay attention to the database specific field types (check out other tables for comparison/examples). For example: If you need to use field type 'text' then make it 'varchar(max)' in MSSQL.</strike> All SQL files have been removed in favour of one PHP file in installer/php/create-database.php.
	*<strike>In each file in \installer\sql edit the last SQL statement in each to reflect the new dbversion number.</strike> Update the <code>$databaseCurrentVersion</code> variable at the top of create-database.php.
	*Open \application\helpers\update\updatedb_helper and in the end of the function db_upgrade_all() add a new conditional code block that does the necessary updates to the database scheme of the previous version. If you are using the proper functions the changes will be cross-DB compatible - check out how it is done in previous conditional blocks.		*Open \application\helpers\update\updatedb_helper and in the end of the function db_upgrade_all() add a new conditional code block that does the necessary updates to the database scheme of the previous version. If you are using the proper functions the changes will be cross-DB compatible - check out how it is done in previous conditional blocks.
	*If your update is a critical update then you need it to mark it as such. In the beginning of the function you will find a variable named $aCriticalDBVersions - add your version number to it if it is a critical database version update.		*If your update is a critical update then you need it to mark it as such. In the beginning of the function you will find a variable named $aCriticalDBVersions - add your version number to it if it is a critical database version update.

Olle: /* Steps to add a new DB version\changes to the existing database */

2017-10-19T09:25:28Z

Steps to add a new DB version\changes to the existing database

← Older revision		Revision as of 11:25, 19 October 2017
Line 8:		Line 8:
	==Steps to add a new DB version\changes to the existing database==		==Steps to add a new DB version\changes to the existing database==

	{{Alert\|Never use models in the update function.}}		{{Alert\| Never use models in the update function.}}

	*Open \application\config\version.php and raise the $dbversion variable by one. For example if the current DBversion is 180 make it 181.		*Open \application\config\version.php and raise the $dbversion variable by one. For example if the current DBversion is 180 make it 181.