Extend the Database plugin

This topic describes how the Database plugin uses the Deploy rules system to provide improved rollback support for SQL scripts.

For backward compatibility reasons, improved rollback support is not automatically available for custom CI types that were created in earlier versions of the plugin, and that are based on the sql.SqlScripts CI type. However, you can implement this support for custom types by adding rules to the XL_DEPLOY_SERVER_HOME/ext/xl-rules.xml file.

note

If you have not created custom CI types in the Database plugin, you do not need to add these rules.

Add the following rules for each custom CI type that is based on sql.SqlScripts, replacing custom.SqlScripts with the name of your custom type:

    <rules>
      <disable-rule name="custom.SqlScripts.executeCreate_CREATE" />
      <disable-rule name="custom.SqlScripts.executeDestroy_DESTROY" />
      <disable-rule name="custom.SqlScripts.executeModify_MODIFY" />

      <rule name="rules_custom.SqlScripts.CREATE">
        <conditions>
            <type>custom.SqlScripts</type>
            <operation>CREATE</operation>
        </conditions>
        <planning-script-path>rules/sql_create.py</planning-script-path>
      </rule>
      <rule name="rules_custom.SqlScripts.MODIFY">
        <conditions>
            <type>custom.SqlScripts</type>
            <operation>MODIFY</operation>
        </conditions>
        <planning-script-path>rules/sql_modify.py</planning-script-path>
      </rule>
      <rule name="rules_custom.SqlScripts.DESTROY">
        <conditions>
            <type>custom.SqlScripts</type>
            <operation>DESTROY</operation>
        </conditions>
        <planning-script-path>rules/sql_destroy.py</planning-script-path>
      </rule>
    </rules>