Connection

Configuration

NAMETYPEDESCRIPTIONREQUIREDREADONLY
hostnamestringtruefalse
accountstringtruefalse
passwdstringtruefalse
dbnamestringfalsefalse
portintegertruefalse
sslbooleanfalsefalse
sshbooleanfalsefalse
ssh_userstringfalsefalse
ssh_hoststringfalsefalse
ssh_portintegerfalsefalse
ssh_private_keystringfalsefalse
change_detectionbooleanfalsefalse

Example

1{
2 "name": "mysql connection",
3 "type": "mysql",
4 "configuration": {
5 "account": "admin",
6 "change_detection": false,
7 "dbname": "mydb",
8 "hostname": "database.example.com",
9 "passwd": "password",
10 "port": 3306,
11 "ssh": false,
12 "ssh_host": "bastion.example.com",
13 "ssh_port": 22,
14 "ssh_private_key": "",
15 "ssh_user": "",
16 "ssl": false
17 }
18}

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}

Type handling

Destination types

POLYTOMIC TYPEMYSQL TYPE
array<>JSON
bigintBIGINT
booleanBOOLEAN
dateDATE
datetimeDATETIME
decimal(precision, scale)DECIMAL(precision,scale)
doubleDOUBLE
intINT
jsonJSON
jsonarrayJSON
numberDECIMAL(65,30)
object{}JSON
singleFLOAT
smallintSMALLINT
stringLONGTEXT
timeTIME

Source types

MYSQL TYPEPOLYTOMIC TYPE
BIGINTbigint
BITnumber
BLOBstring
CHARstring
DATEdate
DATETIMEdatetime
DECIMAL(precision, scale)decimal(precision, scale)
DOUBLEdouble
ENUMstring
FLOATsingle
INTint
MEDIUMINTint
MEDIUMTEXTstring
NUMERIC(precision, scale)decimal(precision, scale)
SMALLINTsmallint
TEXTstring
TIMEtime
TIMESTAMPdatetime
TINYINTsmallint
TINYTEXTstring
UNSIGNED BIGINTbigint
UNSIGNED INTint
UNSIGNED SMALLINTsmallint
UNSIGNED TINYINTsmallint
VARCHARstring
YEARint