When installing Redgate Change Control, the command line executable will be automatically added to the PATH environment variable so it can be used directly from your console, for instance by running rcc --help. The docker image can be obtained from here. 

Verbs

Each of the verbs below takes an additional set of common arguments:

init

Creates a new Redgate Change Control project configuration file based on the supplied parameters.

Arguments

Output

A json object with the following structure:

{
  path: string,         -- Absolute path to the project .conf file.
  projectId: string     -- A GUID representing the unique project ID (also saved in the .conf file).
}  

generate-baseline

Creates a baseline migration script based on a given target database schema and saves it to the project. If working with a development database, this command will also run flyway baseline to set the schema version. If using a shadow scripts folder, this command will reset the shadow to match the expected baseline state.

Arguments

Output

A json object with the following structure:

{
  path: string,                 -- Absolute path to the baseline .sql migration file saved in the project.
}  

compare

Compares databases or scripts folders (generated by Source Control for Oracle) to determine a set of changes that can be scripted out.

Arguments

Output

A json object with the following structure:

{
  databaseComparison: [
    {
      id: string,             -- The comparison id of the difference
      differenceType: string, -- The type of the comparison difference (e.g. "only in source", "only in target", "equal", "different")
      objectType: string,     -- The type of the object (e.g. "Function" or "StoredProcedure")
      objectInSource: {
        name: string,         -- The name of the database object
        schema: string,       -- The database schema of the database object
        definition: string    -- The sql definition of the database object
      },                      -- The object as it exists in the source database
      objectInTarget: {
        name: string,         -- The name of the database object
        schema: string,       -- The database schema of the database object
        definition: string    -- The sql definition of the database object
      },                      -- The object as it exists in the target database
    }
  ],
  reconnectionDetails: {
    dev: string,              -- The absolute path to the source database snapshot file
    shadow: string,           -- The absolute path to the target database snapshot file
  }
}  

generate

Generates a set of migration scripts based on the changes selected from the comparison output.

Arguments

Output

A json object with the following structure:

{
  migrationScript: string,                      -- The sql definition of the migration script.
  programmableObjects: [
    {
      type: string,                             -- The type of programmable object (e.g. "Function" or "StoredProcedure").
      script: string,                           -- The sql definition of the object.
      name: string                              -- The name of the programmable object.
    }
  ],
  automaticallyIncludedDependencies: [string]   -- list of the names of the objects included automatically due to required dependencies
}  

save

Saves a set of migration scripts to the project. If working with a development database, this command will also update the redgate_schema_history table to mark the saved scripts as applied.

Arguments

{
  script: string,        -- The sql definition of the script.
  version: string,       -- The version number of the migration script.
  description: string    -- The name of the migration script (excluding `.sql`).
}

[
  {
    type: string,        -- The type of programmable object (e.g. "Function" or "StoredProcedure").
    script: string,      -- The sql definition of the object.
    name: string         -- The name of the repeatable migration script (excluding `.sql`).
  }
]

Output

A json object with the following structure:

{
  savedMigrationScript: string,          -- The absolute path to the saved migration script.
  createdProgrammableObjects: [string]   -- List of absolute paths to all newly-created repeatable migration scripts.
  modifiedProgrammableObjects: [string]  -- List of absolute paths to all modified repeatable migration scripts.
  removedProgrammableObjects: [string]   -- List of absolute paths to all deleted repeatable migration scripts.
}  

apply

Deploys migration scripts that were written outside Redgate Change Control and manually added to the project directly to the development database. This command is only available when working with a development database.

Arguments

Output

There is no output from this verb.

update

Updates the Redgate Change Control project configuration file with the specified values.

Arguments

Output

There is no output from this verb.

repair

Repairs the schema history table in the development database. This can be used to assist with repairing the history table after a failed migration, or an external change to the migrations in your project.

Arguments

Output

There is no output from this verb.

status

Retrieves the migration and validation status of the project.

Arguments

Output

A json object with the following structure:

{
  total: number			-- Count of the total number of migrations in the project
  pending: number		-- Count of the number of pending migrations in the project
  failed: number		-- Count of the number of failed migrations in the project
  successful: number	-- Count of the number of successful migrations in the project
  future: number		-- Count of the number of future migrations in the project
  missing: number		-- Count of the number of missing migrations in the project
  repeatable: number	-- Count of the number of repeatable migrations in the project
  undo: number			-- Count of the number of undo migrations in the project
  versioned: number		-- Count of the number of versioned migrations in the project
  validationError: bool -- Whether an error occurred during validation
}  

version

Prints the version information for RCC and Flyway. No additional arguments are required.

Output

A json object with the following structure:

{
  rccVersion: string	-- The version of RCC
  flywayVersion: string	-- The version of Flyway used by RCC
}  

reset

This verb is used to reset the state of the shadow scripts folder back to the project. In order to do so, RCC cleans the target database before applying all project migrations to this database. It then uses this as a reference to repopulate the shadow scripts folder. 

Arguments

Output

There is no output from this verb.