Cleaning up the R4J revision history data

Background

Due to very high consumption of database storage by the R4J table AO_242870_REVISION_HISTORY, development effort has been made to optimize the storage and performance of revisions in R4J.
The significant change in data structure is introduced at R4J version 4.5. Starting with this version, the R4J revision history table no longer serves as the main table for revision transactions. The evaluation of revision data is now done with the already existing history table of Jira.

What to expect

Executing the cleanup task will:

  • Remove redundant data from the tables AO_242870_REVISION_HISTORY and AO_242870_ISSUE_REVISION.

  • Exclude issues with entries in baselines, to retain baseline information.

  • Execute the cleanup as a background job which cannot be aborted once executed.

Other important things

  • Once executed, the cleanup process may take several hours to finish depending on the amount of data you have.

    • Our baseline tests with 25 million revision data finished processing between 6 to 8 hours. The process runs in the background and you can still proceed to work in R4J. However, we suggest proper planning and scheduling execution outside business hours.

  • R4J 4.5 has been verified on Jira 7.13.x to Jira 8.18.x on the following database types and versions:

    • SQL Server 2014 and 2016

    • postgresql-11.11-2

    • Oracle 19c

    • MySQL 5.7.33

  • R4J 4.5 revision data is not compatible with older versions of R4J as stated in our release notes.

  • Check out the Summary of functions affected by revisions restructure in R4J 4.5

We highly recommend to backup your data, make necessary preparations before performing the process, and first run and verify the result on a test/staging system. If you encounter issues with R4J 4.5, please reach out to us through our support portal.

Cleaning up the revision data

To perform the cleanup process:

  1. Go to App/Add-on Administration > (R4J section) Cleanup Revisions.

  2. On the page, click on the Cleanup button.

  3. A confirmation dialog will pop-up to confirm if you wish to proceed with the cleanup process. Click on Cleanup to continue or Cancel.

  4. If you proceed with the cleanup, the process will start running. It may take a while depending on the amount of data you have.

  5. Once the cleanup is finished, statistics will be displayed and the cleanup logs can be downloaded.
    If a direct download is required, revision cleanup logs can be found at <JIRA_HOME>/log/r4j-revision-cleanup-<timestamp>.log