Azure Synapse

Supports:

✅ Models
✅ Model sync destination
✅ Bulk sync source
✅ Bulk sync destination

Connection

Configuration

Name	Type	Description	Required
`database`	`string`	Database	`true`
`hostname`	`string`	Server	`true`
`password`	`string`	Password	`true`
`port`	`integer`	Port	`true`
`username`	`string`	Username	`true`

Example

1 {
2   "name": "Azure 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
`query`	`string`		`false`
`table`	`string`	Table	`false`
`view`	`string`	View	`false`

Example

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

Target

Azure Synapse connections may be used as the destination in a model sync.

All targets

Configuration

Name	Type	Description	Required
`created_column`	`string`	’Created at’ timestamp column	`false`
`preserve_table_on_resync`	`boolean`	Preserve destination table when resyncing	`false`
`updated_column`	`string`	’Updated at’ timestamp column	`false`
`write_record_timestamps`	`boolean`	Write row timestamp metadata	`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 }

Target creation

Azure Synapse connections support creating a new target for a model sync. To create a new target, set target.new_name to the desired name.

Bulk Sync

Source

Azure Synapse connections may be used as a bulk sync source. No additional configuration options are required.

Destination

Configuration

Name	Type	Description	Required
`advanced`	`object`		`false`
`mirror_schemas`	`boolean`	Mirror schemas	`false`
`schema`	`string`	Output schema	`false`

Example

1 {
2   ...
3   "destination_configuration": {
4     "advanced": {
5         "empty_strings_null": false,
6         "hard_deletes": false,
7         "initial_execution": "",
8         "table_prefix": "",
9         "truncate_existing": false
10     },
11     "mirror_schemas": false,
12     "schema": "schema"
13   }
14 }

1	{
2	"name": "Azure 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	"empty_strings_null": false,
6	"hard_deletes": false,
7	"initial_execution": "",
8	"table_prefix": "",
9	"truncate_existing": false
10	},
11	"mirror_schemas": false,
12	"schema": "schema"
13	}
14	}