...
| Note |
|---|
If modifying deployed yang module(s) refer to Modifying CPS Client-Tables (Yang Modules) instead |
Once the table is created, columns can be added and edited using a similar syntax to above.
...
Then, run a mvn clean install on your machine, and it will generate a csv file in the following directory 'cps-ri/src/main/resources/changelog/db/changes/data/dmi/generated-csv'.
Once this is done, then add the change-set for yang resource you have created to load the data into the DB.
...
| language | yml |
|---|---|
| title | Yang resource Change set example |
| collapse | true |
Loading a new dmi-registry Yang Resource and dmi-registry Yang Resource Schema Set
In order to load a new Yang Resource, we want to first remove the previous Yang Resource. Create a new Changelog file preferably following this naming convention: X-insert-dmi-registry-YYYY-MM-DD-schema-set.yaml where X is +1 to the previous changelog number.
Within this changelog we are going to add 4 changesets. The first changeset we need to remove the previous yang resource relation from the yang_resource_schema_set table to remove the mapping between this yang resource and the related schema set. We also need to implement the rollback so that this can be added back in a rollback scenario.
Please see example and change the YYYY-MM-DD of the relevant file to that of the Yang Resource which is currently in the yang_reource/schema_set_yang_resources table and the X in id to that of the number of the changelog:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
databaseChangeLog: - changeSet: author: cps label: dmi-registry-schema-preload-delete-revision-YYYY-MM-DD id: 9.7X loadUpdateDatasql: delete from schema_set_yang_resources encoding: UTF-8 file: 'changelog/db/changes/data/dmi/generated_yang_resource_dmi-registry@2021-12-13.csv'where schema_set_id = (select id from schema_set where name = 'ncmp-dmi-registry-model') onlyUpdate: 'false' primaryKey: 'id'and yang_resource_id = (select id from yang_resource where name = 'dmi-registry@YYYY-MM-DD.yang') rollback: quotchar: '"' loadUpdateData: separatorencoding: '|'UTF-8 tableNamefile: 'yang_resourcechangelog/db/changes/data/dmi/schema_set_yang_resources@YYYY-MM-DD.csv' columns quotchar: '"' - columnprimaryKey: 'schema_set_id,yang_resource_id' headerseparator: '|' name nametableName: name'schema_set_yang_resources' type: STRING - column: usePreparedStatements: true |
Now that we have deleted the yang resource from the schema_set_yang_resources table, we can remove the yang resource from the yang_resource table using the second changeset. We must also add a rollback function to undo this change.
Please see example and again update the YYYY-MM-DD of relevant file to that of the yang resource in the table and update the X in changeset id to that of the changelog + .1:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
- changeSet:
author: cps
label: dmi-registry-schema-delete-revision-YYYY-MM-DD
id: X.1
sql: delete from yang_resource where name = 'dmi-registry@YYYY-MM-DD.yang'
rollback:
loadUpdateData:
encoding: UTF-8
file: 'changelog/db/changes/data/dmi/dmi-registry@YYYY-MM-DD.csv'
onlyUpdate: 'false'
primaryKey: 'id'
quotchar: '"'
separator: '|'
tableName: 'yang_resource'
columns:
- column:
header: name
name: name
type: STRING
- column:
header: content
name: content
type: STRING
- column:
header: checksum
name: checksum
type: STRING
- column:
header: module_name
name: module_name
type: STRING
- column:
header: revision
name: revision
type: STRING |
At this point it is recommended to apply the pending changes and check that the relevant resource has been removed from the yang_resource and schema_set_yang_resources tables as well as rollback to ensure it is reloaded afterwards.
If this is successful we can implement the changesets to add a new yang resource to the yang_resource table with relevant rollback function to remove the resource.
Please see example where YYYY-MM-DD is for the new Yang Resource and the X in id should be that of the changelog id:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
- changeSet: author: cps label: dmi-registry-schema-load-revision-YYYY-MM-DD id: X.2 loadUpdateData: encoding: UTF-8 file: 'changelog/db/changes/data/dmi/generated-csv/generated_yang_resource_dmi-registry@YYYY-MM-DD.csv' onlyUpdate: 'false' primaryKey: 'id' quotchar: '"' separator: '|' tableName: 'yang_resource' columns: - column: header: name content name: contentname type: STRING - column: header: content name: content header: checksum type: STRING name: checksum - column: type: STRING header: checksum rollback: - sql: name: checksum sql: delete from yang_resource where name = 'dmi-registry@2021-12-13.yang' |
Yang Resource Schema Set
Data will also need to be inserted into the yang_resource_schema_set table to create a mapping between the new yang resource and the necessary schema set.
Create a csv to define the data in the format of 'schema_set_yang_resources@<revision>'
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
schema_set_id|yang_resource_id (select id from schema_set where name='ncmp-dmi-registry-model')|(select id type: STRING - column: header: module_name name: module_name type: STRING - column: header: revision name: revision type: STRING rollback: - sql: sql: delete from yang_resource where name = 'dmi-registry@2021registry@YYYY-12MM-13DD.yang') |
...
Now that the Yang Resource is in the yang_resource table, we will add the relation of the Yang Resource and the Schema Set using the schema_set_yang_resources table with the necessary rollback to undo.
Please see example and change YYYY-MM-DD to that of the loaded yang_resource and X to the id of the changelog:
| Code Block | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| - changeSet:
author: cps
label: dmi-registry-schema-preload
id: 9.8
loadUpdateData:
encoding: UTF-8
file: 'changelog/db/changes/data/dmi/schema_set_yang_resources@2021-12-13.csv'
| ||||||||
- changeSet: quotcharauthor: '"'cps primaryKeylabel: 'schema_set_id,yang_resource_id' dmi-registry-schema-load-revision-YYYY-MM-DD separatorid: '|'X.3 sql: INSERT tableName:INTO 'schema_set_yang_resources' (schema_set_id, yang_resource_id) usePreparedStatements: trueVALUES ((select id from schema_set where name rollback: - sql: = 'ncmp-dmi-registry-model'), (select id from yang_resource where name = 'dmi-registry@YYYY-MM-DD.yang')); sqlrollback: > sql: delete from schema_set_yang_resources where schema_set_id = (select id from schema_set where name = 'ncmp-dmi-registry-model') and yang_resource_id = (select id from yang_resource where name = 'dmi-registry@2021registry@YYYY-12MM-23DD.yang') |
The Yang Resource should now be present in the yang_resource table and the relation should be visible in the schema_set_yang_resources table. Rollbacking these changesets should revert the tables to the state they were in before any changes were made.
Rollback
As seen above, the rollback tag is included within the change-set in the case that and updates made need to be reverted.
...