Azure Synapse — Polytomic Docs

Connection

Configuration

NAME	TYPE	REQUIRED	READONLY
hostname	string	true	false
username	string	true	false
password	string	true	false
database	string	true	false
port	integer	true	false

Example

1 {
2   "name": "synapse connection",
3   "type": "synapse",
4   "configuration": {
5     "database": "yourdatabase",
6     "hostname": "yourserver.sql.azuresynapse.net",
7     "password": "secret",
8     "port": 1433,
9     "username": "user"
10   }
11 }

Model Sync

Source

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED	READONLY
query	string		false	false
table	string	Table	false	false
view	string	View	false	false

Example

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

Target

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED	READONLY
preserve_table_on_resync	boolean	Preserve destination table when resyncing	false	false
write_record_timestamps	boolean	Write row timestamp metadata	false	false
created_column	string	’Created at’ timestamp column	false	false
updated_column	string	’Updated at’ timestamp column	false	false

Example

1 {
2   ...
3   "target": {
4       "configuration": {
5         "created_column": "",
6         "preserve_table_on_resync": false,
7         "updated_column": "",
8         "write_record_timestamps": false
9     }
10   }
11 }

Bulk Sync

Destination

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED	READONLY
advanced	object		false	false
schema	string	Output schema to write to	false	false
mirror_schemas	boolean	Indicates whether schemas should be mirrored	false	false

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 }

1	{
2	"name": "synapse connection",
3	"type": "synapse",
4	"configuration": {
5	"database": "yourdatabase",
6	"hostname": "yourserver.sql.azuresynapse.net",
7	"password": "secret",
8	"port": 1433,
9	"username": "user"
10	}
11	}

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

1	{
2	...
3	"target": {
4	"configuration": {
5	"created_column": "",
6	"preserve_table_on_resync": false,
7	"updated_column": "",
8	"write_record_timestamps": false
9	}
10	}
11	}

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