HomeGuidesAPI ReferenceChangelog
Log In
Guides

Migrations

RegScale Migrations CLI

The Migration CLI command exists to perform bulk data processing on RegScale data to conduct transformations and updates in batch mode.

Init.yaml Configuration

There are two pieces of information needed to configure the Migration CLI functionality:

  • domain - URL to your RegScale instance (i.e. https://mycompany.regscale.com )
  • maxThreads - The total number of threads the application is allowed to use for bulk processing. The default value is 1000. (NOTE: Changing this number can have a negative or positive impact on performance.)

How to Use

  • Determine the appropriate subcommand to execute:
    • issue_linker - grabs all issues, then for each one, it looks up the lineage of the record and builds deep links for improved query performance
    • assessment_linker - grabs all assessments, then for each one, it looks up the lineage of the record and builds deep links for improved query performance
    • risk_linker - grabs all risks, then for each one, it looks up the lineage of the record and builds deep links for improved query performance

For example, to run the migrations for issues, use the command below:

regscale migrations issue_linker

NOTE: All of the linker utilities exist to migrate legacy data and establish deep links to parent records in their lineage. This linking adds improved query performance. As of February 2022, all new records get the linkings automatically so this linking is only to convert legacy data into the new highly performant linking system.