MySQL | Polytomic Docs

Supports:

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

Connection

Configuration

Name	Type	Description	Required
`hostname`	`string`	Hostname	`true`
`account`	`string`	Username	`true`
`passwd`	`string`	Password	`true`
`dbname`	`string`	Database (optional)	`false`
`port`	`integer`	Port	`true`
`ssl`	`boolean`	Use SSL	`false`
`ssh`	`boolean`	Connect over SSH tunnel	`false`
`ssh_user`	`string`	SSH user	`false`
`ssh_host`	`string`	SSH host	`false`
`ssh_port`	`integer`	SSH port	`false`
`ssh_private_key`	`string`	Private key	`false`
`change_detection`	`boolean`	Use replication for bulk syncs	`false`

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

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

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

All targets

Configuration

Name	Type	Description	Required
`preserve_table_on_resync`	`boolean`	Preserve destination table when resyncing	`false`
`write_record_timestamps`	`boolean`	Write row timestamp metadata	`false`
`created_column`	`string`	’Created at’ timestamp column	`false`
`updated_column`	`string`	’Updated at’ timestamp column	`false`
`write_null_values`	`boolean`	Copy null values When enabled updates will set fields to NULL when the source value is null	`false`

Example

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

Type handling

Destination types

POLYTOMIC TYPE	MYSQL TYPE
`array<>`	`JSON`
`bigint`	`BIGINT`
`boolean`	`BOOLEAN`
`date`	`DATE`
`datetime`	`DATETIME`
`decimal(precision, scale)`	`DECIMAL(precision,scale)`
`double`	`DOUBLE`
`int`	`INT`
`json`	`JSON`
`jsonarray`	`JSON`
`number`	`DECIMAL(65,30)`
`object{}`	`JSON`
`single`	`FLOAT`
`smallint`	`SMALLINT`
`string`	`LONGTEXT`
`time`	`TIME`

Source types

MYSQL TYPE	POLYTOMIC TYPE
`BIGINT`	`bigint`
`BIT`	`number`
`BLOB`	`string`
`BLOB`	`binary`
`CHAR`	`string`
`DATE`	`date`
`DATETIME`	`datetime`
`DECIMAL(precision, scale)`	`decimal(precision, scale)`
`DOUBLE`	`double`
`ENUM`	`string`
`FLOAT`	`single`
`INT`	`int`
`MEDIUMBLOB`	`binary`
`MEDIUMINT`	`int`
`MEDIUMTEXT`	`string`
`NUMERIC(precision, scale)`	`decimal(precision, scale)`
`SMALLINT`	`smallint`
`TEXT`	`string`
`TIME`	`time`
`TIMESTAMP`	`datetime`
`TINYBLOB`	`binary`
`TINYINT`	`smallint`
`TINYTEXT`	`string`
`UNSIGNED BIGINT`	`bigint`
`UNSIGNED INT`	`int`
`UNSIGNED SMALLINT`	`smallint`
`UNSIGNED TINYINT`	`smallint`
`VARBINARY`	`binary`
`VARCHAR`	`string`
`YEAR`	`int`