{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Normally rollback works by \"rewinding\" the database to a specified point. All changesets deployed after that point are rolled back. ","type":"text"}]},{"type":"paragraph","content":[{"text":"Precise rollback targets specific changesets to modify. To use it, you need to do the following:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Use the precise option on a rollback command. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Use search options to specify the changesets to modify","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Use a preview to review the effects before running the rollback.","type":"text"}]},{"type":"paragraph","content":[{"text":"When the rollback is run, the specified changeset entries are removed from the DATABASECHANGELOG table. ","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Syntax for Precise Rollback","type":"text"}]},{"type":"codeBlock","content":[{"text":"hammer rollback precise [--preview] [--report=] [--=, ...]","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"The search options determine ","type":"text"},{"text":"which changesets to modify","type":"text","marks":[{"type":"em"}]},{"text":". They select a list of changesets for the modify options to work on. ","type":"text"}]},{"type":"paragraph","content":[{"text":"Searches are not case-sensitive. ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Multiple values in one statement are OR'ed together. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Multiple search option statements are ANDed together.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Search option statements take one or a comma-separated list of values. They are provided for changeset attributes as follows: ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"searchIds","type":"text","marks":[{"type":"code"}]},{"text":" - ","type":"text"},{"text":"id","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"searchLabels","type":"text","marks":[{"type":"code"}]},{"text":" - ","type":"text"},{"text":"label","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"searchContexts","type":"text","marks":[{"type":"code"}]},{"text":" - ","type":"text"},{"text":"context","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"searchIgnore","type":"text","marks":[{"type":"code"}]},{"text":" - ","type":"text"},{"text":"ignore","type":"text","marks":[{"type":"code"}]},{"text":" - ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":" | ","type":"text"},{"text":"false - ","type":"text","marks":[{"type":"code"}]},{"text":"Searches for false also return changesets where the ignore attribute is not set. ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":" | ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"searchOrigFilePaths","type":"text","marks":[{"type":"code"}]},{"text":" - ","type":"text"},{"text":"origFilePath","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"searchOrigFileNames","type":"text","marks":[{"type":"code"}]},{"text":" - ","type":"text"},{"text":"origFileName","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"searchVersion","type":"text","marks":[{"type":"code"}]},{"text":" - ","type":"text"},{"text":"version","type":"text","marks":[{"type":"code"}]},{"text":", an integer. ","type":"text"}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Conditions for Precise Rollback","type":"text"}]},{"type":"paragraph","content":[{"text":"Changesets must meet the following criteria when evaluated (previewed) for a precise rollback:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Changesets must be deployed on the specified databases","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Transient scripts:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A rollback script is provided with the original SQL script","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Non-transient scripts: either condition must be true. ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A rollback script is provided with the original SQL script","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The current version is equal or greater than 1 and the previous version of the changeset exists in the changelog. ","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Additional Considerations","type":"text"}]},{"type":"paragraph","content":[{"text":"Normal rollbacks rewind the changelog to a defined point, undoing all changesets deployed after that point. ","type":"text"}]},{"type":"paragraph","content":[{"text":"Precise rollback removes individual changesets from the changelog. Take care not to remove changesets that later deployments built on. ","type":"text"}]},{"type":"paragraph","content":[{"text":"For example:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Deploy a create table","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Deploy a view on that table","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"If you now attempt to roll back only the changeset that created the table, then the view becomes invalid. ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Rolling Back Non-Transient or Rerunnable Changesets","type":"text"}]},{"type":"paragraph","content":[{"text":"Non-transient changesets are modified in place and versioned.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Typically these are changes in stored logic (functions, procedures, triggers, views; Oracle packages and packagebodies). ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Starting in version 4.37, they may also be identified by ","type":"text"},{"text":"rerunnable=true","type":"text","marks":[{"type":"code"}]},{"text":". The ","type":"text"},{"text":"rerunnable","type":"text","marks":[{"type":"code"}]},{"text":" property is new. ","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Requirements for Changesets to be Eligible for Rollback","type":"text"}]},{"type":"paragraph","content":[{"text":"You may roll back the ","type":"text"},{"text":"current","type":"text","marks":[{"type":"em"}]},{"text":" version (most recently deployed) to the ","type":"text"},{"text":"previous","type":"text","marks":[{"type":"em"}]},{"text":" version ","type":"text"},{"text":"if its version number is equal or greater than 1","type":"text","marks":[{"type":"em"}]},{"text":". ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"You may perform multiple rollback operations as long as the version number is equal or greater than 1.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"You can roll back only one version at a time. ","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"If the search conditions for a precise rollback return more than one version of change, the most recent one is used. ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Rollback Operation","type":"text"}]},{"type":"paragraph","content":[{"text":"The rollback operation uses the rollback script for the current version if one is provided. If a rollback script is not provided, the operation attempts to locate the changeset for the previous version in the changelog and use it:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Check for a provided rollback script. If one exists, do the following:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Run the rollback script","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If the rollback script is successful, delete the changeset for the current version from the DATABASECHANGELOG. ","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If no rollback script exists, do the following:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Check the changelog for the previous version of the changeset. Exit if it does not exist. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Run the previous version of the changeset.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Remove the current version of the changeset from the DATABASECHANGELOG.","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Rolling Back Transient Scripts","type":"text"}]},{"type":"paragraph","content":[{"text":"Precise rollback is available for transient scripts that do NOT use the convert_sql process. ","type":"text"}]},{"type":"paragraph","content":[{"text":"It is not available for the following:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Workflow files for DDL/convert. This can include -cleanup, -ignore, -unignore and more.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Scripts packaged as convert (flexible folder names)","type":"text"}]},{"type":"paragraph","content":[{"text":"Note: DDL/convert files are supported in Liquibase Enterprise 8.3 and later if a rollback file is provided.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"The original script may have created multiple changesets.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A rollback script must exist. ","type":"text"},{"text":"Exception","type":"text","marks":[{"type":"em"}]},{"text":": the change is one for which Datical provides an auto-rollback. See Auto-rollback Support by Database Object Change Type. ","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"During processing:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Assemble the changesets to roll back (based on search criteria).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Execute the rollback script on those changesets","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Remove changeset entries from the changelog (DATABASECHANGELOG table)","type":"text"}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Previewing a Precise Rollback","type":"text"}]},{"type":"paragraph","content":[{"text":"When you use the ","type":"text"},{"text":"--preview","type":"text","marks":[{"type":"code"}]},{"text":" argument, a preview report is generated but no changes are made. ","type":"text"}]},{"type":"paragraph","content":[{"text":"The preview report includes the following information:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"List of changesets affected - the list is generated by the search criteria. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Ineligible changesets - any changesets that cannot be rolled back","type":"text"}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Logging","type":"text"}]},{"type":"paragraph","content":[{"text":"The log for the rollback is stored in the Reports directory with other reports for the dbdef (step). See Available Log Files and Reports. ","type":"text"}]},{"type":"codeBlock","content":[{"text":"MyProject/Reports/YYYY/NN-MM//rollback__","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"type":"hardBreak"},{"text":"Reports","type":"text"}]},{"type":"paragraph","content":[{"text":"The Rollback Report generates a log that describes what was rolled back when the ","type":"text"},{"text":"rollback","type":"text","marks":[{"type":"code"}]},{"text":" command is used. The report can be produced in any of the following modes: LastDeploy, Precise, and Custom. When it is set, the report will be written to the directory specified or to the Reports directory by default if none is specified. ","type":"text"},{"type":"hardBreak"},{"type":"hardBreak"},{"text":"The report parameter can be specified while running the precise rollback command.","type":"text"},{"type":"hardBreak"},{"text":"Example:","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"hammer rollback precise [--preview] [--report=] [--=, ...]","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Learn more about the Rollback Report here:","type":"text"},{"type":"inlineCard","attrs":{"url":"https://datical-cs.atlassian.net/wiki/spaces/DDOC/pages/896570540"}},{"text":" ","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"0f79f23a-4a15-4045-ab46-3b87d21f2aa1"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"You may need to check the rollback.log for additional details related to errors.","type":"text"}]}]}]}]}],"version":1}

Browser not supported