7.10.3 Alter Apply Process for PostgreSQL and Aurora PostgreSQL Databases

REST API:

• Endpoint: https://repstance_url/configure/process
• Method: POST
• Header:
  • Content-Type: application/json
  • X-Token: token
• Body:
  {
    "command": "alter",
    "parameters": [
      ["process","apply"],
      ["id","applyID"],
      ["dbtype","postgresql"],
      ["capturename","captureName"],
      ["server","databaseHost"],
      ["port","databasePort"],
      ["user","username"],
      ["password","password"],
      ["dbname","databaseName"],
      ["autostart","{0|1}"],
      ["debuglevel","{0-15}"],
      ["ddlcreate","objectMask:options"],
      ["ddldrop","objectMask:options"],
      ["ddlprocessing","native|dictionary"],
      ["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 apply
• id – The Apply Process identifier
• dbtype – Type of RDBMS, the only possible value is postgresql
• capturename – Name of the Capture Process which is providing the data to be used
• server – Host name or IP address of the database server
• port – Database port
• dbname – Database name
• user – Database User name
• password – Database User password
• autostart – Determines if the Apply Process must be run automatically. Possible values are:
  • 0 – do not run the Apply Process automatically (default value)
  • 1 – to run the Apply Process automatically
• debuglevel – Level of debugging, possible values are 0-15 (default value is 0)
• ddlcreate – Used to define the Apply Process behavior when creating a table, if a table with the same name is found. The table is specified in schema _name.table_name format. In order to specify the list of the tables, each table must be separated by comma. The % symbol may be used in order to match any number of characters. It has the following options:
  • skip – do not run DDL create command if the table already exists
  • recreate – drops the existing table and recreates it
• ddldrop – Used to define the Apply Process behavior when dropping a table, if a table with the same name is not found. The table is specified in schema _name.table_name format. In order to specify the list of the tables, each table must be separated by comma. The % symbol may be used in order to match any number of characters. It has the following options:
  • skip – do not run DDL drop command if the table doesn’t exist
• ddlprocessing – Determines if DDL must be processed based on the user statement or generated based on the dictionary changes. The possible values are:
  • native – to process DDL based on the user statement (default value)
  • dictionary – to generate DDL based on the dictionary changes
• skipapply – Used to define the behavior of the Apply Process when inserting data, which was originally produced by Apply Processes in the Source Database as part of the “loop-back” control function, in that, this Apply Process will insert, 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 “none”.

Note – "dictionary" value is commonly used in the case of Heterogeneous replication. For Homogeneous type of replication it is recommended to use "native" method of DDL processing.