Skip to main content

PlanetScale

Overview​

PlanetScale is a MySQL-compatible database platform. Use the PlanetScale connector to extract data from your PlanetScale databases and load it into your destination.

Setup​

Prerequisites​

  • A PlanetScale account
  • Access to the database you want to sync
  • A PlanetScale password (recommended) or other MySQL-compatible credentials supported by your PlanetScale configuration
  • Network access that allows your sync runtime to reach your PlanetScale database host

Create PlanetScale credentials​

PlanetScale supports connecting over MySQL. The most common approach is to create a database password in PlanetScale and use it as your connector password.

In PlanetScale:

  1. Open your database.
  2. Create a new password (or use an existing one) for the branch you want to sync.
  3. Copy the generated username and password.
  4. Note the host and port shown for the branch.

Authentication​

The PlanetScale source authenticates using standard MySQL connection parameters:

  • Host
  • Port
  • Database
  • Username
  • Password
  • (Optional) SSL/TLS settings, depending on your environment and security requirements

Configuration​

Provide the following configuration values when setting up the connector:

FieldTypeRequiredDescription
Hoststring✓The PlanetScale database host.
Portinteger✓The database port (commonly 3306).
Databasestring✓The database name to sync.
Usernamestring✓The username for the PlanetScale database password.
Passwordstring✓The password for the PlanetScale database password.
SSL modestringSSL/TLS behavior for the connection (if applicable).

Streams​

This connector syncs tables from your PlanetScale database. The available streams correspond to the tables and views accessible to the configured user.

  • Each table is represented as a stream.
  • Column types are mapped from MySQL types to the platform’s supported types.

Notes and limitations​

  • Ensure the configured user has sufficient permissions to read the schemas and tables you want to sync.
  • If you rotate your PlanetScale password, update the connector configuration accordingly.