Configuring your connectionsConnection configurations

PostgreSQL

Connection

Description

Configuration

NAMETYPEDESCRIPTIONREQUIREDREADONLY
hostnamestringtruefalse
usernamestringtruefalse
passwordstringtruefalse
databasestringtruefalse
portintegertruefalse
sslbooleanfalsefalse
sshbooleanfalsefalse
ssh_userstringfalsefalse
ssh_hoststringfalsefalse
ssh_portintegerfalsefalse
ssh_private_keystringfalsefalse
client_certsbooleanfalsefalse
client_certificatestringfalsefalse
client_keystringfalsefalse
ca_certstringfalsefalse
change_detectionbooleanfalsefalse
publicationstringfalsefalse

Example

1{
2 "name": "postgresql connection",
3 "type": "postgresql",
4 "configuration": {
5 "ca_cert": "",
6 "change_detection": false,
7 "client_certificate": "",
8 "client_certs": false,
9 "client_key": "",
10 "database": "sampledb",
11 "hostname": "database.example.com",
12 "password": "password",
13 "port": 5432,
14 "publication": "polytomic",
15 "ssh": false,
16 "ssh_host": "",
17 "ssh_port": 22,
18 "ssh_private_key": "",
19 "ssh_user": "",
20 "ssl": false,
21 "username": "postgres"
22 }
23}

Model Sync

Source

Configuration

NAMETYPEDESCRIPTIONREQUIREDREADONLY
querystringfalsefalse
tablestringTablefalsefalse
viewstringViewfalsefalse

Example

1{
2 ...
3 "configuration": {
4 "query": "SELECT * from users",
5 "table": "users",
6 "view": "active_users"
7 }
8}

Target

Configuration

NAMETYPEDESCRIPTIONREQUIREDREADONLY
preserve_table_on_resyncbooleanPreserve destination table when resyncingfalsefalse

Example

1{
2 ...
3 "target": {
4 "configuration": {
5 "preserve_table_on_resync": false
6 }
7 }
8}

Bulk Sync

Source

Configuration

NAMETYPEDESCRIPTIONREQUIREDREADONLY
replication_slotstringLeave blank to allow Polytomic to manage a replication slot for this sync.falsefalse

Example

1{
2 ...
3 "source_configuration": {
4 "replication_slot": "polytomic"
5 }
6}

Destination

Configuration

NAMETYPEDESCRIPTIONREQUIREDREADONLY
advancedobjectfalsefalse
mirror_schemasbooleanIndicates whether schemas should be mirroredfalsefalse
schemastringOutput schema to write tofalsefalse

Example

1{
2 ...
3 "destination_configuration": {
4 "advanced": {
5 "table_prefix": "",
6 "truncate_existing": false
7 },
8 "mirror_schemas": false,
9 "schema": "public"
10 }
11}