PlanetScale Setup Guide Beta

Follow these instructions to replicate your PlanetScale database to your destination using Fivetran.

NOTE: This connector is partner-built. For any questions related to PlanetScale connector and its documentation, contact PlanetScale's support team. For details on SLA, see PlanetScale's Support Overview documentation.

Prerequisites

To connect your PlanetScale database to Fivetran, you need a PlanetScale database.

Setup instructions

Choose connection method

Connect directly

Fivetran connects directly to your PlanetScale database.

Connect using private networking

IMPORTANT: You must have a Business Critical plan to use private networking.

We support the following providers:

AWS PrivateLink - used for VPCs and AWS-hosted or on-premises services. See our AWS Private Link setup guide for details.
GCP Private Service Connect - used for VPCs and Google-hosted or on-premises services. See our GCP Private Service Connect setup guide for details.

Configure PlanetScale connection string

In PlanetScale, navigate to the database you want to connect to Fivetran and click the Connect button.
Create a new password for your main branch with read-only permissions.
In the Connect with dropdown, select General and make a note of the username and password. You will need them to configure Fivetran.

Finish Fivetran configuration

In the connector setup form, enter a Destination schema prefix. This prefix applies to each replicated schema and cannot be changed once your connector is created.
In the Database host name, enter your PlanetScale instance host name (e.g., 1.2.3.4) or domain name (e.g., your.server.com).
Enter the name of the PlanetScale database you wish to connect to.
Enter the Database username.
Enter the Database password.
(Optional) Provide a Comma-separated list of shards to sync. If your PlanetScale database is not sharded, ignore this field. If the database is sharded, by default, the PlanetScale connector downloads rows from all shards in the database. To pick which shards are synced by the connector, you can optionally provide a comma-separated list of shards in the connector configuration.
Set Use Replica? to true if your PlanetScale branch has a replica. VStream will connect to the primary tablet for your database, which also serves queries to your database. To lessen the load on the primary tablet, set this to true to make Vstream read from a replica of your database.
IMPORTANT: Note that only PlanetScale production branches have replica tablets. If connecting to a development branch, set useReplica to false.
Set Treat tinyint(1) as boolean to true to have the connector transform tinyint(1) type columns to boolean values.
(Optional) Whitelist Fivetran IPs if your connection string was created with IP restrictions. Ensure that the Fivetran IP ranges are added to the password.
Click Save & Test. Fivetran tests and validates our connection to your PlanetScale database. Upon successful completion of the setup tests, you can sync your data using Fivetran.

Connector Overview

Schema Information