Azure SQL | Polytomic Docs

Supports:

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

Connection

Configuration

Name	Type	Description	Required
`blobStore`	`boolean`	Use Azure blob storage for faster bulk loading (destination only) ↓	`optional`
`database`	`string`	Database	`required`
`hostname`	`string`	Server	`required`
`password`	`string`	Password	`required`
`port`	`integer`	Port	`required`
`ssh`	`boolean`	Connect over SSH tunnel ↓	`optional`
`ssl`	`boolean`	Use SSL	`optional`
`trust_server_certificate`	`boolean`	Trust server certificate	`optional`
`username`	`string`	Username	`required`

`blobStore`

When blobStore is true:

Name	Type	Description	Required
`access_key`	`string`	Storage account access key (destination only)	`required`
`account_name`	`string`	Storage account name (destination only)	`required`
`container_name`	`string`	Storage container name (destination only)	`required`

{
  "name": "Azure SQL connection",
  "type": "azuresql",
  "configuration": {
    "access_key": "abcdefghijklmnopqrstuvwxyz0123456789/+ABCDEabcdefghijklmnopqrstuvwxyz0123456789/+ABCDE==",
    "account_name": "account",
    "blobStore": true,
    "container_name": "container",
    "database": "sampledb",
    "hostname": "example.database.windows.net",
    "password": "secret",
    "port": 1433,
    "ssh": false,
    "ssl": true,
    "trust_server_certificate": false,
    "username": "user"
  }
}

`ssh`

When ssh is true:

Name	Type	Description	Required
`ssh_host`	`string`	SSH host	`required`
`ssh_port`	`integer`	SSH port	`required`
`ssh_private_key`	`string`	Private key	`required`
`ssh_user`	`string`	SSH user	`required`

{
  "name": "Azure SQL connection",
  "type": "azuresql",
  "configuration": {
    "blobStore": false,
    "database": "sampledb",
    "hostname": "example.database.windows.net",
    "password": "secret",
    "port": 1433,
    "ssh": true,
    "ssh_host": "bastion.example.com",
    "ssh_port": 22,
    "ssh_private_key": "",
    "ssh_user": "root",
    "ssl": true,
    "trust_server_certificate": false,
    "username": "user"
  }
}

Example

{
  "name": "Azure SQL connection",
  "type": "azuresql",
  "configuration": {
    "blobStore": false,
    "database": "sampledb",
    "hostname": "example.database.windows.net",
    "password": "secret",
    "port": 1433,
    "ssh": false,
    "ssl": true,
    "trust_server_certificate": false,
    "username": "user"
  }
}

Model Sync

Source

Configuration

Name	Type	Description	Required
`query`	`string`		`optional`
`table`	`string`	Table	`optional`
`view`	`string`	View	`optional`

Example

{
  ...
  "configuration": {
    "query": "SELECT * from users",
    "table": "users",
    "view": "active_users"
  }
}

Target

Azure SQL 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	`optional`
`preserve_table_on_resync`	`boolean`	Preserve destination table when resyncing	`optional`
`updated_column`	`string`	’Updated at’ timestamp column	`optional`
`write_null_values`	`boolean`	Copy null values When enabled updates will set fields to NULL when the source value is null	`optional`
`write_record_timestamps`	`boolean`	Write row timestamp metadata	`optional`

Example

{
  ...
  "target": {
      "configuration": {
        "created_column": "",
        "preserve_table_on_resync": false,
        "updated_column": "",
        "write_null_values": false,
        "write_record_timestamps": false
    }
  }
}

Target creation

Azure SQL connections may be used to create a new target for a model sync. The following parameters are required to create a new target:

NAME	DESCRIPTION	ENUM
name	Table name	false

Bulk Sync

Source

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

Destination

Configuration

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

Advanced configuration (`advanced`)

Name	Type	Description	Required
`empty_strings_null`	`boolean`	Write empty strings as null	`optional`
`hard_deletes`	`boolean`	Propagate hard deletes instead of soft deletes	`optional`
`initial_execution`	`string`	On first sync	`optional`
`table_prefix`	`string`	Prefix table names with	`optional`
`truncate_existing`	`boolean`	Truncate destination table when source table does not have a primary key	`optional`

Example

{
  ...
  "destination_configuration": {
    "advanced": {
        "empty_strings_null": true,
        "hard_deletes": false,
        "initial_execution": "rebuild",
        "table_prefix": "",
        "truncate_existing": false
    },
    "mirror_schemas": false,
    "schema": "schema"
  }
}

Type handling

Destination types

POLYTOMIC TYPE	AZURE SQL TYPE
`array<>`	`NVARCHAR(MAX)`
`bigint`	`BIGINT`
`boolean`	`BIT`
`date`	`DATE`
`datetime`	`DATETIMEOFFSET`
`decimal(precision, scale)`	`DECIMAL(precision,scale)`
`double`	`FLOAT`
`int`	`INT`
`json`	`NVARCHAR(MAX)`
`jsonarray`	`NVARCHAR(MAX)`
`number`	`NUMERIC(38,10)`
`object{}`	`NVARCHAR(MAX)`
`single`	`REAL`
`smallint`	`SMALLINT`
`string`	`NVARCHAR(4000)`
`time`	`TIME`

Source types

AZURE SQL TYPE	POLYTOMIC TYPE
`BIGINT`	`bigint`
`CHAR`	`string`
`DATE`	`date`
`DATETIME`	`datetime`
`DATETIME2`	`datetime`
`DATETIMEOFFSET`	`datetime`
`DECIMAL`	`number`
`DECIMAL(precision, scale)`	`decimal(precision, scale)`
`FLOAT`	`double`
`INT`	`int`
`MONEY`	`decimal(precision, scale)`
`NCHAR`	`string`
`NTEXT`	`string`
`NUMBER(precision, scale)`	`decimal(precision, scale)`
`NUMERIC`	`number`
`NUMERIC(precision, scale)`	`decimal(precision, scale)`
`NVARCHAR`	`string`
`REAL`	`single`
`SMALLDATETIME`	`datetime`
`SMALLINT`	`smallint`
`SMALLMONEY`	`decimal(precision, scale)`
`TEXT`	`string`
`TIME`	`time`
`TINYINT`	`smallint`
`UNIQUEIDENTIFIER`	`string`
`VARCHAR`	`string`
`XML`	`string`

Connection

Configuration

blobStore

ssh

Example

Model Sync

Source

Configuration

Example

Target

All targets

Configuration

Example

Target creation

Bulk Sync

Source

Destination

Configuration

Advanced configuration (advanced)

Example

Type handling

Destination types

Source types

`blobStore`

`ssh`

Advanced configuration (`advanced`)