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	`optional`
`database`	`string`	Database	`required`
`hostname`	`string`	Hostname	`required`
`password`	`string`	Password	`required`
`port`	`integer`	Port	`required`
`ssh`	`boolean`	Connect over SSH tunnel ↓	`optional`
`username`	`string`	Username	`required`

`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": "PlanetScale Vitess connection",
  "type": "planetscale_vitess",
  "configuration": {
    "change_detection": false,
    "database": "mydb",
    "hostname": "aws.connect.psdb.cloud",
    "password": "",
    "port": 3306,
    "ssh": true,
    "ssh_host": "bastion.example.com",
    "ssh_port": 22,
    "ssh_private_key": "",
    "ssh_user": "root",
    "username": ""
  }
}

Example

{
  "name": "PlanetScale Vitess connection",
  "type": "planetscale_vitess",
  "configuration": {
    "change_detection": false,
    "database": "mydb",
    "hostname": "aws.connect.psdb.cloud",
    "password": "",
    "port": 3306,
    "ssh": false,
    "username": ""
  }
}

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

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	`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

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`		`optional`
`schema`	`string`	Keyspace	`optional`

Example

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

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`