PlanetScale Vitess

Supports:

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

Connection

Configuration

NameTypeDescriptionRequired
change_detectionbooleanUse replication for bulk syncsfalse
databasestringDatabasetrue
hostnamestringHostnametrue
passwordstringPasswordtrue
portintegerPorttrue
usernamestringUsernametrue

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 "username": ""
11 }
12}

Model Sync

Source

Configuration

NameTypeDescriptionRequired
querystringfalse
tablestringTablefalse
viewstringViewfalse

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
NameTypeDescriptionRequired
created_columnstring’Created at’ timestamp columnfalse
preserve_table_on_resyncbooleanPreserve destination table when resyncingfalse
updated_columnstring’Updated at’ timestamp columnfalse
write_null_valuesbooleanCopy null values

When enabled updates will set fields to NULL when the source value is null
false
write_record_timestampsbooleanWrite row timestamp metadatafalse
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 support creating a new target for a model sync. To create a new target, set target.new_name to the desired name.

Bulk Sync

Source

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

Destination

Configuration

NameTypeDescriptionRequired
advancedobjectfalse
mirror_schemasbooleanMirror schemasfalse
schemastringOutput schemafalse

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 "mirror_schemas": false,
12 "schema": "schema"
13 }
14}

Type handling

Destination types

POLYTOMIC TYPEPLANETSCALE VITESS 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

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