PlanetScale Vitess | Polytomic Docs

Supports:

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

Connection

Configuration

Name	Type	Description	Required
`change_detection`	`boolean`	Use replication for bulk syncs	`false`
`database`	`string`	Database	`true`
`hostname`	`string`	Hostname	`true`
`password`	`string`	Password	`true`
`port`	`integer`	Port	`true`
`ssh`	`boolean`	Connect over SSH tunnel ↓	`false`
`username`	`string`	Username	`true`

`ssh`

When `ssh` is `true`

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

Example

1 {
2   "name": "PlanetScale Vitess connection",
3   "type": "planetscale_vitess",
4   "configuration": {
5     "change_detection": false,
6     "database": "mydb",
7     "hostname": "aws.connect.psdb.cloud",
8     "password": "",
9     "port": 3306,
10     "ssh": false,
11     "username": ""
12   }
13 }

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

PlanetScale Vitess 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_null_values`	`boolean`	Copy null values When enabled updates will set fields to NULL when the source value is null	`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_null_values": false,
9         "write_record_timestamps": false
10     }
11   }
12 }

Target creation

PlanetScale Vitess 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

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

Destination

Configuration

Name	Type	Description	Required
`advanced`	`object`		`false`
`schema`	`string`	Keyspace	`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     "schema": ""
12   }
13 }

Type handling

Destination types

POLYTOMIC TYPE	PLANETSCALE VITESS 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

PLANETSCALE VITESS TYPE	POLYTOMIC TYPE
`BIGINT`	`bigint`
`BIT`	`number`
`BLOB`	`binary`
`BLOB`	`string`
`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`

Connection

Configuration

ssh

When ssh is true

Example

Model Sync

Source

Configuration

Example

Target

All targets

Configuration

Example

Target creation

Bulk Sync

Source

Destination

Configuration

Example

Type handling

Destination types

Source types

`ssh`

When `ssh` is `true`