Skip to main content

Configure and run

Specify source and target PostgreSQL data connections and table mappings, then start Data Synchronization. Saving and starting are separate actions.

Screenshot TODO

Capture: The basic information, source connection, target, and table mapping sections of a new Data Synchronization page. Hide hosts, accounts, and secret values.

Prerequisites​

  • The source and target PostgreSQL data connections must belong to the same collection.
  • The source account needs permissions for the publication and replication slot required by change data capture.
  • The target account needs permission to insert, update, and delete rows in mapped tables.
  • Create the target schema and tables in advance.

You do not re-enter the password from a data connection. At startup, the job uses the selected data connections and the secrets referenced by those connections.

Create Data Synchronization​

  1. In the sidebar, select Data > Data Synchronization.
  2. Select Create Data Synchronization.
  3. Under Basic information, enter a name, alias, collection, description, and tags. The name cannot be changed after creation.
  4. Under Source connection, select a PostgreSQL data connection.
  5. Enter the replication slot and publication names. If needed, enable automatic slot creation.
  6. Enter both the source schema and table to synchronize. You cannot enter only one of them.
  7. If the source connection requires TLS, enter its TLS settings.
  8. Under Replication target, specify a PostgreSQL data connection, target schema, and key columns.
  9. If the target connection requires TLS, enter its TLS settings.
  10. Under Table mapping, specify a target table and any column renames for each source relation.
  11. Select Save.

When a target table name is blank, the source relation name is used. Column mappings are managed within the row for that relation.

Limitations before startup

Automatic target table creation and initial snapshots are not supported. To transfer rows that existed before the slot was created, complete a separate initial load before starting change synchronization.

Start or stop​

  1. On the Data Synchronization list, open the item's Actions menu.
  2. Select Start.
  3. Confirm that the status changes to Running.

To stop a running job, select Stop from the same menu. To review multiple executions together, open System > Monitoring > Run Status.

Edit settings​

  1. Select the item in the list, or select Actions > Edit.
  2. Change connections, filters, TLS, or mappings.
  3. Select Save.
  4. If the item is running, Stop it and then Start it again.

When you change the collection, select the source and target data connections again. Connections outside the new collection cannot be saved.

Delete Data Synchronization​

With delete access, select Actions > Delete and confirm. Stop a running item first. Deleting it does not remove rows already applied to the target PostgreSQL database or target tables created by a user.