scriptburn / db-version-update
Package to update db structure acording to a target package version
Installs: 804
Dependents: 1
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
pkg:composer/scriptburn/db-version-update
Requires
- php: >=5.4.0
- scriptburn/db-settings: >=1.0
- scriptburn/simple-debug: >=1.0
This package is auto-updated.
Last update: 2025-10-29 02:03:08 UTC
README
##Usage:
Create a child class like this (A sample child class has been provided as sampleDbUpdateService.php):
class DbUpdateService extends \Scriptburn\UpdateDb
{
// will be called for target db version 1
public function update_routine_1()
{
/* make sure to return true
other wise db update will stop propogating
and update process will run again
*/
return true;
}
// will be called for target db version 2
public function update_routine_2()
{
/* make sure to return true
other wise db update will stop propogating
and update process will run again
*/
return true;
}
}
Next we will Call the actual function that checks if db update is needed. Best place for this code will be in a middleware
// make sure composer.json has a key named dbversion in it
$optionalVersionData=['type' => 'composer', 'path' => "/path/to/composer.json"];
$dbUpdateCheck = new App\Services\DbUpdateService(< instance of \ScriptBurn\Settings >, < instance of pdo connection >, $optionalVersionData);
//If you passed $optionalVersionData as 3rd parameter to App\Services\DbUpdateService constructor you do not need to pass current db version to method maybeUpdate as second parameter $dbUpdateCheck->maybeUpdate('scriptburn/git-auto-deploy',< optional current db version no >');