Microsoft SQL Server

Connection

Configuration

NAMETYPEDESCRIPTIONREQUIREDREADONLY
hostnamestringtruefalse
usernamestringtruefalse
passwordstringtruefalse
databasestringtruefalse
portintegertruefalse
sslbooleanfalsefalse

Example

1{
2 "name": "mssql connection",
3 "type": "mssql",
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
write_record_timestampsbooleanWrite row timestamp metadatafalsefalse
created_columnstring’Created at’ timestamp columnfalsefalse
updated_columnstring’Updated at’ timestamp columnfalsefalse

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

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

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}

Type handling

Destination types

POLYTOMIC TYPEMICROSOFT SQL SERVER TYPE
array<>NVARCHAR(MAX)
bigintBIGINT
booleanBIT
dateDATE
datetimeDATETIME
decimal(precision, scale)DECIMAL(precision,scale)
doubleFLOAT
intINT
jsonNVARCHAR(MAX)
jsonarrayNVARCHAR(MAX)
numberNUMERIC(38,10)
object{}NVARCHAR(MAX)
singleREAL
smallintSMALLINT
stringNVARCHAR(4000)
timeTIME

Source types

MICROSOFT SQL SERVER TYPEPOLYTOMIC TYPE
BIGINTbigint
CHARstring
DATEdate
DATETIMEdatetime
DATETIME2datetime
DATETIMEOFFSETdatetime
DECIMALnumber
DECIMAL(precision, scale)decimal(precision, scale)
FLOATdouble
INTint
MONEYdecimal(precision, scale)
NCHARstring
NTEXTstring
NUMBER(precision, scale)decimal(precision, scale)
NUMERICnumber
NUMERIC(precision, scale)decimal(precision, scale)
NVARCHARstring
REALsingle
SMALLDATETIMEdatetime
SMALLINTsmallint
SMALLMONEYdecimal(precision, scale)
TEXTstring
TIMEtime
TINYINTsmallint
UNIQUEIDENTIFIERstring
VARCHARstring
XMLstring