Remove Process

The command is used to remove Capture or Apply process and unregister the process in a database. The command deletes all configuration and log files. For the Capture Process the command deletes Trail Files and checkpoint information. For SQL Server Capture Process the “remove”command will disable CDC on the tables, which are configured to be captured by this Process only.

The command can only be executed if the specified Process is not running. 

It is strongly recommended that you backup all Trail and configuration files and checkpoint information before running this command (see chapter 9.4 Backup Repstance Files).

Note – After removing the Capture Process it is not possible to reverse this action. Any Apply Processes using data from this Capture will cease to work.

CLI Syntax:

The input parameters are:

• process – The process type that can be either capture or apply
• id – The Process Identifier

REST API:

• Endpoint: https://repstance_url/configure/process
• Method: POST
• Header:
  • Content-Type: application/json
  • X-Token: token
• Body:
  {
    "command": "remove",
    "parameters": [
      ["process","capture|apply"],  
      ["id","processID"]
    ]
  }

Server response:

• HTTP Status – status of the command, possible codes are:
  • 200 – if no error occurs
  • 422 – if error occurs
• Body:
  {
    "Status":"{Completed|Error|Warning}",
    "Message":"The command execution details",
  }

The output parameters are:

• Status – Status of the command, possible values are:
  • Error – the command has failed to run
  • Warning – the process has failed to remove all the Capture objects
  • Completed – the command has completed successfully
• Message – The details of command execution

Example

The following example demonstrates how to remove Capture 2: