Prepare Target Database

The “prepare database=target” command is used to configure a database as a Target. The command must be executed before running the Apply Process to create the necessary database objects:

CLI Syntax

The input parameters are:

• database – The only appropriate value is target
• dbtype – RDBMS type. The valid values are oracle, mssql, redshift, postgresql and snowflake
• generatesql – Specify if the objects are to be created in the databases (0 value), or if the only SQL script creating the objects are to be generated (1 value)
• [Target database connection parameters] - set of the parameters to specify database connection setting

The details on the “Target database connection parameters” are provided here:

• Oracle as Target
• SQL Server as Target
• PostgreSQL as Target
• MySQL as Target
• Snowflake as Target
• Redshift As Target 

REST API:

• Endpoint: https://repstance_url/configure/database
• Method: POST
• Header:
  • Content-Type: application/json
  • X-Token: token
• Body:
  {
    "command":"prepare",
    "parameters":[
       ["database","target"],
       ["dbtype","{oracle|mssql|redshift|postgresql|mysql|snowflake}"],
       {Target database connection parameters}
    ]
  }

Server response:

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

Web UI

In the Web User Interface, the Target database is prepared when you create or edit an Apply process:

Click on the database icon and provide the database connectivity parameters.  

Click "Test Connection" and then click “Prepare for Replication” button to prepare the database. Alternatively you can generate script that prepares database and execute it in the Target database: