7.5 Alter Capture Process

The “alter”Capture Process command is used to change the Capture Process parameters. The id parameter can not be changed. The name parameter can be changed only in the case that it has not been provided before – eg. it must be "Unique".

The Capture Process has to exist otherwise the command will fail.

Note –You can alter the Capture Process even if it is running, however these changes will only be implemented after the Capture Process has been stopped and rerun.

7.5.1 Alter Capture Process for MS SQL Server Database

REST API:

• Endpoint: https://repstance_url/configure/process
• Method: POST
• Header:
• Content-Type: application/json
• X-Token: token
• Body:
  {
    "command": "alter",
    "parameters": [
      ["process","capture"],
      ["id","captureID"],
      ["dbtype","mssql"],
      ["name","captureName"],
      ["server","databaseHost"],
      ["port","databasePort"],
      ["user","username"],
      ["password","password"],
      ["dbname","databaseName"],
      ["autostart","{0|1}"],
      ["debuglevel","{0-15}"],
      ["ddlinclude","objectsMask"],
      ["ddlexclude","objectsMask"],
      ["dmlinclude","objectsMask"],
      ["dmlexclude","objectsMask"],
      ["loadinclude","objectsMask"],
      ["loadexclude","objectsMask"],
      ["map=mapID","mappingClause"],
      ["skipapply","skipapplyMask"]
    ]
  }

Server response:

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

CLI Syntax:

The input parameters are:

• process – Process type, the only appropriate value is capture
• id– Capture Process identifier
• dbtype – Type of RDBMS, the possible value is mssql
• name – Name of the Capture Process
• server – Host name or IP address of the database server
• port – Database port number
• dbname – Database name
• user–Database User name
• password – Database User password
• autostart – Determines if the Capture Process must be run automatically. Possible values are:
  • 0 – do not run the Capture Process automatically (default value)
  • 1 – to run the Capture Process automatically
• debuglevel – Level of debugging, possible values are: 0-15
• ddlinclude – Mask of the DDL objects to be captured (see chapter 7.4.4 Capture Objects Specification for the details)
• ddlexclude – Mask of the DDL objects to be skipped by the Capture Process (see chapter 7.4.4 Capture Objects Specification for the details)
• dmlinclude – Mask of the DML objects to be captured (see chapter 7.4.4 Capture Objects Specification for the details)
• dmlexclude – Mask of the DML objects to be skipped by the Capture Process (see chapter 7.4.4 Capture Objects Specification for the details)
• loadinclude – Mask of the objects to be included into the Initial Load (see chapter 7.4.5 Initial Load for the details)
• loadexclude – Mask of the objects to be skipped during Initial Load (see chapter 7.4.5 Initial Load for the details)
• map – The set of the parameters to determine objects’ transformation (see chapter 7.4.6 Objects Mapping and Possible Transforms for the details)
• skipapply – Used to define the behavior of a Capture Process when extracting data, which was produced by Apply Processes as part of the “loop-back” control function, in that, this Capture Process will extract or ignore the data. The Apply Processes to be skipped are specified by ids separated by comma. In order to specify all Processes the “all” value to be used. In order to avoid skipping any Apply Processes the “none” value to be used. The default value is “all”.

7.5.2 Alter Capture Process for Oracle Database

REST API:

• Endpoint: https://repstance_url/configure/process
• Method: POST
• Header:
• Content-Type: application/json
• X-Token: token
• Body:
  {
    "command": "alter",
    "parameters": [
      ["process","capture"],
      ["id","captureID"],
      ["dbtype","oracle"],
      ["name","captureName"],
      ["connectiontype","tns|ezconnect"],
      ["tnsname","tns_alias"],
      ["server","host_name"],
      ["port","port_number"],
      ["servicename","service_or_SID"],
      ["user","username"],
      ["password","password"],
      ["dbname","databaseName"],
      ["autostart","{0|1}"],
      ["debuglevel","{0-15}"],
      ["ddlinclude","objectsMask"],
      ["ddlexclude","objectsMask"],
      ["dmlinclude","objectsMask"],
      ["dmlexclude","objectsMask"],
      ["loadinclude","objectsMask"],
      ["loadexclude","objectsMask"],
      ["map=mapID","mappingClause"],
      ["skipapply","skipapplyMask"]
    ]
  }

Server response:

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

CLI Syntax:

The input parameters are:

• process – The only possible value is capture
• id – Capture Process id
• dbtype – Type of RDBMS, the possible value is oracle
• connectiontype – Specifies the Oracle connection method, possible values are:
  • tns– Local Naming Method to be used
  • ezconnect– EZCONNECT to be used
• tnsname – Name of the TNS alias, valid only if connectiontype=tns
• server – Host name or IP address of the database server, valid only if connectiontype=ezconnect
• port – Database port number, valid only if connectiontype=ezconnect
• servicename – Database service name or SID, valid only if connectiontype=ezconnect
• dbname – Name of either container or pluggable database. Valid only if database=source and for any Oracle versions 12c-19c but excluding RDS instances
• name – Name of the Capture Process
• user – Database User name
• password – Database User password
• autostart – Determines if the Capture Process must be run automatically, possible values are:
  • 0 – do not run the Capture Process automatically (default value)
  • 1 – to run the Capture Process automatically
• debuglevel – The level of debugging, possible values are 0-15
• ddlinclude – Mask of the DDL objects to be captured (see 7.4.4 Capture Objects Specification chapter for the details)
• ddlexclude – Mask of the DDL objects to be skipped by the Capture Process (see 7.4.4 Capture Objects Specification chapter for the details)
• dmlinclude – Mask of the DML objects to be captured (see 7.4.4 Capture Objects Specification chapter for the details)
• dmlexclude – Mask of the DML objects to be skipped by the Capture Process (see 7.4.4 Capture Objects Specification chapter for the details)
• loadinclude – Mask of the objects to be included into the Initial Load (see chapter 7.4.5 Initial Load for the details)
• loadexclude – Mask of the objects to be skipped during Initial Load (see chapter 7.4.5 Initial Load for the details)
• map – The set of the parameters to determine objects’ transformation (see chapter 7.4.6 Objects Mapping and Possible Transforms for the details)
• skipapply – Used to define the behavior of a Capture Process when extracting data, which was produced by Apply Processes as part of the “loop-back” control function, in that, this Capture Process will extract or ignore the data. The Apply Processes to be skipped are specified by ids separated by comma. In order to specify all Processes the “all” value to be used. In order to avoid skipping any Apply Processes the “none” value to be used. The default value is “all”.