...
To implement a schema level update, two steps must be taken:
The new numeric schema level must be specified in the plugin’s descriptor file.
The actual schema update must be implemented.
Define new schema level in plugin descriptor
...
| Codeblock | ||
|---|---|---|
| ||
{
"$schema": "http://git.intra.pinuts.de/cmsbs/cmsbs/raw/master/doc/json-schemas/plugin.desc.json",
"__encoding": "Pinuts File Encoding: UTF-8",
"name": "de.acme.projectxtutorial",
...,
"dbSchema": 1
} |
Implement schema update
Create a new ES6 file in your plugin’s CSE directory. If your plugin’s name is de.acme.projectxtutorial then cmsbs-conf/cse/plugins/de.acme.projectxtutorial/callback/DbSchemaUpdate.es6mjs would be a good choice:
| Codeblock | ||
|---|---|---|
| ||
/// <reference path="../../../.vscode.js"/>
const SQL = UM.config.sql;
export default class DbSchemaMigration extends PluginSchemaMigration {
schemaUpdate_0_1(scr) {
// Create column for primary attribute "new_attribute":
this.primaryAddColumn(scr, UM.config.getAttribute('new_attribute'));
// Alter primary attribute's column according to the current settings from *.attributes file:
this.primaryModifyColumn(scr, UM.config.getAttribute('altered_attribute'));
// Create column for new table attribute's column:
this.tableAddColumn(scr, UM.config.getAttribute('table_attribute->new_column'));
// Alter table attribute's column according to the current settings from *.attributes file:
this.tableModifyColumn(scr, UM.config.getAttribute('table_attribute->altered_column'));
// Issue SQL statement to create an INDEX:
this.primaryAddIndex(scr, UM.config.getAttribute('new_attribute'), true);
// Issue SQL statement to mass-update some user entries:
const update1 = new SqlQuery(`UPDATE ${SQL.qualifyTable('users')} SET p_entrytype='user' WHERE p_entrytype IS NULL`);
scr.add(update1);
// Issue SQL statement to mass-update some user entries:
const update2 = new SqlQuery(`UPDATE ${SQL.qualifyTable('users')} SET p_entrytype='customer' WHERE p_entrytype='user'`);
scr.add(update2);
}
}
// Don't forget to export the class to the respective namespace:
de.acme.projectxtutorial.DbSchemaMigration = DbSchemaMigration; |
...
There are several helper methods available to accomplish common tasks like adding or altering columns or executing custom SQL statements:
| Hinweis |
|---|
Please keep in mind that a database schema update cannot be undone automatically! Have a fresh backup at hand to be able to rollback the database if needed. |