Configuring your connectionsConnection configurations

Azure SQL

Connection

Description

Configuration

NAMETYPEDESCRIPTIONREQUIREDREADONLY
hostnamestringtruefalse
usernamestringtruefalse
passwordstringtruefalse
databasestringtruefalse
portintegertruefalse
sslbooleanfalsefalse

Example

1{
2 "name": "azuresql connection",
3 "type": "azuresql",
4 "configuration": {
5 "database": "sampledb",
6 "hostname": "example.database.windows.net",
7 "password": "secret",
8 "port": 1433,
9 "ssl": false,
10 "username": "user"
11 }
12}

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

N/A

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}