7.14 Remove Apply Process

The “remove” Apply Process command is used to remove the Process configuration files and the checkpoint details, together with historical information. If the Target Database is reachable the “remove”command will cleanup all the checkpoint information on the Target Database.

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

It is strongly recommended that you backup configuration files and last successfully processed LSN before running this command (see chapter 9.4 Backup Repstance Files).

This command cannot be applied to a group of Apply Processes at the same time, it must be used individually for each of the configured Apply Processes.

REST API:

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

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"
  }

CLI Syntax:

The input parameters are:

• process – The only possible value is apply
• id – The identifier of the Apply Process

The output parameters are:

• Status – Status of the command, possible values are:
  • Error – command has failed to run
  • Warning – process has failed to remove all the Apply Objects
  • Completed – command has completed successfully
• Message – Details of the command execution

Following example demonstrates how to remove Apply Process having id=2: