Skip to main content

Documentation Index

Fetch the complete documentation index at: https://planetscale.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

We implemented an Stitch Singer Tap as the pipeline between your PlanetScale source and selected destination. This document will walk you through how to connect your PlanetScale database to Stitch.

​
How to connect

​
Step 1 : Setup an Import API integration in Stitch.

PlanetScale’s Stitch tap outputs records and metadata to stdout so that the http tap can import them into Stitch via Stitch Import API.
1
Sign up for a StitchData account
2
Once you’ve signed up, create an Integration by clicking on Add Integration.
3
On the marketplace screen, type in import to narrow the list down to the Import API
Add Stitch Integration
4
On the next screen, configure your integration name and destination.
Configure Stitch Integration
5
Once the integration is created, save the access token for use with the PlanetScale tap.
Save Stitch API Token

​
Step 2 : Configure the PlanetScale Stitch Tap

In this step, we will connect your PlanetScale database to the PlanetScale Singer Tap.
1
Click on the database and branch you want to connect to.
2
Click “Connect”, and select “Stitch source” from the “Connect with” dropdown.
3
Leave this tab open, as you’ll need to copy these credentials shortly.
Stitch Source config
4
Copy the contents of source.json as a file on your local file system, and save it as source.json. This will now act as the PlanetScale source config when connecting the PlanetScale Stitch Tap to your database.

​
Step 3: Run the PlanetScale Stitch Tap

1
Install the PlanetScale Singer tap by running:
brew install planetscale/tap/ps-singer-tap
2
Install the PlanetScale Http tap by running
brew install planetscale/tap/ps-http-tap
3
Save the schema for your PlanetScale database.
ps-singer-tap --config source.json  --discover > schema.json
4
The schema.json file you saved in the previous step is a JSON document that describes all tables & columns available in your PlanetScale database. By default, no tables/columns are selected. You can select a column or table by setting its selected property in the table’s metadata element in the JSON document to be true. Here’s an example of selecting the dept_no property in a table.
{
  "metadata": {
    "selected": true,
    "inclusion": "available",
    "breadcrumb": ["properties", "dept_no"]
  }
}
5
Sync your PlanetScale database to Stitch by running the following command:
ps-singer-tap --config source.json  --catalog schema.json | ps-http-tap  --api-token $(cat access_token)
6
You should see an output similar to this:
PlanetScale Tap : INFO : Syncing records for PlanetScale database : import-on-scaler
PlanetScale Tap : INFO : syncing rows from stream "departments" from shard "-"
PlanetScale Tap : INFO : [departments shard : -] peeking to see if there's any new rows
PlanetScale Tap : INFO : new rows found, syncing rows for 1m0s
PlanetScale Tap : INFO : [departments shard : -] syncing rows with cursor [shard:"-" keyspace:"import-on-scaler"]
PlanetScale Tap : INFO : Syncing with cursor position : [], using last known PK : false, stop cursor is : [MySQL56/e42292e8-e28f-11ec-9c5b-d680f5d655b3:1-705,e4e20f06-e28f-11ec-8d20-8e7ac09cb64c:1-26,eba743a8-e28f-11ec-9227-62aa711d33c6:1-20]
PlanetScale Tap : INFO : [departments shard : -] Continuing with cursor after server timeout
PlanetScale Tap : INFO : [departments shard : -] peeking to see if there's any new rows
HTTP Tap : INFO : flushing [20] messages for stream "departments"
PlanetScale Tap : INFO : [departments shard : -] no new rows found, exiting
HTTP Tap : INFO : Server response status : "OK", message : "Batch accepted"
HTTP Tap : INFO : flushing [1] messages for stream "departments"
HTTP Tap : INFO : Server response status : "OK", message : "Batch accepted"
HTTP Tap : INFO : saving state to path : state/state-1656850746251.json
7
Any state outputted by the PlanetScale Tap will be saved and you can look at the logs for the location. Here is an example of outputted state:
HTTP Tap : INFO : saving state to path : state/state-1656850746251.json
8
In this example, you should see that Stitch loaded 21 records to be replicated.
Completed Stitch import
9
To incrementally sync from this last sync position, pass the path to last saved state in step 7 as the --state argument when you run sync.

​
Need help?

Get help from the PlanetScale Support team, or join our Discord community to see how others are using PlanetScale.